Send a message
/v1/amb/messagesconst result = await bird.amb.send({
from: "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
to: "opaque-customer",
text: { body: "Your order is ready." },
});
console.log(result);result = client.amb.send(from_='b52d6267-2b62-4f8a-8842-0533d0f1dc07', to='opaque-customer', text={'body': 'Your order is ready.'})
print(result)result, err := client.Amb.Send(ctx, bird.AmbSendParams{From: "b52d6267-2b62-4f8a-8842-0533d0f1dc07", To: "opaque-customer", Text: &bird.AMBText{Body: bird.String("Your order is ready.")}})
if err != nil {
log.Fatal(err)
}
fmt.Println(result)$bird->amb->send((new Model\AMBMessageSendRequest())->setFrom('b52d6267-2b62-4f8a-8842-0533d0f1dc07')->setTo('opaque-customer')->setText((new Model\AMBText())->setBody('Your order is ready.')));bird amb send \
--from b52d6267-2b62-4f8a-8842-0533d0f1dc07 \
--text 'Your order is ready.' \
--to opaque-customer-idcurl -X POST "https://us1.platform.bird.com/v1/amb/messages" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"from": "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
"to": "opaque-customer-id",
"text": {
"body": "Your order is ready."
}
}'{
"id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
"conversation_id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
"business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
"direction": "outbound",
"status": "accepted",
"kind": "text",
"source": "operator",
"text": {
"body": "Your order is ready."
},
"rich_link": {
"rich_link_construct": {
"url": "https://apps.apple.com/app/id123456789?clip=1",
"store_region": "US"
}
},
"interactive": {
"received_message": {
"title": "Pick a delivery slot"
},
"list_picker": {
"sections": [
{
"title": "Tomorrow",
"items": [
{
"identifier": "am",
"title": "Morning"
}
]
}
]
}
},
"interactive_reply": {
"request_identifier": "6f1c2a4e-8b7d-4c3a-9e1f-2d5b7a9c0e3f",
"quick_reply": {
"selected_identifier": "yes",
"selected_index": 0
}
},
"in_reply_to_message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
"reply_message_id": "amb_01krdgh7m2zq8w4x6y9b3c5d7e",
"replied_at": "2026-10-13T10:09:00Z",
"locale": "en_US",
"category": "order_update",
"tags": [
{
"name": "category",
"value": "welcome"
}
],
"reference": "INV-1234",
"cost": {
"amount": "0.00990",
"currency_code": "USD",
"transaction_amount": "0.00790",
"passthrough_amount": "0.00200"
},
"last_error": {
"code": "bird:business_not_registered",
"description": "Apple refused the message with HTTP status 404."
},
"requested_language": "pt-BR",
"resolved_language": "pt-BR",
"template_id": "amt_01krdgeqcxet5s7t44vh8rt9mg",
"template_version_id": "amv_01krdgeqcxet5s7t44vh8rt9mg",
"template_content_hash": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
}
Send a message in an existing Apple Messages for Business conversation. from is the Apple business identifier and to is the customer’s opaque identifier for that business. An unknown conversation returns 404; a closed conversation returns 422. Only the customer can reopen a conversation.
Choose text, rich_link, or interactive content. Interactive content contains a quick reply, list picker, event, form, or custom iMessage app. Native payment and authentication requests are not available through this public operation. Device support varies; an unsupported interaction returns 422.
Supply attachments by source URL. Bird downloads the files and uploads them to Apple before sending. Interactive images must be PNG files up to 200 kB each, totaling at most 5 MB. Each attachment must be smaller than 100 MB. A media or provider failure after acceptance changes the message status to send_failed.
The 202 response confirms acceptance, not delivery. Read the message to obtain its final status.
Verzoekpayload
fromApple business identifier of the brand sending the message. Read it from the business’s apple_business_id. The customer must have opened the conversation with this business.
toApple’s opaque customer identifier for this business, available as the conversation’s recipient.opaque_user_id. The conversation must exist and its native status must be open.
sourceWho this message is sent as. A signed-in session may send as operator or automation; an API key may send as api or automation. Omit it to take the default for your credential. Naming a source your credential cannot use is refused with a 422 AMBMessageSourceNotPermitted.
Possible values: operator, automation, api
textA text message. Alongside rich_link or interactive, it is sent first as its own text bubble, in the same message.
rich_linkA link with a preview card.
Onderliggende parameters tonen
rich_link.rich_link_dataOnderliggende parameters tonen
rich_link.rich_link_data.urlHTTPS URL opened by the preview. A non-HTTPS URL is refused with a 422 AMBEndpointNotHTTPS. In a template it may contain {{ }} placeholders; the rendered value must be HTTPS.
rich_link.rich_link_data.titlePreview title.
rich_link.rich_link_data.assetsrich_link.rich_link_constructAsks Apple to build the rich link preview when the message is sent. Use POST /v1/amb/messages/construct-payload beforehand only to check the URL and see the preview's title.
interactiveSomething for the customer to tap, such as quick replies, a list picker, a time picker, a form or a custom iMessage app.
templateSend using a stored template instead of text, rich_link or interactive. The category is derived from the template, so category is rejected alongside it.
categoryFree-form reporting label; it does not change sending or suppression policy, for example order_update. Omit it to send with the default empty category. Rejected alongside template, where the category is derived from the template.
metadataArbitrary JSON object for per-message context. Maximum 2 KB serialized. Top-level keys beginning with __bird are reserved. Returned in the send response, message reads and customer message webhooks.
tagsStructured {name, value} labels for filtering. Maximum 20 tags per send.
referenceAn identifier you want to find this message by, such as an order or ticket number, matched exactly by the message list's reference filter. Set it only when you need to search on it, and put any other data in metadata. Stored on the message, returned on reads and echoed in webhook payloads. Several messages can share one.
groupDepartment identifier for this message.
intentPurpose of this conversation.
localeApple locale identifier, for example en_US. Defaults to the conversation locale.
skip_typingSend the first part without the typing indicator and one-second pause Bird otherwise shows before it. Set it only after you sent typing_start with the conversation typing operation, so the customer already sees typing. A first part that Apple accepts clears that indicator when it arrives. If Bird accepts the message but it fails before then, such as a failed send or a rejection during processing, Bird sends typing_end instead. If the request itself returns an error, nothing is sent, so send typing_end yourself. When Bird splits the message into several parts, such as text around a link, the parts after the first keep their typing indicator.
Response Payload
idID of the message, assigned when it is accepted or received. Pass it as message_id to the get-message and list-events endpoints.
conversation_idThe conversation this message belongs to.
business_account_idThe business the message was sent from or received by.
fromApple business identifier on outbound messages, or the customer's opaque Apple identifier on inbound messages. Omitted when that address is unavailable on a historical record.
toCustomer's opaque Apple identifier on outbound messages, or the Apple business identifier on inbound messages. Omitted when that address is unavailable on a historical record.
directionWhether a message was sent by the business or received from the customer:
outbound: A reply the business sent into the conversation.inbound: A message the customer sent.
Possible values: outbound, inbound
statusSend status:
accepted: Accepted and queued for delivery to Apple.sent: Handed to Apple. There is no delivery or read receipt on this channel, sosentis the furthest an outbound message's status advances.send_failed: Sending stopped because of a business or conversation restriction, a recipient opt-out, an Apple refusal, or exhausted attempts. An earlier attempt may have reached Apple if its response or the local record of success was lost. Seelast_errorfor why sending stopped.rejected: Refused by Bird before any send attempt and never charged: the destination has no price, the wallet could not fund the send, or the content cannot be sent yet. Seelast_error.received: Received as an inbound message.
Possible values: accepted, sent, send_failed, rejected, received
kindDerived content classification for filtering and statistics.
Possible values: text, attachment, rich_link, quick_reply, list_picker, time_picker, form, apple_pay, authenticate, imessage_app, interactive
sourceWho sent this message. Absent on an inbound message, which has no source to report.
Possible values: operator, automation, api
textThe message's text and files. Next to rich_link, interactive or interactive_reply, it is the text that came with them.
interactiveWhat an outbound message offered the customer to tap.
interactive_replyWhat the customer answered, on an inbound message replying to an interactive message.
in_reply_to_message_idOriginal message matched through Apple’s request identifier within the same workspace, business, and conversation. Omitted when no verified match exists, including when more than one sent message in the conversation uses the reply's request identifier.
reply_message_idLatest customer reply whose in_reply_to_message_id names this message. Omitted until a reply is matched, and in webhook payloads.
replied_atWhen Apple delivered the reply in reply_message_id to Bird. This can be slightly earlier than that reply's created_at, which records when Bird processed it. Omitted until a reply is matched, and in webhook payloads.
localeLocale for this message, preserved in Apple’s format, for example en_US. Outbound messages use the request override, then the conversation locale, then the business default. Inbound messages preserve the locale in Apple’s callback. Null when unknown.
categoryThe category this message was sent with, for reporting only. It does not affect sending or suppression policy, or select an Apple department or purpose. Defaults to an empty string when a send names no category. Absent on an inbound message, which has no category to report.
metadataArbitrary JSON object for per-message context. Maximum 2 KB serialized. Top-level keys beginning with __bird are reserved. Returned in the send response, message reads and customer message webhooks.
tagsStructured {name, value} filter labels applied to this message. Absent on an inbound message.
referenceThe reference from the send request. Absent when the send set none, and on inbound messages.
costRecorded per-message charge before MAC pricing. Null in the initial send response, while unpriced, and for MAC-covered replies. MAC fees belong to monthly contact usage, not individual messages. Historical charges have no priced passthrough component.
last_errorFailure detail on a message whose send failed or that Bird rejected before any send attempt. Omitted when there is no failure detail.
created_atThe moment this message was accepted (outbound), or recorded by Bird after Apple delivered it (inbound). This is the timestamp the outbound statistics families bucket and attribute on; there is no separate accepted_at field.
sent_atWhen the selected sending outcome occurred. Null unless the current status is sent and the message is outbound. For older messages without a retained sending event, the stored record time is used.
groupApple department identifier carried by this message. Omitted when absent from the message or unavailable on a historical record.
intentApple purpose identifier carried by this message. Omitted when absent from the message or unavailable on a historical record.
requested_languageThe template language requested by the send, in canonical form. Null when the send named no language or used no template.
resolved_languageThe 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_idThe template rendered for this message, or null for a message sent with native content.
template_version_idThe workspace published version or synthetic built-in version rendered at acceptance, or null for a message sent with native content. For a built-in template, template_content_hash identifies the exact catalogue source.
template_content_hashThe rendered language's source fingerprint, or null for a message sent with native content.
Gerelateerde bronnen
Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.