Sign inGet Started
Começar
Guias
Referência de API
SDKs
CLI
Base de conhecimento
Changelog

Get an SMS messaging profile

GET
/v1/sms/messaging-profiles/{profile_id}
bird sms messaging-profiles get <profile-id>
Resposta200
{
  "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"
  ]
}

Returns one messaging profile, including its senders, reply numbers, and sending defaults.

Parâmetros

profile_idstring

ID of the messaging profile, as returned when you created or listed profiles.

Payload de resposta

id
string
obrigatório

Identifier of this profile.

name
string
obrigatório

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

senders
array of object
obrigatório

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

Mostrar atributos secundários
inbound
object
obrigatório

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

Mostrar atributos secundários
default_category
nullable string
obrigatório

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
obrigatório

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
obrigatório

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
obrigatório

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

Mostrar atributos secundários
options.smart_encoding
boolean
obrigatório

Whether text is converted to the GSM-7 character set where possible, to fit more characters in a segment.

options.ignore_suppression
boolean
obrigatório

Whether messages are sent even if the recipient is suppressed for the sender, including after replying STOP. Messages that do not set ignore_suppression use this value. Only authentication and transactional messages can skip suppressions. It cannot be true while default_category is marketing or service. Bird must enable it for your workspace; until then, messages that use it are refused.

options.callback_url
nullable string
obrigatório

The HTTPS URL that receives this profile's message events instead of your webhook endpoints. Null when none is set. Messages that do not set callback_url use it, and so do replies on the profile's numbers that have no inbound.callback_url. Each event is a signed POST, signed with your workspace callback signing secret, which rotateWebhookCallbackSigningSecret creates and returns once. While a URL applies, a message's events skip your plain webhook endpoints. MCP Events subscriptions and connector endpoints still receive them.

callback_events
nullable array
obrigatório

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
obrigatório

When the profile was created.

updated_at
string
obrigatório

When the profile was last changed.

Recursos relacionados

Continue com a documentação, guias e exemplos sobre este tópico.

Obtenha um resumo de implementação