Get a WhatsApp message
/v1/whatsapp/messages/{message_id}const msg = await bird.whatsapp.get("wa_abc123");
msg.status; // "accepted" | "delivered" | …msg = client.whatsapp.get("wa_abc123")
print(msg.id, msg.status)package main
import (
"context"
"fmt"
"log"
"os"
bird "github.com/messagebird/bird-sdk-go"
"github.com/messagebird/bird-sdk-go/option"
)
func main() {
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
log.Fatal(err)
}
msg, err := client.Whatsapp.Get(context.Background(), "wam_01krdgeqcxet5s7t44vh8rt9mg")
if err != nil {
log.Fatal(err)
}
fmt.Println(msg.Id, *msg.Status)
}$message = $bird->whatsapp->get('wamid_01krdgeqcxet5s7t44vh8rt9mg');
echo $message->getStatus();bird whatsapp get <message-id>curl -X GET "https://us1.platform.bird.com/v1/whatsapp/messages/{message_id}" \
-H "Authorization: Bearer $TOKEN"{
"id": "wam_01kya19eknftrs2s6p82asmvnh",
"direction": "outbound",
"from": {
"phone_number": "+15550001111"
},
"to": {
"group_id": "wag_01krdgeqcxet5s7t44vh8rt9mg"
},
"text": {
"body": "Tuesday's route sheet is up."
},
"status": "delivered",
"recipient_count": 2,
"delivered_count": 2,
"read_count": 2,
"created_at": "2026-09-15T14:03:10Z",
"sent_at": "2026-09-15T14:03:11Z",
"delivered_at": "2026-09-15T14:03:12Z",
"read_at": "2026-09-15T14:04:02Z"
}
Returns a single WhatsApp message: its current delivery status, per-stage timestamps (sent_at, delivered_at, read_at), and failure detail when it failed. It carries the one content object it was built from: template, or free-form text, image, video, audio, sticker, document, location, interactive or contact_cards. An inbound message carries interactive_reply when the contact tapped a reply button or a list row. An inbound message whose content WhatsApp models and we do not carries unsupported instead, naming the type rather than reading back empty. The status advances asynchronously as delivery progresses, so poll this endpoint (or subscribe to whatsapp.* webhook events) after a send to confirm delivery. For the per-event timeline, use List events for a WhatsApp message instead.
Parameters
message_idstringID of the message, as returned in the send response's id field.
Response Payload
idID of the message, assigned when the send is accepted. Pass it as message_id to the get-message and list-events endpoints.
directionWhether the message was sent by the business (outbound) or received from the contact (inbound).
Possible values: outbound, inbound
fromSender of the message. On outbound messages, the business number it was sent from; on inbound, the WhatsApp contact.
Show child attributes
from.phone_numberPhone number in E.164 format, when known.
from.bsuidBusiness-scoped user ID, Meta's identifier for the WhatsApp user. Present only on the WhatsApp-user side of the message.
from.group_idThe group this address was addressed as, or reached through. It appears on a message's to and nowhere else: never on from, and never on an event's recipient. Outbound, it stands in for the recipient, because a group send names no single phone number. Inbound, it qualifies one: to carries the business phone_number that received the message and the group it arrived through, while from stays the participant who wrote it. Its presence on to is what tells a group message from a one-to-one one, in either direction.
from.usernamePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the contact has not adopted one, and on a message received before this workspace started recording them. Same form as a number's own username (WhatsAppNumberProfile.username), without a leading @; a message cannot be addressed by it.
from.display_namePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the message carries no profile, and on a message received before this workspace started recording them.
toRecipient of the message. On outbound messages, the WhatsApp contact; on inbound, the business number.
Show child attributes
to.phone_numberPhone number in E.164 format, when known.
to.bsuidBusiness-scoped user ID, Meta's identifier for the WhatsApp user. Present only on the WhatsApp-user side of the message.
to.group_idThe group this address was addressed as, or reached through. It appears on a message's to and nowhere else: never on from, and never on an event's recipient. Outbound, it stands in for the recipient, because a group send names no single phone number. Inbound, it qualifies one: to carries the business phone_number that received the message and the group it arrived through, while from stays the participant who wrote it. Its presence on to is what tells a group message from a one-to-one one, in either direction.
to.usernamePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the contact has not adopted one, and on a message received before this workspace started recording them. Same form as a number's own username (WhatsAppNumberProfile.username), without a leading @; a message cannot be addressed by it.
to.display_namePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the message carries no profile, and on a message received before this workspace started recording them.
templateThe template the message was sent from. For authentication templates the filled-in values are not returned.
Show child attributes
template.slugThe template's stable handle (for example bird_otp).
template.categoryThe category this message was priced at, recorded as it stood when the message was sent. For a template you authored this is the category Meta applies to the language the send resolved to, which can differ from the category declared on the template: Meta categorizes each language separately and may move one. A built-in bird_ template is priced at the single category the built-in declares, the same in every language.
template.languageThe canonical BCP-47 tag of the template variant that was sent.
template.componentsThe values that filled the template's placeholders. Empty for an authentication template, whose content is never returned.
Show child attributes
template.components.typeWhich part of the template this fills in.
body: the main text.button: a button's variable.header: the header's text, media or location.carousel: the cards.
Possible values (may grow over time): header, body, button, carousel
template.components.parametersThe values that fill this part's placeholders. A positional template takes them in {{n}} placeholder order; a template with named parameters requires each parameter's name to match one the template declares, and order then carries no meaning. Send it on every part except carousel, which carries its values on cards. Send no button part at all for a button that takes no value, such as a quick_reply or request_contact_info button, or a url button whose address has no placeholder: a part the template has no slot for is refused here, before the message is sent and charged.
Show child attributes
template.components.parameters.typeThe kind of value this parameter carries, which decides which of the fields below to send.
template.components.parameters.textThe value substituted into the placeholder, as a plain string. Send it on a text parameter.
template.components.parameters.urlPublic https URL of the file a media header shows. Send it on an image, video, gif or document parameter. WhatsApp fetches it at send time, so it must still be reachable then, the same way a free-form media message's url must.
template.components.parameters.locationThe point on the map a location header opens. Send it on a location parameter.
Show child attributes
template.components.parameters.location.latitudeLatitude in decimal degrees.
template.components.parameters.location.longitudeLongitude in decimal degrees.
template.components.parameters.location.nameName of the place, shown above the address.
template.components.parameters.location.addressStreet address of the place. Shown only when name is also set.
template.components.parameters.nameRequired when the template declares named parameters: the placeholder this value fills (for example first_name), matching exactly one of the names the template declares. Name every parameter in that case; order does not matter once names are supplied. Omit this field for a positional template, which takes its values in {{n}} order instead. Sending the wrong set of names, or leaving one out that the template requires, returns a 422 WhatsAppTemplateParameterMismatch.
template.components.cardsThe values that fill each card of a carousel. Send it only on a carousel part. A carousel sends exactly the number of cards its template was approved with, so every card needs an entry.
Show child attributes
template.components.cards.componentsThe values that fill this card's blocks.
Show child attributes
template.components.cards.components.typeWhich part of the card this fills in.
header: the card's image or video.body: its text.button: a button's variable.
Possible values (may grow over time): header, body, button
template.components.cards.components.parametersThe values that fill this part's placeholders, in placeholder order.
Show child attributes
template.components.cards.components.parameters.typeThe kind of value this parameter carries, which decides which of the fields below to send.
template.components.cards.components.parameters.textThe value substituted into the placeholder, as a plain string. Send it on a text parameter.
template.components.cards.components.parameters.urlPublic https URL of the file a media header shows. Send it on an image, video, gif or document parameter. WhatsApp fetches it at send time, so it must still be reachable then, the same way a free-form media message's url must.
template.components.cards.components.parameters.locationThe point on the map a location header opens. Send it on a location parameter.
Show child attributes
template.components.cards.components.parameters.location.latitudeLatitude in decimal degrees.
template.components.cards.components.parameters.location.longitudeLongitude in decimal degrees.
template.components.cards.components.parameters.location.nameName of the place, shown above the address.
template.components.cards.components.parameters.location.addressStreet address of the place. Shown only when name is also set.
template.components.cards.components.parameters.nameRequired when the template declares named parameters: the placeholder this value fills (for example first_name), matching exactly one of the names the template declares. Name every parameter in that case; order does not matter once names are supplied. Omit this field for a positional template, which takes its values in {{n}} order instead. Sending the wrong set of names, or leaving one out that the template requires, returns a 422 WhatsAppTemplateParameterMismatch.
textText the message carried.
Show child attributes
text.bodyThe message text.
imageImage the message carried.
Show child attributes
image.idID of the stored file, to pass as media_id when fetching it. Absent on an outbound message, whose file we never stored.
image.urlWhere to fetch the media. On an inbound message this is a Bird URL you fetch with your API key; it is absent when the file could not be retrieved from WhatsApp. It stays populated after the stored bytes expire, and the link returns 410 from then on. On an outbound message it is the URL the sender supplied, whose availability is the sender's to guarantee.
image.mime_typeMedia type WhatsApp reported for the file, for example image/jpeg. Absent on outbound messages.
image.captionText shown beneath the image. Absent when the sender wrote none.
videoVideo the message carried.
Show child attributes
video.idID of the stored file, to pass as media_id when fetching it. Absent on an outbound message, whose file we never stored.
video.urlWhere to fetch the media. On an inbound message this is a Bird URL you fetch with your API key; it is absent when the file could not be retrieved from WhatsApp. It stays populated after the stored bytes expire, and the link returns 410 from then on. On an outbound message it is the URL the sender supplied, whose availability is the sender's to guarantee.
video.mime_typeMedia type WhatsApp reported for the file, for example image/jpeg. Absent on outbound messages.
video.captionText shown beneath the video. Absent when the sender wrote none.
audioAudio the message carried.
Show child attributes
audio.idID of the stored file, to pass as media_id when fetching it. Absent on an outbound message, whose file we never stored.
audio.urlWhere to fetch the media. On an inbound message this is a Bird URL you fetch with your API key; it is absent when the file could not be retrieved from WhatsApp. It stays populated after the stored bytes expire, and the link returns 410 from then on. On an outbound message it is the URL the sender supplied, whose availability is the sender's to guarantee.
audio.mime_typeMedia type WhatsApp reported for the file, for example image/jpeg. Absent on outbound messages.
audio.voiceWhether this is a voice note rather than an attached audio file. A voice note auto-downloads in the WhatsApp client and can be transcribed for the recipient.
stickerSticker the message carried.
Show child attributes
sticker.idID of the stored file, to pass as media_id when fetching it. Absent on an outbound message, whose file we never stored.
sticker.urlWhere to fetch the media. On an inbound message this is a Bird URL you fetch with your API key; it is absent when the file could not be retrieved from WhatsApp. It stays populated after the stored bytes expire, and the link returns 410 from then on. On an outbound message it is the URL the sender supplied, whose availability is the sender's to guarantee.
sticker.mime_typeMedia type WhatsApp reported for the file, for example image/jpeg. Absent on outbound messages.
sticker.animatedWhether the sticker is animated. Absent on an outbound message.
documentDocument the message carried.
Show child attributes
document.idID of the stored file, to pass as media_id when fetching it. Absent on an outbound message, whose file we never stored.
document.urlWhere to fetch the media. On an inbound message this is a Bird URL you fetch with your API key; it is absent when the file could not be retrieved from WhatsApp. It stays populated after the stored bytes expire, and the link returns 410 from then on. On an outbound message it is the URL the sender supplied, whose availability is the sender's to guarantee.
document.mime_typeMedia type WhatsApp reported for the file, for example image/jpeg. Absent on outbound messages.
document.captionText shown beneath the document. Absent when the sender wrote none.
document.filenameThe sender's own name for the file.
locationLocation the message carried.
Show child attributes
location.latitudeLatitude in decimal degrees.
location.longitudeLongitude in decimal degrees.
location.nameName of the place. Absent when the sender shared a plain pin.
location.addressStreet address of the place. Shown only when name is also set.
location.urlLink to the place, which WhatsApp includes mainly for business locations. Present on an inbound message when the sender's client supplied one, and absent on a message you sent, since sending a location does not support this field.
contact_cardsContact cards on this message: cards the contact shared, either by tapping a button that asked for their number or by sending one from their address book, or the cards this workspace sent.
Show child attributes
contact_cards.originWhy the card arrived. contact_request means the contact tapped a button this workspace sent asking for their number, which is the only signal that the message answers that ask; other means they shared a card in the chat. Open enum: treat an unrecognized value as a way of sharing added since. Set on a card the contact shared; absent on one this workspace sent.
Possible values (may grow over time): contact_request, other
contact_cards.vcardThe contact's card in vCard format. WhatsApp sends it on a card shared in the chat and omits it on a button tap, which carries the number alone. Set on a card the contact shared; absent on one this workspace sent.
contact_cards.nameThe contact's name, when the card carries one.
Show child attributes
contact_cards.name.formatted_nameThe whole name as the contact's device renders it.
contact_cards.name.first_namecontact_cards.name.middle_namecontact_cards.name.last_namecontact_cards.name.prefixcontact_cards.name.suffixcontact_cards.orgWhere the contact works, when the card carries it.
Show child attributes
contact_cards.org.companycontact_cards.org.departmentcontact_cards.org.titlecontact_cards.birthdayThe contact's birthday, which WhatsApp sends as YYYY-MM-DD. Passed through as text rather than typed as a date: the value comes off the contact's own device unvalidated, and a card we could not parse would otherwise have to lose the field or fail the whole read.
contact_cards.phone_numbersThe numbers on the card. A button tap carries the contact's own number here, which is the point of asking.
Show child attributes
contact_cards.phone_numbers.phone_numberThe number as the card holds it, normalized to E.164 where we can parse it. A card is whatever the contact's device stored, so a number that no country's numbering plan accepts, an extension among them, is passed through exactly as it arrived rather than dropped. Parse defensively: most values are E.164 and none is guaranteed to be.
contact_cards.phone_numbers.typeThe label attached to this value, for example CELL, Home or iPhone. Free text: WhatsApp defines no vocabulary. A label on a received card is lowercased; one this workspace sent reads back exactly as sent.
contact_cards.emailsShow child attributes
contact_cards.emails.emailcontact_cards.emails.typeThe label attached to this value, for example CELL, Home or iPhone. Free text: WhatsApp defines no vocabulary. A label on a received card is lowercased; one this workspace sent reads back exactly as sent.
contact_cards.urlsShow child attributes
contact_cards.urls.urlThe address as the card holds it, which is often bare rather than a full URL, so it is passed through as text rather than validated.
contact_cards.urls.typeThe label attached to this value, for example CELL, Home or iPhone. Free text: WhatsApp defines no vocabulary. A label on a received card is lowercased; one this workspace sent reads back exactly as sent.
contact_cards.addressesShow child attributes
contact_cards.addresses.streetcontact_cards.addresses.citycontact_cards.addresses.statecontact_cards.addresses.zipcontact_cards.addresses.countrycontact_cards.addresses.country_codeThe country as the card holds it, left exactly as WhatsApp sent it: it describes a postal address rather than a routing destination.
contact_cards.addresses.typeThe label attached to this value, for example CELL, Home or iPhone. Free text: WhatsApp defines no vocabulary. A label on a received card is lowercased; one this workspace sent reads back exactly as sent.
interactiveInteractive content the message carried. Outbound only: a contact cannot send one. A tap on a reply button or a list row reads back as interactive_reply on the contact's inbound message; a cta_url link sends nothing back, and the two request kinds are answered by an inbound location or contact_cards message.
Show child attributes
interactive.typeWhich kind of interactive message this is, and which field carries it.
interactive.headerWhat was shown above the body. Absent when the message carried no header.
Show child attributes
interactive.header.typeWhich kind of header this is, and which field carries it.
interactive.header.textThe line of text shown above the body.
interactive.header.urlThe URL of the file shown above the body, as the send supplied it. Interactive content is outbound only, so Bird neither stores nor proxies the file.
interactive.body_textThe message's main text.
interactive.footer_textThe small print below the body. Absent when the message carried none.
interactive.buttonsThe buttons the message offered, in the order shown.
Show child attributes
interactive.buttons.typeWhich kind of button this is, and which field carries it.
interactive.buttons.quick_replyThe button's label and the handle it sends back.
Show child attributes
interactive.buttons.quick_reply.slugThe handle the button carries back, never shown to the recipient. On a tap on a template's quick-reply button, it is the payload that template declared.
interactive.buttons.quick_reply.textThe label the recipient saw.
interactive.buttons.cta_urlThe button's label and the address it opens.
Show child attributes
interactive.buttons.cta_url.textThe button's label.
interactive.buttons.cta_url.urlThe address the button opens, as the send supplied it.
interactive.listThe menu the message offered.
Show child attributes
interactive.list.button_textThe label of the button that opens the menu.
interactive.list.sectionsThe groups of options in the menu, in the order shown.
Show child attributes
interactive.list.sections.titleThe group's heading, shown above its rows.
interactive.list.sections.rowsThe options in this group, in the order shown.
Show child attributes
interactive.list.sections.rows.slugThe handle the row carries back, never shown to the recipient.
interactive.list.sections.rows.textThe row's label, shown as its title in the menu.
interactive.list.sections.rows.descriptionThe second line under the label. Absent when the row carried none.
interactive.cta_urlThe link button the message offered.
Show child attributes
interactive.cta_url.textThe button's label.
interactive.cta_url.urlThe address the button opens, as the send supplied it.
interactive.cardsThe cards the message offered, in the order they appeared, left to right.
Show child attributes
interactive.cards.headerThe image or video shown at the top of the card.
Show child attributes
interactive.cards.header.typeWhich kind of header this is, and which field carries it.
interactive.cards.header.textThe line of text shown above the body.
interactive.cards.header.urlThe URL of the file shown above the body, as the send supplied it. Interactive content is outbound only, so Bird neither stores nor proxies the file.
interactive.cards.body_textThe card's own text. Absent when the card carried none.
interactive.cards.buttonsThe buttons the card offered, in the order shown.
Show child attributes
interactive.cards.buttons.typeWhich kind of button this is, and which field carries it.
interactive.cards.buttons.quick_replyThe button's label and the handle it sends back.
Show child attributes
interactive.cards.buttons.quick_reply.slugThe handle the button carries back, never shown to the recipient. On a tap on a template's quick-reply button, it is the payload that template declared.
interactive.cards.buttons.quick_reply.textThe label the recipient saw.
interactive.cards.buttons.cta_urlThe button's label and the address it opens.
Show child attributes
interactive.cards.buttons.cta_url.textThe button's label.
interactive.cards.buttons.cta_url.urlThe address the button opens, as the send supplied it.
in_reply_to_message_idThe message this one answers. On an inbound message it is what WhatsApp reports as the reply's target: a tap on a button or a list row, and equally a text or media message the contact sent as a quoted reply. An outbound message echoes the in_reply_to_message_id it was sent with. Absent when the message answers nothing, and absent on an inbound message whose target we cannot match to a message we hold, which is the case for one sent before this workspace started recording them or one already past the 15-day window we keep provider ids for.
interactive_replyWhat the contact tapped, on a message answering an interactive message or a template's quick-reply button. Inbound only.
Show child attributes
interactive_reply.typeWhich kind of tap this reply came from, and which field carries it.
interactive_reply.buttonThe button the contact tapped, as you declared it. On a reply to a template's quick-reply button, slug is the button's payload, which WhatsApp sets to the button's own label.
Show child attributes
interactive_reply.button.slugThe handle the button carries back, never shown to the recipient. On a tap on a template's quick-reply button, it is the payload that template declared.
interactive_reply.button.textThe label the recipient saw.
interactive_reply.listThe row the contact chose, as you declared it. description is present only when the row carried one.
Show child attributes
interactive_reply.list.slugThe handle the row carries back, never shown to the recipient.
interactive_reply.list.textThe row's label, shown as its title in the menu.
interactive_reply.list.descriptionThe second line under the label. Absent when the row carried none.
unsupportedSet when the contact sent content we do not model, naming the WhatsApp content type so the message is not silently empty. Inbound only.
Show child attributes
unsupported.typeThe WhatsApp content type we did not model. unsupported is not a placeholder here: WhatsApp reports its own unsupported type for a message its own clients cannot render, and that arrives as this value. Open enum: WhatsApp adds content types over time, so treat an unrecognized value as a future type rather than an error.
Possible values (may grow over time): reaction, interactive, button, order, system, unsupported
reactionsEmoji reactions standing on this message right now, one per sender. Absent when the message has none. A reaction that was replaced by a different emoji, or taken back, is not listed; the message's reaction log keeps that history. WhatsApp accepts a reaction on a message up to 30 days old, and we keep provider ids for 15, so a reaction placed on a message older than that cannot be matched to it and does not appear here.
Show child attributes
reactions.emojiThe emoji, as WhatsApp sent it. It is not normalized, so two emoji that render identically can differ byte for byte and compare unequal.
reactions.fromWho reacted. On a group message this is what tells one participant's reaction from another's. On a one-to-one message it is your business number on a reaction you placed and the contact on one they placed, which is why it is here rather than inferred from the message's direction.
Show child attributes
reactions.from.phone_numberPhone number in E.164 format, when known.
reactions.from.bsuidBusiness-scoped user ID, Meta's identifier for the WhatsApp user. Present only on the WhatsApp-user side of the message.
reactions.from.group_idThe group this address was addressed as, or reached through. It appears on a message's to and nowhere else: never on from, and never on an event's recipient. Outbound, it stands in for the recipient, because a group send names no single phone number. Inbound, it qualifies one: to carries the business phone_number that received the message and the group it arrived through, while from stays the participant who wrote it. Its presence on to is what tells a group message from a one-to-one one, in either direction.
reactions.from.usernamePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the contact has not adopted one, and on a message received before this workspace started recording them. Same form as a number's own username (WhatsAppNumberProfile.username), without a leading @; a message cannot be addressed by it.
reactions.from.display_namePresent only on a message received from a WhatsApp user, on from; never on an outbound send's to, where the profile is not known. Absent when the message carries no profile, and on a message received before this workspace started recording them.
statusrecipient_countHow many recipients a group send was addressed to, taken when the send was accepted. It is the group's membership at that moment, not its membership now: someone joining through the invite link while the message is in flight does not receive it and does not change this count.
Absent on a one-to-one message, along with delivered_count and
read_count. A message with one recipient has no fan-out to report, and
its delivery is what status, delivered_at and read_at already say.
Absent for the same reason on a group message sent before Bird recorded
the count, and on a send to a group nobody had joined yet: there is no
denominator to report, and none can be recovered after the fact, since
membership has moved on. to.group_id is what tells a group message from
a one-to-one one in every case, including those two. With no denominator
to resolve against, status is read as stored, the way a one-to-one
message's is: it reaches sent when the message is handed to WhatsApp and
stops there, because delivery is confirmed per participant and a send with
no participants collects no confirmations.
It is also the denominator status is resolved against: on a group
message status reports the furthest point every recipient has
reached, so it turns delivered only once delivered_count equals this
number, and stays sent while some have confirmed and others have not.
failed and rejected are never per recipient: there is one hand-off to
the WhatsApp network and one way for that to be refused. delivered_at
and read_at are the first recipient's, not the last.
delivered_countHow many of the recipient_count recipients WhatsApp has confirmed the
message reached. A recipient who reported only a read counts here too:
WhatsApp skips the delivery receipt when someone is already looking at
the chat, so waiting for one would leave that person uncounted for ever.
Absent on a one-to-one message, which has no fan-out to count, and on a
group message with no recipient_count to count against.
read_countHow many of the recipient_count recipients have opened the message.
Read receipts do not move status, which has no read value; they
surface here and in read_at.
Absent on a one-to-one message, which has no fan-out to count, and on a
group message with no recipient_count to count against.
last_errorFailure detail for a message that did not reach the recipient. Present only when the message failed or was rejected.
Show child attributes
last_error.codeStandardized failure reason:
insufficient_balance: The workspace wallet could not fund the send.price_not_found: No price was configured for the destination and template.internal_error: An unexpected service failure occurred.undeliverable: The recipient could not be reached.service_window_expired: The 24-hour service window closed; send a template.rate_limited: The send was throttled.recipient_suppressed: The recipient is on the workspace suppression list.media_rejected: WhatsApp could not fetch the media URL, or refused the file it found there;descriptioncarries its reason.
This is an open enum. Accept unrecognized values.
Possible values (may grow over time): insufficient_balance, price_not_found, internal_error, undeliverable, service_window_expired, rate_limited, recipient_suppressed, media_rejected
last_error.descriptionHuman-readable explanation of the failure.
last_error.meta_error_codeRaw error code from the WhatsApp Cloud API, when available, for low-level debugging.
last_error.occurred_atWhen the failure occurred.
created_atWhen the message was accepted for delivery.
sent_atWhen the message was handed to the WhatsApp network. Null until then.
delivered_atWhen delivery was confirmed. Null until then.
read_atWhen the message was read. On an outbound message this is the recipient opening it. On an inbound one it is when Bird acknowledged the message to WhatsApp for the business, which a read receipt sets. Null until then.
costWhat the message cost, split into Bird's charge and any third-party fees passed through. Null on an inbound message, which is never priced, on an outbound message that has not been priced yet, and on one rejected before pricing. The rate depends on the message category and the recipient's country.
Show child attributes
cost.amountTotal charged, as a decimal string: the sum of the components below. Net of tax, which applies to your wallet balance rather than to an individual charge.
cost.currency_codeISO 4217 currency code. Every component is denominated in this currency.
cost.transaction_amountWhat we charged to carry the message, as a decimal string. null when this component was not priced; "0.00000" when it priced at zero.
cost.passthrough_amountThird-party fees we pass on, as a decimal string, such as US 10DLC carrier surcharges. null when this component was not priced; "0.00000" when it priced at zero.
tagsStructured {name, value} filter labels applied to this message.
Show child attributes
tags.nameTag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
tags.valueTag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
metadataArbitrary JSON metadata stored on the message.
Related resources
Continue with the documentation, guides and examples for this topic.