Allo

List sender IDs

Lists the sender IDs declared on one of your accounts, with their review status. Requires the PARTNER scope.

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

Lists the sender IDs declared on one of your accounts, with the review status of each one. An account holds at most 3 sender IDs.

  • page starts at 1 and size defaults to 20, up to 100. The response carries the usual pagination object, see Pagination.
  • status is PENDING, VALIDATED, FAILED or DISABLED. See Get sender ID for what each one means.
  • An account your API key did not create returns 404 PARTNER_ACCOUNT_NOT_FOUND.

To declare a sender ID, call Declare sender ID.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

account_idstringrequired

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

Query parameters

pageinteger

Page number (1-indexed)

sizeinteger

Results per page

Responses

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