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
inbound.numbers
array of object
obrigatório

The numbers that receive replies for this profile.

Mostrar atributos secundários
inbound.numbers.country_code
string

The country of a short code, as an uppercase ISO 3166-1 alpha-2 code. Required for a short code. Omit it for a number in E.164 format, which receives replies from subscribers in any country.

inbound.numbers.number
string
obrigatório

A short code as digits, or a number in E.164 format. It must be a number your workspace holds that can receive SMS, and it can belong to one profile at a time.

inbound.callback_url
nullable string
obrigatório

The HTTPS URL that receives sms.received events for replies on this profile's numbers, signed with your workspace callback signing secret. Null when none is set, in which case replies use options.callback_url, then your webhook subscriptions. While a URL applies, a reply skips your plain webhook endpoints.

inbound.outbound_matching
object
obrigatório

Settings for pairing each reply with the message it answers, reported as the reply's in_reply_to_message. Bird pairs only messages sent from one of this profile's reply numbers while matching is on. Turning it off stops pairing, and turning it back on resumes it for messages still inside their window.

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
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