Sign inGet Started

Get an Apple Messages template version's language

GET
/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);
Antwort200
{
  "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.

Parameter

template_refstring

The template's ID (amt_…) or slug.

version_idstring

The version that holds the language.

languagestring

The language as a BCP-47 tag. Case and separator differences are accepted and canonicalized.

Antwort-Payload

language
string
erforderlich

The language in canonical BCP-47 form.

text
object

Stored text and files. Includes its {{ variable }} placeholders.

Untergeordnete Attribute anzeigen
text.body
string
erforderlich

Text displayed in the message. Use one U+FFFC object replacement character per attachment to control placement.

text.subject
string

Subject displayed above the message body.

text.link_previews
object

How the links in body of a message you send are previewed. Each https://, http:// or www. link is sent as its own rich link, built from the linked page's title and image. Punctuation that ends a link's sentence is dropped, so it does not arrive on its own after the card.

For the image, the page's og:image is tried first, then its largest apple-touch-icon or icon, then the largest image in the page. layout applies to every preview in the message: icon and square try the icon first, and large tries the images in the page before the icon.

Only a text sent on its own can set link_previews. A request that sets it beside rich_link or interactive is refused with 422. Leave it out there, and links in that text become previews in the default layout.

A message is accepted and then ends send_failed when:

  • It has more than 20 links.
  • A page does not load over HTTPS, or has no title or usable image. Every page is fetched over HTTPS, upgrading http:// and www. links.

Every link is checked before the first part is sent, so the customer receives none of the message. A retry after some parts were delivered checks only the parts still to send, so a link that stops loading by then fails the message after those parts arrived.

Untergeordnete Attribute anzeigen
text.link_previews.layout
string

How 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:

  • icon shows a small image beside the title. The image is scaled to under 150 px wide. Use it for logos.
  • square shows 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.
  • large shows 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
object

Stored link preview. Includes its {{ variable }} placeholders.

Untergeordnete Attribute anzeigen
interactive
object

Stored interaction. Includes its {{ variable }} placeholders.

Untergeordnete Attribute anzeigen
revision
integer
erforderlich

This language's revision counter, used for concurrent-edit checks on draft writes.

content_hash
string
erforderlich

A 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_at
nullable string
erforderlich

When this language was last saved. Null for a built-in template.

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.