Buat PBX #

Membuat PbxConnectionProfile baru yang ditetapkan ke penyewa Pelanggan.

POST /v1.0/pelanggan/{CUSTOMER_TENANT_ID}/pbxs

Contoh #

Permintaan ini akan membuat ~.pbx.kazoo.name.~ PbxConnectionProfile dengan detail berikut:

Pelanggan: Dalam penyewa Pelanggan dengan id {CUSTOMER_TENANT_ID}
Nama: "Pelanggan ~.pbx.kazoo.name.~ Pbx"
Istirahat Tuan Rumah: "https://rest.example.com"
Host Websocket: "wss://ws.example.com"
ID Akun: "12345"
API Kunci: "ABCDEF"

Minta #

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
{
    "name": "Pelanggan ~.pbx.kazoo.name.~ Pbx",
 	"hostRest": "<https://rest.example.com">,
    "hostWebsocket": "wss://ws.example.com",
    "accountId": "12345",
    "apiKey": "ABCDEF",
    "\_type": "KazooPbxConnectionProfile"
}

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}/pbxs/{PBX_ID}>
{
	"data": {
 		"hostRest": "<https://rest.example.com">,
        "hostWebsocket": "wss://ws.example.com",
        "accountId": "12345",
        "apiKey": "ABCDEF",
        "\_type": "KazooPbxConnectionProfile",
        "id": "{PBX_ID}",
        "name":" Pelanggan ~.pbx.kazoo.name.~ Pbx",
        "tenantId": "{CUSTOMER_TENANT_ID}",
        "countryCode": "AS",
        "enabled": false
	},
	"status": "sukses",
	"stempel waktu": "2019-11-29T16:03:23.9251680Z"
}

Contoh #

Permintaan ini akan membuat 3CX PbxConnectionProfile dengan detail berikut:

Minta #

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
{
    "\_type": "ThreeCxConnectionProfile",
    "nama": "3CX Koneksi",
    "licenseKey": "licenseKey-licenseKey-licenseKey",
    "nama pengguna": "nama pengguna-nama pengguna-nama pengguna",
    "kata sandi": "kata sandi kata sandi",
    "enableRecordingArchive": "true",
    "recordingArchiveFrequency": "00:20:00"
}

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}/pbxs/{PBX_ID}>
{
	"data": {
 		 "\_type": "ThreeCxConnectionProfile",
        "nama": "3CX Koneksi",
        "licenseKey": "licenseKey-licenseKey-licenseKey",
        "nama pengguna": "nama pengguna-nama pengguna-nama pengguna",
        "kata sandi": "kata sandi kata sandi",
        "enableRecordingArchive": "true",
        "recordingArchiveFrequency": "00:20:00"
	},
	"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"
}