Get an SMS sender

Identifier of this sender.

The value messages are sent from: a number in E.164 format, a shortcode, or an alphanumeric sender string.

What backs an SMS sender: a dedicated number, a shared shortcode, or an alphanumeric sender string.

Possible values (may grow over time): number, shared_number, alpha

The kind of sender identity this is, which decides what each destination country asks of it. It is finer than source_kind: a short code and an ordinary long code are both numbers but follow different rules.

Possible values: long_code, short_code, alphanumeric, toll_free

The country of the number this sender sends from. Null for an alphanumeric sender.

The number this sender sends from, as returned in the id field of GET /v1/numbers. Present only when source_kind is number or shared_number; an alphanumeric sender has no number behind it. Exactly one sender exists per number, so this is also how you go the other way: GET /v1/sms/senders?number_id={id} returns this sender.

Where a sender stands on its own setup: the ownership paperwork its number owes, and the registrations it holds.

• active: nothing this sender holds is outstanding.
• pending_number_ownership: the paperwork proving you own this sender's number is not in place, either because it has not been supplied or because the country that issued the number has not accepted it yet. Every send from this sender is refused until it does.
• pending_registrations: the sender holds country registrations and none is approved yet. That covers a registration under review and one that was refused, so read next for which.

This is not whether a message will be accepted. That is decided per destination country, and Get sender requirements is the only read that answers it. A sender that has registered nowhere is active, even where every country it can reach wants a registration first. Read next for where to go from here.

Possible values: active, pending_number_ownership, pending_registrations

What to do next about this sender, given the state it is in. Present on reads that compute it: an empty list means there is nothing to do, and the field is absent entirely on responses that do not report next actions.

This routes rather than advises. A sender only knows about itself, so where the work is per-country it names the requirements read rather than guessing which country you meant.

Where this sender stands with the destinations it is set up for, grouped by whose move is next.

These are not every country the sender could reach. pending and needs_attention cover only countries you hold a registration for, so a country you could register for but have not, or one you have simply not switched on, appears in none of the three: there is nothing outstanding there. To see everything reachable and what each country would take, read Get sender requirements.