Get an Apple Messages template version's language
/v1/amb/templates/{template_ref}/versions/{version_id}/languages/{language}const language = await bird.amb.templates.versions.languages.get(
"bird_order_update",
"amv_01ky4x8e4genzb7way45txfkm1",
"en",
);
console.log(language.language, language.text);language = client.amb.templates.versions.languages.get(
"bird_order_update", "amv_01ky4x8e4genzb7way45txfkm1", "en"
)
print(language.language, language.text)language, err := client.Amb.Templates.Versions.Languages.Get(context.Background(), "bird_order_update", "amv_01ky4x8e4genzb7way45txfkm1", "en")
if err != nil {
log.Fatal(err)
}
fmt.Println(language.Language, language.Text)$language = $bird->amb->templates->versions->languages->get(
'bird_order_update',
'amv_01ky4x8e4genzb7way45txfkm1',
'en',
);
echo $language->getLanguage(), ' ', $language->getRevision();bird amb templates versions languages get <template-ref> <version-id> <language>curl -X GET "https://us1.platform.bird.com/v1/amb/templates/{template_ref}/versions/{version_id}/languages/{language}" \
-H "Authorization: Bearer $TOKEN"{
"language": "en",
"text": {
"body": "Your order {{ order_number }} is on its way."
},
"revision": 1,
"content_hash": "sha256:3d948846f5f773fb7bed8ab81b57f3d0ff2cbff24cb549718f4d389f1ab0300a",
"updated_at": "2026-09-10T09:00:00Z"
}
Returns one language's full text, revision, content hash, and update time. The response echoes the language in its canonical BCP-47 form.
Parameters
template_refstringThe template's ID (amt_…) or slug.
version_idstringThe version that holds the language.
languagestringThe language as a BCP-47 tag. Case and separator differences are accepted and canonicalized.
Response Payload
languageThe language in canonical BCP-47 form.
textStored text and files. Includes its {{ variable }} placeholders.
rich_linkStored link preview. Includes its {{ variable }} placeholders.
interactiveStored interaction. Includes its {{ variable }} placeholders.
Onderliggende attributen tonen
interactive.session_identifierSession UUID to preserve across interactions. Apple creates one when omitted.
interactive.request_identifierCorrelation identifier for this interaction. Bird generates one when omitted. Use a new value for each message. A reply is linked to its request only when no other sent message in the conversation uses the same identifier.
interactive.imagesImages the interaction references by image_identifier, such as list picker thumbnails.
interactive.quick_replyinteractive.session_identifierSession UUID to preserve across interactions. Apple creates one when omitted.
interactive.request_identifierCorrelation identifier for this interaction. Bird generates one when omitted. Use a new value for each message. A reply is linked to its request only when no other sent message in the conversation uses the same identifier.
interactive.imagesImages the interaction references by image_identifier, such as list picker thumbnails.
interactive.list_pickerinteractive.session_identifierSession UUID to preserve across interactions. Apple creates one when omitted.
interactive.request_identifierCorrelation identifier for this interaction. Bird generates one when omitted. Use a new value for each message. A reply is linked to its request only when no other sent message in the conversation uses the same identifier.
interactive.imagesImages the interaction references by image_identifier, such as list picker thumbnails.
interactive.eventOnderliggende attributen tonen
interactive.event.identifierYour identifier for the event. Defaults to the message identifier.
interactive.event.timezone_offsetMinutes from GMT at the event location. Omit it and timezone to use the customer's time zone.
interactive.event.timezoneIANA time zone of the event location. Apple receives the zone's offset at the time slots, so a template keeps the right offset across a daylight-saving change. Every slot must have the same offset in the zone: slots on both sides of a clock change return 422. Set it instead of timezone_offset. An unknown zone returns 422. In Apple Messages template content it may instead be exactly one placeholder, such as {{ timezone }}, filled with a timezone variable when the template is sent. A direct send with a placeholder returns 422.
interactive.event.timeslotsAppointment times with RFC 3339 timestamps and duration in seconds.
interactive.event.image_identifierIdentifier of the event image in interactive.images.
interactive.event.titleEvent title. Also supplies the title of each omitted received or reply bubble, where the 512-character bubble text limit applies. Supply both bubbles explicitly to use a longer event title.
interactive.session_identifierSession UUID to preserve across interactions. Apple creates one when omitted.
interactive.request_identifierCorrelation identifier for this interaction. Bird generates one when omitted. Use a new value for each message. A reply is linked to its request only when no other sent message in the conversation uses the same identifier.
interactive.imagesImages the interaction references by image_identifier, such as list picker thumbnails.
interactive.dynamicForm content. Bird supplies Apple’s messageForms template and protocol version.
interactive.received_messageContent Messages shows in the received message bubble. For a list picker, time picker or form, this is the visible introduction.
interactive.reply_messageContent Messages shows in the reply message bubble.
interactive.session_identifierSession UUID to preserve across interactions. Apple creates one when omitted.
interactive.request_identifierCorrelation identifier for this interaction. Bird generates one when omitted. Use a new value for each message. A reply is linked to its request only when no other sent message in the conversation uses the same identifier.
interactive.imagesImages the interaction references by image_identifier, such as list picker thumbnails.
interactive.imessage_appA custom iMessage app interaction. It also requires both received_message and reply_message.
interactive.session_identifierSession UUID to preserve across interactions. Apple creates one when omitted.
interactive.request_identifierCorrelation identifier for this interaction. Bird generates one when omitted. Use a new value for each message. A reply is linked to its request only when no other sent message in the conversation uses the same identifier.
interactive.imagesImages the interaction references by image_identifier, such as list picker thumbnails.
interactive.paymentApple Pay request created through the conversation payment endpoint. Contains no payment token or provider credentials.
interactive.session_identifierSession UUID to preserve across interactions. Apple creates one when omitted.
interactive.request_identifierCorrelation identifier for this interaction. Bird generates one when omitted. Use a new value for each message. A reply is linked to its request only when no other sent message in the conversation uses the same identifier.
interactive.imagesImages the interaction references by image_identifier, such as list picker thumbnails.
interactive.authenticateAuthentication attempt created through the conversation authentication endpoint. Contains no authorization parameters or credentials.
revisionThis language's revision counter, used for concurrent-edit checks on draft writes.
content_hashA fingerprint of Apple Messages template content, prefixed with its algorithm. Compare it within this API version to identify the exact source without transferring it.
updated_atWhen this language was last saved. Null for a built-in template.
Gerelateerde bronnen
Ga verder met de documentatie, handleidingen en voorbeelden voor dit onderwerp.