Perbarui Perangkat Pengguna

Perbarui Perangkat Pengguna #

Titik akhir ini memungkinkan perangkat yang ada untuk ditetapkan (atau dihapus) sebagai perangkat softphone untuk pengguna untuk ~.UcClient.~ Desktop, Seluler & WebRTC.

Tetapkan Perangkat

PUT /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign

Batalkan Penetapan Perangkat

PUT /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign

Tubuh dari permintaan harus berisi satu JSON untuk menunjukkan jenis klien yang ditetapkan ke perangkat:

{
	"clientType": "desktop"
}

Nilai clientType yang valid:

  • desktop
  • telepon selular
  • WebRTC
  • CRM

{DEVICE_ID} yang disediakan harus berupa id perangkat pada platform komunikasi, misalnya ~.pbx.kazoo.name.~.

Document note
Perangkat yang ditetapkan sebagai softphone harus sudah ditetapkan kepada pengguna di platform komunikasi.
Color Wand tip
Jika id perangkat yang diberikan sudah ditetapkan ke Jenis Klien lain, menetapkannya lagi akan berdampak memindahkannya dari satu klien ke klien lainnya.

Komentar #

Saat menetapkan perangkat softphone ke Pengguna, pastikan pengguna terlebih dahulu diberi peran yang benar. Kedua rile berikut adalah prasyarat untuk menetapkan perangkat softphone:

  • customer_user_uc
  • customer_user_uc_softphone

Contoh Penugasan #

Minta # 

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
{
	"clientType": "desktop"
}

Jawaban # 

HTTP/1.1 201 Dibuat
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Lokasi: <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign>
{
	"status": "sukses",
	"stempel waktu": "2019-11-29T16:03:23.9251680Z"
}

Contoh Batalkan Penetapan #

Minta # 

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup

Jawaban # 

HTTP/1.1 201 Dibuat
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Lokasi: <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign>
{
	"status": "sukses",
	"stempel waktu": "2019-11-29T16:03:23.9251680Z"
}

Kesalahan #

Sah #

Ketika token tidak disediakan, tidak valid atau kedaluwarsa 

HTTP/1.1 401 Tidak sah

Permintaan Buruk #

Ketika id penyewa yang diberikan tidak dalam format yang benar 

HTTP/1.1 400 Permintaan Buruk
Tanggal: Thu, 06 Feb 2020 12:45:27 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 149
{
	"kesalahan": 400,
	"message": "Nilai '<tenant id>' tidak valid.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}

Tidak Ditemukan #

Jika tidak ada Pelanggan yang memiliki id penyewa yang cocok 

HTTP/1.1 404 Tidak Ditemukan
Tanggal: Thu, 06 Feb 2020 12:46:58 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 95
{
	"kesalahan": 404,
	"message": "Tidak Ditemukan",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:46:58.7669535Z"
}

Ketika perangkat yang direferensikan belum ditetapkan ke pengguna di platform komunikasi. 

HTTP/1.1 404 Tidak Ditemukan
Tanggal: Thu, 06 Feb 2020 12:46:58 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 95
{
	"kesalahan": 404,
	"message": "Perangkat Tidak Ditemukan",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:46:58.7669535Z"
}

Pembayaran Diperlukan #

Jika permintaan ini mungkin dikenakan biaya tambahan, lihat Biaya. 

HTTP/1.1 402 Pembayaran Diperlukan
Tanggal: Thu, 06 Feb 2020 13:01:00 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 274
{
	"data": {
	"clientType": "desktop"
	},
	"kesalahan": 402,
	"message": "dikenakan biaya tambahan",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T13:01:01.1302340Z"
}