Dapatkan PBX PBX Sebagai contoh

Dapatkan PBX PBX Sebagai contoh #

Titik akhir ini digunakan untuk memeriksa apakah target PBX sudah dikaitkan dengan penyewa pelanggan di suatu tempat di sistem.

GET /v1.0/pbxs?instanceId={PBX_INSTANCE_ID}

Tergantung pada jenis Pbx, nilai berikut perlu diteruskan sebagai {PBX_Instance_ID}:

  • ~.pbx.kazoo.name.~ => ~.pbx.kazoo.name.~ ID Akun
  • Teams => Microsoft ID Penyewa
  • 3CX => 3CX Kunci Lisensi

Contoh #

Permintaan ini akan mendapatkan PbxConnectionProfiles tertentu dalam penyewa Pelanggan.

Minta # 

GET <https://api.na.myreports.cloud/api/v1.0/pbxs?instanceId={PBX_INSTANCE_ID}> HTTP/1.1
Otorisasi: Pembawa {TOKEN}

Tanggapan (Ada) # 

HTTP/1.1 200 OK
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
{
	"data": {
        "ada": benar,
        "instanceId": "{PBX_INSTANCE_ID}",
        "id": "{PBX_ID}",
        "tenantId": "{CUSTOMER_TENANT_ID}"
    },
    "status": "sukses",
    "stempel waktu": "2025-02-20T14:57:51.2818600Z"
}

Tanggapan (Tidak Ada) # 

HTTP/1.1 200 OK
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
{
	"data": {
        "ada": salah,
        "instanceId": "{PBX_INSTANCE_ID}"
    },
    "status": "sukses",
    "stempel waktu": "2025-02-20T14:57:51.2818600Z"
}

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 #

Ketika tidak ada Pelanggan yang memiliki id penyewa yang cocok atau Pengguna dengan ID pengguna 

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"
}