Sign inGet Started

Get a version's language

GET
/v1/whatsapp/templates/{template_ref}/versions/{version_id}/languages/{language}
const language = await bird.whatsapp.templates.versions.languages.get(
  "bird_otp",
  "wav_01ky4x8e4genzb7way45txfkm1",
  "nl-BE",
);
for (const component of language.components) console.log(component.type);
Réponse200
{
  "language": "pt-BR",
  "components": [
    {
      "type": "body",
      "format": "text",
      "text": "Your verification code is {{1}}.",
      "code_expiration_minutes": 60,
      "example_parameters": [
        {
          "type": "text",
          "text": "123456",
          "url": "https://www.example.com/holiday/banner.jpg",
          "name": "first_name"
        }
      ],
      "buttons": [
        {
          "type": "url",
          "otp_type": "copy_code",
          "text": "Copy code",
          "url": "https://www.example.com/orders/{{1}}",
          "phone_number": "+14155550100",
          "example_parameters": [
            {
              "type": "text",
              "text": "123456",
              "url": "https://www.example.com/holiday/banner.jpg",
              "name": "first_name"
            }
          ]
        }
      ],
      "cards": [
        {
          "components": [
            {
              "type": "header",
              "format": "image",
              "text": "Chronograph, brown leather",
              "example_parameters": [
                {
                  "text": "123456",
                  "url": "https://www.example.com/holiday/banner.jpg",
                  "name": "first_name"
                }
              ],
              "buttons": [
                {
                  "type": "url",
                  "otp_type": "copy_code",
                  "text": "Copy code",
                  "url": "https://www.example.com/orders/{{1}}",
                  "phone_number": "+14155550100"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "status": "approved",
  "revision": 4,
  "content_hash": "sha256:9f2c4e1a7b03d85fbc6e29d417a05e8c3b1d9f76a2e4c018d53b7f9a6c2e18d4",
  "category": "authentication",
  "previous_category": "authentication",
  "quality": {
    "current_score": "green",
    "previous_score": "green",
    "updated_at": "2026-07-26T16:41:00Z"
  },
  "rejection": {
    "category": "invalid_format",
    "reason": "Parameters are adjacent.",
    "recommendation": "Add text between the two parameters."
  },
  "error": {
    "description": "component of type HEADER is missing expected field(s)",
    "meta_error_code": "2388043"
  },
  "submitted_at": "2026-07-26T16:40:00Z",
  "approved_at": "2026-07-21T08:15:00Z",
  "updated_at": "2026-07-26T16:41:00Z",
  "updated_by": "usr_01krdgeqcxet5s7t44vh8rt9mg"
}

Returns one language of one version: its content blocks, what this version's submission did with it, and everything Meta holds about it: review outcome and category.

Paramètres

template_refstring

Template ID (wat_ prefix) or slug. A value that parses as a valid ID resolves by ID; any other value resolves as a slug.

version_idstring

ID of the template version (wav_ prefix), as returned by the version list.

languagestring

The language, as a BCP-47 tag. Case and separator variance is accepted and normalised, and the canonical form is returned.

Contenu de la réponse

language
string
obligatoire

The canonical tag this language is addressed by.

components
array of object
obligatoire

This language's content blocks, in display order, exactly as submitted or as they stand in the draft.

Afficher les attributs enfants
status
string

What this submission did with this language. Absent on a draft, which has not been submitted. On a superseded version this is history: how that submission went. It does not report whether the language is sendable now.

Possible values (may grow over time): approved, pending, rejected, paused, disabled, in_appeal, pending_deletion, limit_exceeded, archived, deleted, submit_failed, outcome_unknown

revision
integer
obligatoire

This language's write counter, incremented every time its content changes. It sits at 1 on content that has never been written through this API, which is every built-in template's language.

content_hash
string
obligatoire
category
string

The category Meta is applying to this language, which is what messages from it are priced at.

Possible values (may grow over time): authentication, utility, marketing

previous_category
string

The category this language held before Meta moved it.

Possible values (may grow over time): authentication, utility, marketing

quality
object

Meta's quality rating for this language. Present only on the version currently in service, and only once Meta has rated it.

Afficher les attributs enfants
rejection
object

Why Meta refused this content, present when status is rejected. Absent otherwise.

Afficher les attributs enfants
error
object

Why the submission did not complete, present when status is submit_failed or outcome_unknown. Absent otherwise, including on a rejection, whose reason is in rejection.

Afficher les attributs enfants
submitted_at
nullable string
obligatoire

When this content was submitted to Meta. Null on a draft, which has not been submitted, and null for a built-in template's language, which Bird ships already approved rather than submitting on your behalf.

approved_at
nullable string

When Meta approved this exact content. It is a permanent mark on the content rather than a status, so a later pause or archival does not clear it. Null for a built-in template's language, whose approval predates Bird holding a date for it.

updated_at
nullable string
obligatoire

When this language last changed. Null for a built-in template's language, which Bird ships rather than stores.

updated_by
nullable string

The workspace member who last wrote this language. Always null for a built-in template's language: nobody in the workspace authored it.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.