List your SMS senders

GET

/v1/sms/senders

await bird.smsSenders.list();

client.sms_senders.list()

for sender, err := range client.SmsSenders.List(ctx, bird.SmsSendersListParams{}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(sender.Id)
}

foreach ($bird->smsSenders->list() as $sender) {
    echo $sender->getId(), PHP_EOL;
}

bird sms senders list

curl -X GET "https://us1.platform.bird.com/v1/sms/senders" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=created_at" \
  --url-query "order=desc" \
  --url-query "limit=25" \
  --url-query "include_total=false"

Resposta200

{
  "data": [
    {
      "id": "snd_01krdgeqcxet5s7t44vh8rt9mg",
      "source_kind": "number",
      "sender_type": "long_code",
      "country_code": "US",
      "number_id": "nda_01krdgeqcxet5s7t44vh8rt9mg",
      "status": "active",
      "next": [
        {
          "kind": "operation"
        }
      ],
      "destinations": {
        "active": [
          "US"
        ],
        "pending": [
          "US"
        ],
        "needs_attention": [
          "US"
        ]
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the dedicated numbers and alphanumeric senders your workspace holds, newest first, with each sender's per-country registration status.

Parâmetros de consulta

typestring

Filter senders by source type: a dedicated number, shared shortcode, or alphanumeric sender string.

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

number_idstring

Return the sender for one number you hold, using the ID from List workspace numbers. Exactly one sender exists per number, so this returns at most one result.

sortstring

Field to sort by. created_at (the default) sorts newest first with the default order. sender sorts alphabetically by the sender's own value (phone number, short code, or alphanumeric sender string), all treated as plain text.

Possible values: created_at, sender

orderstring

Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.

Possible values: asc, desc

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

include_totalboolean

When true, the response includes a total field with the total number of items matching the request's filters across all pages.

Payload de resposta

data

array of object

obrigatório

Your workspace's dedicated numbers and alphanumeric senders, newest first.

Mostrar atributos secundários

data.id

string

obrigatório

Identifier of this sender.

data.sender

string

obrigatório

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

data.source_kind

string

obrigatório

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

data.sender_type

string

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

data.country_code

nullable string

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

data.number_id

string

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.

data.status

string

obrigatório

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

data.next

array of object

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.

Mostrar atributos secundários

data.next.kind

string

obrigatório

What you do about this step.

operation: call the operation named in operation, then read again.
external: act somewhere this API does not reach, then read again.
wait: nothing is asked of you, so read again later.
terminal: nothing you do resolves this, so stop retrying.

Tolerate a value you do not recognize: show the description and offer no action.

Possible values (may grow over time): operation, external, wait, terminal

data.next.description

string

obrigatório

A short, human-readable label for the step, suitable for display.

data.next.operation

string

The operationId to call. Present only when kind is operation. The operation's own schema says how to call it; this says only which one, and what to address it with.

data.next.params

object

The parameters that address the operation, by name: {"sender_id": "…"} for an operation on /v1/sms/senders/{sender_id}/requirements. A parameter the operation takes in its query string is given the same way, so an operation addressed as ?subject_id= carries {"subject_id": "…"}. Every parameter the call needs is here, whether its value came from the thing you were acting on or is fixed for this step, so you can make the call from this object alone. Present only when kind is operation and the operation names a subject. A request body, when the operation takes one, is described by the operation's own schema and never appears here.

data.next.url

string

A URL to open. Present only when kind is external, and only when the step has one. An external step whose description says to go and do something with no URL to open is normal.

data.destinations

object

obrigatório

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.

Mostrar atributos secundários

data.created_at

string

obrigatório

data.updated_at

string

obrigatório

next_cursor

nullable string

obrigatório

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursor

nullable string

obrigatório

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursor

nullable string

obrigatório

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

total

nullable integer

Total number of items matching the request's filters across all pages. Present only when include_total=true was passed; otherwise null.

Continue com a documentação, guias e exemplos sobre este tópico.

Obtenha um resumo de implementação

await bird.smsSenders.list();

client.sms_senders.list()

for sender, err := range client.SmsSenders.List(ctx, bird.SmsSendersListParams{}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(sender.Id)
}

foreach ($bird->smsSenders->list() as $sender) {
    echo $sender->getId(), PHP_EOL;
}

bird sms senders list

curl -X GET "https://us1.platform.bird.com/v1/sms/senders" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "sort=created_at" \
  --url-query "order=desc" \
  --url-query "limit=25" \
  --url-query "include_total=false"

Resposta200

{
  "data": [
    {
      "id": "snd_01krdgeqcxet5s7t44vh8rt9mg",
      "source_kind": "number",
      "sender_type": "long_code",
      "country_code": "US",
      "number_id": "nda_01krdgeqcxet5s7t44vh8rt9mg",
      "status": "active",
      "next": [
        {
          "kind": "operation"
        }
      ],
      "destinations": {
        "active": [
          "US"
        ],
        "pending": [
          "US"
        ],
        "needs_attention": [
          "US"
        ]
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

List your SMS senders

Parâmetros de consulta

Payload de resposta

Recursos relacionados