Allo

Lister les Sender ID

Liste les Sender ID déclarés sur l'un de vos comptes, avec le statut de validation de chacun. Un compte détient au plus 3 Sender ID.

GET/v2/api/partner/accounts/{account_id}/sender_ids

Liste les Sender ID déclarés sur l'un de vos comptes, avec le statut de validation de chacun. Un compte détient au plus 3 Sender ID.

  • page commence à 1 et size vaut 20 par défaut, jusqu'à 100. La réponse porte l'objet pagination habituel, voir Pagination.
  • status vaut PENDING, VALIDATED, FAILED ou DISABLED. Voir Obtenir un Sender ID pour la signification de chacun.
  • Un compte que votre clé API n'a pas créé renvoie 404 PARTNER_ACCOUNT_NOT_FOUND.

Pour déclarer un Sender ID, appelez Déclarer un Sender ID.

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

account_idstringrequis

The account id returned by Create account (usr-*).

Paramètres de requête

pageinteger

Page number (1-indexed)

sizeinteger

Results per page

Réponses

200The account's sender IDs
dataobject[]
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.

paginationobject
5 champs
pageinteger
sizeinteger
total_countinteger<int64>
total_pagesinteger
has_moreboolean
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