Allo

Get sender ID

Returns a sender ID declared on one of your accounts, with its review status. Use it to poll the status if you do not receive webhooks, and to see whether…

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

Returns a sender ID declared on one of your accounts, with its review status. The partner.sender_id.validated and partner.sender_id.failed webhooks tell you when the review ends. Without a webhook endpoint, poll this endpoint instead, within the rate limit of 20 read requests per second per key.

statusWhat it means
PENDINGThe sender ID is waiting for Allo's review, usually 1 to 5 business days.
VALIDATEDAllo approved the sender ID. The account can send SMS with it.
FAILEDAllo rejected the sender ID. Declare another name with Declare sender ID.
DISABLEDAllo deactivated the sender ID after validating it. Sending SMS with it is refused.

Allo sends no webhook when a sender ID becomes DISABLED. Read this endpoint to check that a validated sender ID is still usable.

An id that is not a sender ID of this account fails with 404 PARTNER_SENDER_ID_NOT_FOUND. An account your API key did not create returns 404 PARTNER_ACCOUNT_NOT_FOUND.

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

account_idstringrequired

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

idstringrequired

The sender ID's id returned by Declare sender ID (vsi-*).

Responses

200Sender ID
dataobject

An alphanumeric sender ID declared on an account you provisioned.

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.

401
403The 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).
errorobject
429