sms-senders

List what a sender needs to send

Changed on

Returns the countries a sender can reach, each country's requirements, and the current registration status. Omit country_code for the full list. An empty filtered result means the sender has no route to that country.

registration_mode distinguishes optional registration from registration required before sending. status reports registration progress. Optional registration can be pending while messages are accepted with an overwritten sender ID. sender_id_behavior reports the effective behavior without overwrite details; those are published in the country messaging context. Check destination_enabled and other sending restrictions before sending.

Each row's next lists actions for that country, including starting an optional registration. An empty list means there is no next registration action; an absent one means this read does not report it.

The operation depends on program: alpha and numeric use compliance submissions, tfn uses toll-free verification, and 10dlc uses campaign assignment. short_code is filed and maintained by Bird: no API action exists, and a rejected one is resolved through support, as the row's next says. Read each row's next after each operation for the next step.

get/v1/sms/senders/{sender_id}/requirements

Request

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

Query parameters

country_codestring

ISO 3166-1 alpha-2 country code.

Example:US

Ask about one destination country. Omit to return every country relevant to the sender.

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

What this sender needs, per country.

Example response

{
  "data": [
    {
      "sender_id": "snd_01krdgeqcxet5s7t44vh8rt9mg",
      "country_code": "US",
      "registration_id": "scr_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "programs": [
    {
      "countries": [
        "US"
      ]
    }
  ]
}

Changes