v1

latestOpenAPI 3.0.22026-07-2432112226.7 KB
WhatsApp Templates

Get WhatsApp Templates V2

This method allows you to obtain the list of WhatsApp templates<br>

API Update Notice: This V2 endpoint is the recommended version, replacing the previous V1 endpoint. We recommend migrating to V2 immediately for a better experience.<br>

Benefits of V2:

  • Decreased processing time for API requests and responses
  • Improved features: Blocking Request, Spam Check, and Blocked Numbers
  • Increased RPS (from 30 RPS to 50 RPS)
  • Better developer environment to support future developments
  • Improved logging and monitoring
  • Improved dependencies and service stability<br>

A rate limit of 50 RPS is applied to WhatsApp services. Verihubs also applies rate limits divided into several categories based on product. For more details, see Rate Limit.

get/v2/whatsapp/template

Query parameters

pageinteger
limitinteger
template_namestring

Headers

App-IDstring required
API-Keystring required

Response

Successful Response

codeinteger

status code

statusinteger

status code

messagestring

message

total_recordsinteger

total amount of record

max_pageinteger

max page

Example response

{
  "code": 200,
  "status": 200,
  "message": "Templates are obtained",
  "data": {
    "id": "7bcf046b-6024-4ff3-b925-0e8b1524ed06",
    "name": "testing_tmp",
    "category_code": "ALERT_UPDATE",
    "lang_code": "en",
    "status": "NEW",
    "component": {
      "body": {
        "text": "Hello {{1}}! Thank you for your interest in our product. Currently we have {{2}} which are available for you to use.",
        "examples": [
          "Budi",
          "Veri Identity and Veri Check"
        ]
      },
      "header": {
        "format": "IMAGE",
        "examples": "https://storage.test.com/testfile"
      },
      "footer": {
        "text": "Please don't hesitate to contact us"
      },
      "button": {
        "buttons": {
          "type": "URL",
          "text": "View Products",
          "url": "https://verihubs.com"
        }
      }
    },
    "created_at": "2022-09-02T06:53:33.911321+00:00"
  },
  "total_records": 1,
  "max_page": 1
}