Allo

Obtenir un compte

Renvoie le statut d'un compte que vous avez provisionné, y compris si le client l'a activé (connecté sur un appareil). Vous ne pouvez consulter que les…

GET/v2/api/partner/accounts/{id}

Renvoie le statut d'un compte que vous avez provisionné, y compris si le client l'a activé (connecté sur un appareil). Vous ne pouvez consulter que les comptes créés par votre propre clé API. Tout autre id renvoie 404.

  • status est le statut du compte : ACTIVE, ou SUSPENDED tant que le compte est suspendu.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

The account id returned on create.

Réponses

200Account
dataobject
6 champs
idstring
api_keystring | null

Scoped API key for the new account, with the scopes CRM_READ, CRM_WRITE, WEBHOOKS_READ_WRITE, CONVERSATIONS_READ, PHONE_NUMBERS_READ, PHONE_NUMBERS_WRITE, AGENTS_READ, AGENTS_WRITE, SUMMARY_TEMPLATES_READ and SUMMARY_TEMPLATES_WRITE (no SMS_SEND). Returned only on create.

phone_numbersstring[]
statusstring

The account's status: ACTIVE, or SUSPENDED while the account is suspended with Suspend account.

activatedboolean

True once the customer has signed in on a device.

partner_client_refstring | null
401
403The API key lacks the PARTNER scope.
errorobject
404No account with this id was provisioned by your API key (PARTNER_ACCOUNT_NOT_FOUND).
errorobject
429