Créer PBX #

Crée un nouveau PbxConnectionProfile affecté à un locataire client.

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

Exemple #

Cette demande créera un nouveau ~.pbx.kazoo.name.~ PbxConnectionProfile avec les détails suivants :

Client : Au sein du client client avec l'identifiant {CUSTOMER_TENANT_ID}
Nom : « Clients ~.pbx.kazoo.name.~ Pbx »
Repos de l'hôte : "https://rest.example.com"
Websocket hôte : « wss://ws.example.com »
Numéro de compte : « 12345 »
API Clé : « ABCDEF »

Demande #

POST <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Content-Type : application/json
Frais d'acceptation : Vrai
Authorization : Bearer {TOKEN}
Connexion : keep-alive
{
    « name » : « Clients ~.pbx.kazoo.name.~ Pbx »,
 	« hostRest » : « <https://rest.example.com">,
    « hostWebsocket » : « wss://ws.example.com »,
    « accountId » : « 12345 »,
    « apiKey » : « ABCDEF »,
    « \_type » : « KazooPbxConnectionProfile »
}

Réponse #

HTTP/1.1 201 Créé
Type de contenu : application/json; Charset=UTF-8
Contenu - Longueur : xx
Emplacement : <https://api.uk.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 » : « Clients ~.pbx.kazoo.name.~ Pbx »,
        « tenantId » : « {CUSTOMER_TENANT_ID} »,
        « code-pays » : « US »,
        « activé » : faux
	},
	« statut » : « succès »,
	« timestamp » : « 2019-11-29T16:03:23.9251680Z »
}

Exemple #

Cette demande créera un nouveau 3CX PbxConnectionProfile avec les détails suivants :

Demande #

POST <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs> HTTP/1.1
Content-Type : application/json
Frais d'acceptation : Vrai
Authorization : Bearer {TOKEN}
Connexion : keep-alive
{
    « \_type » : « ThreeCxConnectionProfile »,
    « name » : « 3CX Connexion »,
    « licenseKey » : « licenseKeyLicenseKey-licenseKey »,
    « nom d'utilisateur » : « nom d'utilisateur-nom d'utilisateur-nom d'utilisateur »,
    « mot de passe » : « mot de passe mot de passe »,
    « enableRecordingArchive » : « vrai »,
    « recordingArchive Fréquence » : « 00:20:00 »
}

Réponse #

HTTP/1.1 201 Créé
Type de contenu : application/json; Charset=UTF-8
Contenu - Longueur : xx
Emplacement : <https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID}>
{
	« data » : {
 		 « \_type » : « ThreeCxConnectionProfile »,
        « name » : « 3CX Connexion »,
        « licenseKey » : « licenseKeyLicenseKey-licenseKey »,
        « nom d'utilisateur » : « nom d'utilisateur-nom d'utilisateur-nom d'utilisateur »,
        « mot de passe » : « mot de passe mot de passe »,
        « enableRecordingArchive » : « vrai »,
        « recordingArchive Fréquence » : « 00:20:00 »
	},
	« statut » : « succès »,
	« timestamp » : « 2019-11-29T16:03:23.9251680Z »
}

Erreurs #

Non autorisé #

Lorsque le jeton n'est pas fourni, invalide ou expiré

HTTP/1.1 401 Non autorisé

Mauvaise demande #

Lorsque l'identifiant du locataire fourni n'est pas dans le bon format

HTTP/1.1 400 Mauvaise demande
Date : Thu, 06 Feb 2020 12:45:27 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 149
{
	« error » : 400,
	« message » : « La valeur '<tenant id>' n'est pas valide.
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Non trouvé #

Lorsqu'il n'y a pas de clients qui ont un identifiant de locataire correspondant

HTTP/1.1 404 Introuvable
Date : Thu, 06 Feb 2020 12:46:58 GMT
Type de contenu : application/json; charset=utf-8
Longueur du contenu : 95
{
	« error » : 404,
	« message » : « Introuvable »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:46:58.7669535Z »
}