Sign inGet Started

Create an SMS sender

POST
/v1/sms/senders
await bird.smsSenders.create({ type: "alpha", sender: "GOLDCREST" });
Respons201
{
  "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"
    ]
  }
}

Claims an alphanumeric sender string for your workspace. Country and sender-type policies determine whether registration is unavailable, optional, or required before sending.

Payload Permintaan

type
string
wajib

The kind of sender to create. Only alpha (an alphanumeric sender string) is customer-creatable. Dedicated numbers become senders when you allocate them from inventory. This endpoint cannot create their senders.

Possible values: alpha

sender
string
wajib

The alphanumeric sender string to create, for example "BIRD". 3–11 letters, digits, spaces, dashes, underscores, or dots, at least one of them a letter, and no separator at either end.

Payload Respons

id
string
wajib

Identifier of this sender.

sender
string
wajib

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

source_kind
string
wajib
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.

country_code
nullable string

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

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.

status
string
wajib
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.

Tampilkan atribut turunan
destinations
object
wajib
Tampilkan atribut turunan
created_at
string
wajib
updated_at
string
wajib