Sign inGet Started
Aan de slag
Gidsen
API Reference
SDK's
CLI
Kennisbank
Changelog

Create an SMS messaging profile

POST
/v1/sms/messaging-profiles
bird sms messaging-profiles create --body-file - <<'JSON'
{
  "name": "device-activation",
  "senders": [
    {
      "country_code": "US",
      "sender_id": "snd_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "inbound": {
    "numbers": [
      {
        "number": "+14155550100"
      }
    ]
  },
  "default_category": "authentication"
}
JSON
Reactie201
{
  "id": "mpr_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "device-activation",
  "senders": [
    {
      "country_code": "US",
      "sender_id": "snd_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "inbound": {
    "numbers": [
      {
        "country_code": "US",
        "number": "34001"
      }
    ],
    "callback_url": "https://receipts.example.com/bird/sms/inbound",
    "outbound_matching": {
      "enabled": false,
      "time_window": "1d"
    }
  },
  "default_category": "authentication",
  "validity_period": 3600,
  "cost_center": "CC001234",
  "options": {
    "smart_encoding": false,
    "ignore_suppression": false,
    "callback_url": "https://receipts.example.com/bird/sms/activation"
  },
  "callback_events": [
    "sms.delivered",
    "sms.failed"
  ]
}

Creates a messaging profile for one program in your workspace.

A profile chooses the sender for each destination country, lists the numbers that receive replies, and sets defaults such as the category and smart encoding. Every sender and number must belong to your workspace, and a number can belong to one profile at a time. A send that names the profile in messaging_profile_id takes its sender, default category, and smart encoding from it when the send leaves them out. The values on a profile are defaults: an explicit from, category, or options.smart_encoding on the send wins.

Verzoekpayload

name
string
verplicht

A label for the profile. Names are not unique, so two profiles can share one.

senders
array of object

The sender for each destination country, and optionally a default sender. Each country appears at most once, and at most one entry omits country_code.

Onderliggende parameters tonen
senders.country_code
string

The destination country this sender is used for, as an uppercase ISO 3166-1 alpha-2 code. Omit it to make this the default sender, which is used for every destination country that has no entry of its own. A profile can have one entry per country and one default. An empty string is rejected rather than treated as the default.

senders.sender_id
string
verplicht

The sender to use, as returned by the list SMS senders operation.

inbound
object

How the profile receives replies. Omit it for a profile that only sends.

Onderliggende parameters tonen
default_category
string

The category a free-text send that names this profile uses when it sets none: transactional, marketing, authentication, or service. A template send takes the template's category.

Possible values: transactional, marketing, authentication, service

validity_period
integer

How many seconds a message stays valid before it expires undelivered. A send that omits validity_period uses it.

cost_center
string

A label for assigning the cost of this profile's messages. A send that omits cost_center uses it.

options
object

Sending options for messages that do not set their own. Booleans default to false.

Onderliggende parameters tonen
callback_events
array of string

The events of this profile's outbound messages that go to a callback URL. The list is fixed when a message is accepted, and applies only while the message has a callback URL: an event outside it then reaches neither the URL nor a plain webhook endpoint. Without a callback URL the list has no effect, and every event goes to your webhook endpoints. A value other than sms.accepted, sms.sent, sms.delivered, sms.undelivered, sms.failed, sms.rejected or sms.expired returns 422. sms.received is never filtered. Omit it to deliver every event.

Response Payload

id
string
verplicht

Identifier of this profile.

name
string
verplicht

A label for the profile. Names are not unique, so two profiles can share one.

senders
array of object
verplicht

The sender for each destination country, and the default sender when an entry has no country_code.

Onderliggende attributen tonen
inbound
object
verplicht

How the profile receives replies. A profile without numbers only sends.

Onderliggende attributen tonen
default_category
nullable string
verplicht

The category a free-text send that names this profile uses when it sets none: transactional, marketing, authentication, or service. A template send takes the template's category. Null when none is set.

validity_period
nullable integer
verplicht

How many seconds a message stays valid before it expires undelivered. Null when none is set. A send that omits validity_period uses it.

cost_center
nullable string
verplicht

A label for assigning the cost of this profile's messages. Null when none is set. A send that omits cost_center uses it.

options
object
verplicht

Sending options that messages from this profile use when a message does not set its own.

Onderliggende attributen tonen
callback_events
nullable array
verplicht

The events of this profile's outbound messages that go to a callback URL: sms.accepted, sms.sent, sms.delivered, sms.undelivered, sms.failed, sms.rejected, and sms.expired. The list is fixed when a message is accepted, and applies only while the message has a callback URL: an event outside it then reaches neither the URL nor a plain webhook endpoint. Without a callback URL the list has no effect, and every event goes to your webhook endpoints. sms.received is never filtered. Null means every outbound event goes to the URL.

created_at
string
verplicht

When the profile was created.

updated_at
string
verplicht

When the profile was last changed.

Gerelateerde bronnen

Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.

Ontvang een implementatieoverzicht