Sign inGet Started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
Changelog

List what a sender needs to send

GET
/v1/sms/senders/{sender_id}/requirements
await bird.smsSenderRequirements.list("snd_01krdgeqcxet5s7t44vh8rt9mg");
Antwort200
{
  "data": [
    {
      "sender_id": "snd_01krdgeqcxet5s7t44vh8rt9mg",
      "country_code": "US",
      "registration_mode": "none",
      "sender_id_behavior": "unknown",
      "program": "10dlc",
      "status": "pending",
      "next": [
        {
          "kind": "operation"
        }
      ],
      "category": "transactional",
      "registration_id": "scr_01krdgeqcxet5s7t44vh8rt9mg",
      "program_entry": "none"
    }
  ],
  "programs": [
    {
      "program": "10dlc",
      "countries": [
        "US"
      ],
      "status": "pending"
    }
  ]
}

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.

Parameter

sender_idstring

ID of the SMS sender (snd_ prefix), as returned when the sender was created.

Abfrageparameter

country_codestring

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

Antwort-Payload

data
array of object
erforderlich

One entry per destination country this sender can reach, which is the level the decision to carry your message is made at. Ask this list whether you can send somewhere, and what it takes first. A country missing from it is one this sender has no route to at all, so no registration would open it.

Untergeordnete Attribute anzeigen
programs
array of object
erforderlich

The same countries seen as the registrations they belong to, one entry per registration, with the countries each one covers. Ask this list what to do next: an entry whose status is registration_required is a registration you still have to make, and its countries are the ones it would open. Every other entry is a registration you have already made, so this list is the whole picture rather than only the part you have finished.

Untergeordnete Attribute anzeigen
programs.program
nullable string
erforderlich

The program this registration runs. Null for the countries that asked for no registration at all, which are grouped together because the only thing they have in common is that you registered nothing for them.

programs.program_ref
nullable string
erforderlich

The resource this registration produced, which program tells you how to read: a toll-free verification for tfn, or a campaign number link for 10dlc. The link connects this number to its campaign. Get the campaign from GET /v1/sms/10dlc/campaign-number-links/{link_id}. Null for a program that issues none, and for one you have not registered yet. Follow it when the status is under_review, because only that resource distinguishes a carrier still reviewing from one waiting on more information from you.

programs.countries
array of string
erforderlich

Every country this one registration covers. Some programs open several at once, so a single toll-free verification or campaign registration can be what permits four destinations.

programs.status
nullable string
erforderlich

Where this registration stands, for all of the countries it covers. registration_required means you have not made it yet and every country listed is waiting on it. Null in the one case where the countries have diverged and no single answer is true: read those countries individually.

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten