The Get list of WhatsApp templates endpoint returns the WhatsApp message templates available in your contact center.

Requirements: Base URL, Authentication, Error codes

Scope: messaging.whatsapp_templates.read

What this does

When you send a Get list of WhatsApp templates request, Voiso returns a paginated list of WhatsApp template objects.

When to use it

Populate a template selector in an external system before sending WhatsApp template messages
Retrieve template IDs needed for WhatsApp template messaging
Audit which templates are available and which channel profiles can use them

Prerequisites

WhatsApp messaging must be configured for the contact center.
At least one WhatsApp template must exist for the contact center.

Endpoint


GET /api/v4/messaging/whatsapp_templates

Query parameters

All query parameters are optional.

limit
The number of items to return. Default is 100. Maximum is 100.
offset
The number of items to skip before starting to collect the result set. Default is 0.

Examples

Minimal request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/whatsapp_templates" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Request the third page of results (20 per page)

curl -X GET "https://{cluster_id}.voiso.com/api/v4/messaging/whatsapp_templates?limit=20&offset=40" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns an array of WhatsApp template objects and pagination metadata.

{
  "whatsapp_templates": [
    {
      "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)"
        }
      ]
    }
  ],
  "metadata": {
    "total": 100
  }
}

Notes

id is the template identifier (UUID) you use when sending a WhatsApp template message.
body can include placeholders such as {{1}}. Your application is responsible for substituting values before sending.
channel_profiles indicates which channel profiles can use 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 WhatsApp templates in this contact center.

429 Too many requests

What to do:

Reduce request frequency and retry with backoff.

200OK

400Bad Request

401Unauthorized

403Forbidden

429Too many requests