Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

Get an SMS messaging profile

GET
/v1/sms/messaging-profiles/{profile_id}
bird sms messaging-profiles get <profile-id>
Réponse200
{
  "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.

Paramètres

profile_idstring

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

Contenu de la réponse

id
string
obligatoire

Identifier of this profile.

name
string
obligatoire

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

senders
array of object
obligatoire

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

Afficher les attributs enfants
inbound
object
obligatoire

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

Afficher les attributs enfants
inbound.numbers
array of object
obligatoire

The numbers that receive replies for this profile.

Afficher les attributs enfants
inbound.callback_url
nullable string
obligatoire

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
obligatoire

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.

Afficher les attributs enfants
default_category
nullable string
obligatoire

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
obligatoire

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
obligatoire

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
obligatoire

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

Afficher les attributs enfants
callback_events
nullable array
obligatoire

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
obligatoire

When the profile was created.

updated_at
string
obligatoire

When the profile was last changed.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation