sms-senders

List your SMS senders

Changed on

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

get/v1/sms/senders

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/sms/senders
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

typestring

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

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

number_idstring

Identifier of a number allocated to your workspace, as returned in the id field of GET /v1/numbers.

Example:nda_01krdgeqcxet5s7t44vh8rt9mg

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.

sort'created_at' | 'sender'

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.

order'asc' | 'desc'

Sort direction, ascending or descending.

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

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.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of your SMS senders with their registrations.

next_cursorstring nullable required

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

prev_cursorstring nullable required

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

refresh_cursorstring nullable required

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.

totalinteger nullable

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

Example response

{
  "data": [
    {
      "id": "snd_01krdgeqcxet5s7t44vh8rt9mg",
      "country_code": "US",
      "number_id": "nda_01krdgeqcxet5s7t44vh8rt9mg",
      "destinations": {
        "active": [
          "US"
        ],
        "pending": [
          "US"
        ],
        "needs_attention": [
          "US"
        ]
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes