Sign inGet Started
Mulai sekarang
Panduan
Referensi API
SDK
CLI
Basis Pengetahuan
Changelog

Get an SMS messaging profile

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

Parameter

profile_idstring

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

Payload Respons

id
string
wajib

Identifier of this profile.

name
string
wajib

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

senders
array of object
wajib

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

Tampilkan atribut turunan
inbound
object
wajib

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

Tampilkan atribut turunan
inbound.numbers
array of object
wajib

The numbers that receive replies for this profile.

Tampilkan atribut turunan
inbound.callback_url
nullable string
wajib

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
wajib

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.

Tampilkan atribut turunan
inbound.outbound_matching.enabled
boolean
wajib

Whether replies are paired with the messages they answer.

inbound.outbound_matching.time_window
string
wajib

How long after a message is sent a reply can still be paired with it: one hour (1h), 24 hours (1d), or 168 hours (7d). 1d is the default.

Possible values: 1h, 1d, 7d

default_category
nullable string
wajib

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
wajib

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
wajib

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
wajib

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

Tampilkan atribut turunan
callback_events
nullable array
wajib

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
wajib

When the profile was created.

updated_at
string
wajib

When the profile was last changed.

Sumber daya terkait

Lanjutkan dengan dokumentasi, panduan, dan contoh untuk topik ini.

Dapatkan ringkasan implementasi