Sign inGet Started
Inizia ora
Guide
Riferimento API
SDK
CLI
Knowledge Base
Changelog

Get an SMS messaging profile

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

Parametri

profile_idstring

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

Payload di risposta

id
string
obbligatorio

Identifier of this profile.

name
string
obbligatorio

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

senders
array of object
obbligatorio

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

Mostra attributi secondari
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
obbligatorio

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

inbound
object
obbligatorio

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

Mostra attributi secondari
default_category
nullable string
obbligatorio

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
obbligatorio

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
obbligatorio

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
obbligatorio

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

Mostra attributi secondari
callback_events
nullable array
obbligatorio

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
obbligatorio

When the profile was created.

updated_at
string
obbligatorio

When the profile was last changed.

Risorse correlate

Continua con la documentazione, le guide e gli esempi per questo argomento.

Ottieni un brief di implementazione