Créer un client

Créer un client #

Crée un nouveau client client

POST /v1.0/clients

Exemple #

Cette demande créera un nouveau client avec les détails suivants :

  • Nom : « Nouveau client »
  • Description : « C'est mon nouveau client »
  • Référence : « ABC00001 »
  • Activé : false
  • Fuseau horaire : « Amérique/Los_Angeles »,
  • Code pays : « US »
  • PbxConnectionProfile
    • Crossbar API de repos : « https://hostrest »
    • Blackhole Websocket Api : « wss// :hostwebsocket »
    • ~.pbx.kazoo.name.~ AccountId : « accountid »
    • ~.pbx.kazoo.name.~ Clé API : « apikey »
    • monitorSubAccounts : Faux
  • sendNewUserEmail : Faux
  • sendConnectWelcomeEmail : Faux
  • Durée de l'essai : « 0 »

Demande # 

POST <https://api.uk.myreports.cloud/api/v1.0/customers> HTTP/1.1
Content-Type : application/json
Frais d'acceptation : Vrai
Authorization : Bearer {TOKEN}
Connexion : keep-alive
{
	« nom » : « Nouveau client »,
	« description » : « Voici mon nouveau client »,
	« référence » : « ABC00001 »,
	« activé » : faux,
	« fuseau horaire » : « America/Los_Angeles »,
	« code-pays » : « US »,
	« pbxConnectionProfile » : {
		« \_type » : « KazooPbxConnectionProfile »,
		« hostRest » : « http\://hostrest »,
		« hostWebsocket » : « wss// :hostwebsokcet »,
		« accountId » : « accountid »,
		« apiKey » : « apikey »,
		« monitorSubaccounts » : faux
	},
	« sendNewUserEmail » : false,
	« sendConnectWelcomeEmail » : faux,
	« trialdurée » : « 0 »
}

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/{NEW_CUSTOMER_TENANT_ID}>
{
	« data » : {
		« id » : « {NEW_CUSTOMER_TENANT_ID} »,
		« nom » : « Nouveau client »,
		« description » : « Voici mon nouveau client »,
		« activé » : faux,
		« parentTenantId » : « {PARENT_ACCOUNT_TENANT_ID} »
	},
	« statut » : « succès »,
	« timestamp » : « 2019-01-01T10:00:00.6829447Z »
}

Erreurs #

Non autorisé #

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

HTTP/1.1 401 Non autorisé

Mauvaise demande (1) #

Lorsque vous demandez un essai et que votre compte revendeur n'a pas d'autorisation. 

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 » : « Les clients d'essai ne sont pas activés pour votre compte. »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}

Mauvaise demande (2) #

Lorsque vous demandez un essai au-delà de la durée maximale d'essai configurée. 

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 » : « L'essai des clients dépasse la durée maximale autorisée pour votre compte. »,
	« status » : « erreur »,
	« timestamp » : « 2020-02-06T12:45:27.5903465Z »
}