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.
Paramètres
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.
Contenu de la réponse
languageThe language in canonical BCP-47 form.
textStored text and files. Includes its {{ variable }} placeholders.
rich_linkStored link preview. Includes its {{ variable }} placeholders.
Afficher les attributs enfants
rich_link.rich_link_dataAfficher les attributs enfants
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.assetsAfficher les attributs enfants
rich_link.rich_link_data.assets.imageAfficher les attributs enfants
rich_link.rich_link_data.assets.image.source_urlHTTPS URL of a PNG, JPEG, GIF or WebP preview image of up to 5 MiB and 6 megapixels, or 3 megapixels for a 16-bit PNG. It is fetched when the message is sent, converted to PNG and shrunk to Apple's 200 kB limit. Without layout, a PNG of 200 kB or less goes to Apple unchanged, so the pixel limit does not apply to it. An image over these limits, or one that cannot be converted, ends the message send_failed. It is checked before the first part and again on a retry, so an image that changes by then fails the message after the earlier parts arrived. 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.assets.image.mime_typeMedia type sent to Apple, which accepts only PNG. Defaults to image/png.
Value: image/png
rich_link.rich_link_data.assets.image.layoutHow Apple displays a rich link's image. Apple picks the layout from the image's shape and width, so the image is resized or cropped to produce the one you choose:
iconshows a small image beside the title. The image is scaled to under 150 px wide. Use it for logos.squareshows a square image. The image is cropped to a square and sized to 240 px, or as small as 150 px when it needs to fit Apple's 200 kB limit.largeshows a wide image. A square or portrait image is cropped to a 2:1 rectangle, and a landscape image keeps its shape.
square enlarges an image whose shorter side is under 240 px, and large one narrower than 240 px, which can blur it. Omit layout to keep the image's own shape, so Apple picks the layout from its shape and width.
Possible values: icon, square, large
rich_link.rich_link_data.assets.videorich_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.
interactiveStored interaction. Includes its {{ variable }} placeholders.
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.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.