Renvoie un Sender ID déclaré sur l'un de vos comptes, avec son statut de validation. Les webhooks partner.sender id.validated et partner.sender id.failed…
Renvoie un Sender ID déclaré sur l'un de vos comptes, avec son statut de validation. Les webhooks partner.sender_id.validated et partner.sender_id.failed vous préviennent à la fin de la validation. Sans endpoint webhook, interrogez cet endpoint à la place, dans la limite de 20 requêtes de lecture par seconde et par clé.
status
Signification
PENDING
Le Sender ID attend la validation d'Allo, en général 1 à 5 jours ouvrés.
VALIDATED
Allo a validé le Sender ID. Le compte peut envoyer des SMS avec lui.
Allo a désactivé le Sender ID après l'avoir validé. L'envoi de SMS avec lui est refusé.
Allo n'envoie aucun webhook quand un Sender ID passe à DISABLED. Consultez cet endpoint pour vérifier qu'un Sender ID validé est toujours utilisable.
Un id qui n'est pas un Sender ID de ce compte échoue avec 404 PARTNER_SENDER_ID_NOT_FOUND. Un compte que votre clé API n'a pas créé renvoie 404 PARTNER_ACCOUNT_NOT_FOUND.
Autorisation
Authorizationstring · headerrequis
Api-Key ak_live_…
Paramètres de chemin
account_idstringrequis
The account id returned by Create account (usr-*).
idstringrequis
The sender ID's id returned by Declare sender ID (vsi-*).
Réponses
200Sender ID
dataobject
An alphanumeric sender ID declared on an account you provisioned.
7 champs
idstring
The sender ID's id (vsi-*).
account_idstring
The account the sender ID is declared on.
partner_client_refstring | null
Your own reference, set when the account was created.
sender_idstring
The name recipients see instead of a phone number.
statusenum<string>
PENDING: waiting for Allo's review. VALIDATED: approved, the account can send SMS with it. FAILED: rejected, declare another name. DISABLED: deactivated by Allo after validation, sending with it is refused.
PENDINGVALIDATEDFAILEDDISABLED
example_contentstring | null
The example message sent with the declaration.
created_atstring<date-time>
When the sender ID was declared.
401403The API key lacks the PARTNER scope.
errorobject
404The account was not provisioned by your API key (PARTNER_ACCOUNT_NOT_FOUND), or no sender ID with this id is declared on the account (PARTNER_SENDER_ID_NOT_FOUND).