Sign inGet Started

Get an SMS message

GET
/v1/sms/messages/{message_id}
const msg = await bird.sms.get("sms_abc123");
msg.status; // "accepted" | "delivered" | …
Réponse200
{
  "id": "sms_01krdgeqcxet5s7t44vh8rt9mg",
  "direction": "outbound",
  "status": "scheduled",
  "to": "+15551234567",
  "from": "+15557654321",
  "text": "Your order has shipped and is on its way.",
  "category": "transactional",
  "requested_language": "pt-BR",
  "resolved_language": "pt-BR",
  "template_id": "smt_01krdgeqcxet5s7t44vh8rt9mg",
  "template_version_id": "smv_01krdgeqcxet5s7t44vh8rt9mg",
  "template_content_hash": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "segments": {
    "count": 1,
    "encoding": "GSM_7BIT",
    "characters": 41
  },
  "cost": {
    "amount": "0.00990",
    "currency_code": "USD",
    "transaction_amount": "0.00790",
    "passthrough_amount": "0.00200"
  },
  "tags": [
    {
      "name": "category",
      "value": "welcome"
    }
  ],
  "options": {
    "smart_encoding": true
  },
  "carrier": "Verizon",
  "mcc_mnc": "311480",
  "last_error": {
    "code": "invalid_destination",
    "description": "Carrier filtered as spam"
  },
  "created_at": "2026-05-21T12:00:00Z"
}

Returns a single SMS message: its current delivery status, segment breakdown, cost, and failure detail when it failed. The status advances asynchronously as delivery progresses, and cost is null until the message has been priced, so poll this operation (or subscribe to sms.* webhook events) after a send to confirm delivery. To scan messages in bulk, use List SMS messages instead.

Paramètres

message_idstring

ID of the message, as returned in the send response's id field.

Contenu de la réponse

id
string
obligatoire

ID of the message, assigned when the send is accepted. Pass it as message_id to the get-message endpoint.

direction
string
obligatoire

Whether the message was sent from a Bird sender (outbound) or received from a subscriber (inbound).

Possible values: outbound, inbound

status
string
obligatoire
to
string
obligatoire

Where the message went. On an outbound message this is the recipient's phone number in E.164 format; on an inbound one it is your own number that received it.

from
string
obligatoire

Where the message came from. On an outbound message this is the sender you sent it from: an E.164 number, an alphanumeric sender ID, or a short code. On an inbound message, this is the phone number that sent it to you.

text
string

The message body. Every message carries body text, attachments, or both, so this is absent only on a received message that carried attachments and no text. For a template send, this is the rendered text after parameter substitution. When category is authentication (a message carrying a one-time code), this is **REDACTED**: the code still reaches the recipient, but the API does not retain it for later reads.

category
nullable string

Content classification supplied for free text or derived from the template. Null for inbound messages.

requested_language
nullable string
obligatoire

The template language requested by the send, in canonical form. Null when the send named no language or used no template.

resolved_language
nullable string
obligatoire

The template language whose text was rendered, in canonical form. Null when the send used no template. This can differ from requested_language when the template's fallback policy selects another language.

template_id
nullable string
obligatoire

The template rendered for this message, or null for a free-text message.

template_version_id
nullable string
obligatoire

The workspace published version or synthetic built-in version rendered at acceptance, or null for a free-text message. For a built-in template, template_content_hash identifies the exact catalogue source.

template_content_hash
nullable string
obligatoire

The rendered language's source fingerprint, or null for a free-text message.

segments
object
obligatoire

Segment breakdown for the body.

Afficher les attributs enfants
cost
nullable object

What the message cost, split into Bird's charge and any third-party fees passed through. Null until the message has been priced.

Afficher les attributs enfants
tags
array of object

Structured {name, value} filter labels applied to this message.

Afficher les attributs enfants
metadata
object

Arbitrary JSON metadata stored on the message and echoed in webhook payloads.

options
object

The settings applied to this message, with any option you omitted filled in with the default in force when you sent it. Absent on inbound messages, and on any outbound message for which no settings were recorded.

Afficher les attributs enfants
validity_period
integer

Preview feature: how long, in seconds, the carrier may keep attempting delivery before the message is marked expired. Not returned yet.

carrier
string

Carrier that handled the message. Absent until a delivery receipt identifies it, and on a received message the carrier reports it only where a carrier fee applies.

mcc_mnc
string

Mobile country code and mobile network code of the carrier. Absent until the carrier is identified.

last_error
nullable object

Failure detail on a message that failed, was rejected, was not delivered, or expired. Absent otherwise.

Afficher les attributs enfants
created_at
string
obligatoire

When the message was accepted (outbound) or received (inbound).

sent_at
nullable string

When the message was handed to the carrier. Null until then.

delivered_at
nullable string

When delivery was confirmed. Null until then.

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