Buat Pelanggan

Buat Pelanggan #

Membuat penyewa Pelanggan baru

POST /v1.0/pelanggan

Contoh #

Permintaan ini akan membuat Pelanggan baru dengan detail berikut:

  • Nama: "Pelanggan baru"
  • Deskripsi: "Ini pelanggan baru saya"
  • Referensi: "ABC00001"
  • Diaktifkan: false
  • Zona Waktu : "Amerika/Los_Angeles",
  • Kode Negara: "AS"
  • Profil Koneksi Pbx
    • Crossbar Rest Api: "https://hostrest"
    • Blackhole Api Websocket: "wss//:hostwebsocket"
    • ~.pbx.kazoo.name.~ AccountId: "accountid"
    • ~.pbx.kazoo.name.~ Kunci API: "apikey"
    • monitorSubAccounts: Salah
  • sendNewUserEmail: Salah
  • sendConnectWelcomeEmail: Salah
  • TrialDuration: "0"

Minta #

POST <https://api.na.myreports.cloud/api/v1.0/customers> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
{
	"name": "Pelanggan baru",
	"description": "Ini pelanggan baru saya",
	"referensi" : "ABC00001",
	"enabled": false,
	"timezone": "America/Los_Angeles",
	"countryCode": "AS",
	"pbxConnectionProfile": {
		"\_type": "KazooPbxConnectionProfile",
		"hostRest": "http\://hostrest",
		"hostWebsocket": "wss//:hostwebsokcet",
		"accountId": "accountid",
		"apiKey": "apikey",
		"monitorSubAccounts": false
	},
	"sendNewUserEmail": false,
	"sendConnectWelcomeEmail": false,
	"trialduration" : "0"
}

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/{NEW_CUSTOMER_TENANT_ID}>
{
	"data": {
		"id": "{NEW_CUSTOMER_TENANT_ID}",
		"name": "Pelanggan baru",
		"description": "Ini pelanggan baru saya",
		"enabled": false,
		"parentTenantId": "{PARENT_ACCOUNT_TENANT_ID}"
	},
	"status": "sukses",
	"stempel waktu": "2019-01-01T10:00:00.6829447Z"
}

Kesalahan #

Sah #

Ketika token tidak disediakan, tidak valid atau kedaluwarsa

HTTP/1.1 401 Tidak sah

Permintaan Buruk (1) #

Saat meminta uji coba dan akun reseller Anda tidak memiliki izin.

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": "Pelanggan uji coba tidak diaktifkan untuk akun Anda.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}

Permintaan Buruk (2) #

Saat meminta uji coba di luar durasi uji coba maksimum yang dikonfigurasi.

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": "Uji coba pelanggan melebihi durasi maksimum yang diizinkan untuk akun Anda.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}