The Get WhatsApp template endpoint returns information for a single WhatsApp message template.

Requirements: Base URL, Authentication, Error codes

Scope: messaging.whatsapp_templates.read

What this does

When you send a Get WhatsApp template request with a template ID, Voiso returns the WhatsApp template object for that template.

When to use it

Retrieve a template after you have its ID from Get list of WhatsApp templates
Display template content and status in an admin tool
Validate that a template exists and is accessible to your API key before sending a message

Prerequisites

WhatsApp messaging must be configured for the contact center.
The template must exist and be accessible to your API key.

Endpoint


GET /api/v4/messaging/whatsapp_templates/{whatsapp_template_id}

Path parameters

whatsapp_template_id
The unique identifier of the WhatsApp template (UUID).

Examples

Minimal request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/whatsapp_templates/0b62763c-40d6-4ec8-8380-3cb94e442a75" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns a WhatsApp template object.

{
  "whatsapp_template": {
    "id": "0b62763c-40d6-4ec8-8380-3cb94e442a75",
    "name": "appointment_reminder",
    "category": "utility",
    "language": "en",
    "body": "Hi {{1}}, this is a reminder about your appointment on {{2}}.",
    "status": "approved",
    "status_reason": null,
    "channel_profiles": [
      {
        "id": 12,
        "channel": "whatsapp",
        "identifier": "18885658889",
        "name": "WhatsApp Main (18885658889)"
      }
    ]
  }
}

Notes

id is the template identifier you use when sending a WhatsApp template message.
body can include placeholders such as {{1}}. Your application is responsible for substituting values before sending.
status indicates the approval state of the template.

Troubleshooting

401 Unauthorized

What to check:

You are sending Authorization: Bearer <contact_center_api_key>.
Your Base URL includes the correct {cluster_id}.

403 Forbidden

What to check:

The API key is valid, but does not have access to this WhatsApp template.

404 Not found

This usually means the template ID does not exist, or you do not have access to it.

What to check:

Confirm the ID using Get list of WhatsApp templates.

Example response:

{ "error": "Not found" }

429 Too many requests

What to do:

Reduce request frequency and retry with backoff.