Autentikasi di tengah sesi melalui API

Halaman ini menjelaskan cara menggunakan endpoint API panggilan dan chat untuk autentikasi pertengahan sesi di saluran SDK Anda.

Pengguna dapat memulai sesi dukungan, seperti chat dukungan, tanpa melakukan autentikasi. Jika autentikasi pengguna akhir diperlukan, Anda dapat memulai alur autentikasi. Setelah autentikasi berhasil, Anda dapat memperbarui ID end_user untuk menautkan sesi ke pengguna akhir yang terverifikasi.

URI dan autentikasi

URI dasar untuk endpoint baru ini berbeda-beda, bergantung pada comm_type.

Untuk call comm_type:

POST https://<subdomain>.<domain>//apps/api/v1/calls/:call_id/end_user

Untuk chat comm_type:

POST https://<subdomain>.<domain>//apps/api/v1/chats/:chat_id/end_user

Operasi API

Parameter

Isi permintaan API harus memiliki kolom berikut:

ID	Nama kolom	Jenis	Wajib?	Deskripsi	Contoh nilai
0	identifier	String	Ya	ID eksternal unik yang diberikan.
1	name	String	Tidak	Nama atau ID umum yang terkait dengan interaksi. Membantu pencarian pelanggan.	John Doe
2	email	String	Tidak	Alamat email umum yang terkait dengan interaksi. Membantu pencarian pelanggan.	[e-mail]
3	phone	String	Tidak	Nomor telepon umum yang terkait dengan interaksi. Membantu pencarian pelanggan.	123-456-7890

Contoh API

Contoh respons API

Contoh respons keberhasilan:

202 Accepted

{
 "message": "accepted"
}

Contoh respons kegagalan

Parameter Tidak Ada

400 {"message": "param is missing or the value is empty: comm_type"}
400 {"message": "param is missing or the value is empty: identifier"}

Mereferensikan jenis comm selain panggilan atau chat

404 {"message": "Not Found"}

Sesi tidak aktif

400 {"message": "Call is already ended"}
400 {"message": "Chat is already ended"}

Permintaan CRM tidak didukung

400 {"message": "Unsupported CRM request"}

Permintaan duplikat

400 {"message": "Duplicate request: Please wait for the interval to expire"}

Contoh permintaan API

Jenis Comm Panggilan

POST https://<subdomain>.<domain>/apps/api/v1/calls/:call_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_token>

{
    "identifier": "unique_external_id",
    "name": "John Doe",
    "email": "[e-mail]",
    "phone": "123-456-7890"
}

Jenis Comm Chat

POST https://<subdomain>.<domain>/apps/api/v1/chats/:chat_id/end_user
Content-Type: application/json
Authorization: Bearer <your_access_token>

{
    "identifier": "unique_external_id",
    "name": "Jane Smith",
    "email": "[e-mail]",
    "phone": "098-765-4321"
}

Dokumentasi Apps API

Untuk endpoint Apps API tambahan, lihat Publikasi Apps API.