Endpoint pengguna akhir

Endpoint API pengguna akhir memberikan akses ke objek pengguna akhir. Objek pengguna akhir dibuat untuk setiap pengguna akhir Contact Center AI Platform (CCAI Platform).

Berikut adalah endpoint API panggilan:

Memperbarui pengguna akhir

Endpoint ini memungkinkan Anda memperbarui detail pengguna akhir, termasuk:

  • alamat email

  • nama

  • nomor telepon

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}

Endpoint:

Method: POST
Type: RAW
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

Header:

Kunci Nilai Deskripsi
Content-Type application/json
Terima application/json

Isi:

{
    "identifier": "abc123",
    "email": "joe@mydomain.com",
    "name": "Joe Smith",
    "phone": "+16171231234"
}

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

ID dan ID pengguna akhir

Contoh ini menunjukkan cara memperbarui pengguna akhir dengan memberikan ID.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Isi:

{
    "identifier": "string",
    "email": "string",
    "name": "string",
    "phone": "string"
}
Respons
{
    "id": "integer",
    "identifier": "string"
}

Kode Status: 200

Mendapatkan pengguna akhir

Endpoint ini memberikan kemampuan untuk mengambil pengguna akhir menggunakan id atau identifier.

Endpoint:

Method: GET
Type:
URL: https://{subdomain}.{domain}/apps/api/v1/end_users

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Kueri:

Kunci Nilai Deskripsi
id integer ID Internal untuk Pengguna Akhir
ID string ID eksternal untuk Pengguna Akhir

Contoh permintaan dan respons

Bagian berikut memberikan contoh permintaan ke endpoint.

Mendapatkan menurut ID

Contoh ini menunjukkan cara mengambil pengguna akhir dengan memberikan ID.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Kueri:

Kunci Nilai Deskripsi
id integer ID Internal untuk Pengguna Akhir
Respons
{
    "id": "integer",
    "identifier": "string"
}

Kode Status: 200

Dapatkan menurut ID

Contoh ini menunjukkan cara mengambil pengguna akhir dengan memberikan ID.

Permintaan

Header:

Kunci Nilai Deskripsi
Content-Type application/json

Kueri:

Kunci Nilai Deskripsi
ID string ID eksternal untuk Pengguna Akhir
Respons
{
    "id": "integer",
    "identifier": "string"
}

Kode Status: 200