WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

COLOMBIA Medellín +57 (4) 322 98 80 Bogotá +57 (1) 381 90 40 Cali +57 (2) 891 28 46 Barranquilla +57 (5) 316 10 34 ARGENTINA Buenos Aires +54 (11) 5217 5933 SPAIN Madrid +34 (910) 601 691 MEXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 UNITED STATES New York +1 (914) 373 71 36 DOMINICAN REPUBLIC Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERU Lima +51 (1) 644 91 39

6. List templates -

< / >

APIs WhatsApp

6. List templates

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=list_templates

Description:

This API allows you to retrieve a list of all WhatsApp message templates associated with a specific WhatsApp connector integrated into your operation. It is essential for administrators and developers who need an overview of the available templates, their approval status, languages, and components.

Benefits:

Complete Template Visibility: Enables users and systems to obtain a comprehensive list of all WhatsApp templates linked to a specific connector, including approval status and content details.
Centralized Management: Facilitates auditing and managing WhatsApp templates directly from Wolkvox Manager, without needing to access the Meta Business Suite platform to check their existence or status.
Workflow Automation: Allows other applications or automated processes to check the availability and status of templates in order to automate message delivery or campaign management.
Campaign Optimization: By knowing the status of templates (APPROVED, PENDING, REJECTED), marketing teams can plan and execute their WhatsApp campaigns more efficiently.
Troubleshooting: Helps diagnose issues related to templates that are not being sent, by quickly checking their status and configuration.

How it works:

This API is consumed using the GET method.
To use this API, replace {{wolkvox_server}} in the URL with the corresponding server name for your operation.
The wolkvox-token header must be included to authorize the request using your token.
Keep in mind that a single token cannot be used for simultaneous requests. You should schedule the next API call only after the previous one has completed successfully.

API Limits:

Maximum records to download per request: 60,000
Maximum records to upload per request: 10,000
Maximum date range per query: 31 days
Maximum response size: 256 MB
API timeout limit: 60 seconds
Simultaneous requests per token: 2
Daily token usage limit: Number of licenses × 1,000 daily tokens

Code Examples:

In our Postman workspace ([click here] to access it), you have access to code examples that facilitate integration with our APIs in different programming languages such as cURL, Python, JavaScript, and more.

This feature is ideal for quick integrations and allows you to adapt the API calls to your system’s programming language.

How to Use the Code Examples:

Navigate to our Postman workspace.
Select the API you want to consult.
Edit the necessary API parameters according to your goals.
In the “Code” tab, select your preferred programming language.
You will get an auto-generated code snippet, ready to use with the parameters and authentication previously configured.

Request

NAME	DESCRIPTION	TYPE
connector_id	The identification number of the WhatsApp connector in your Wolkvox Manager operation from which you want to list the templates.	String

Response

NAME	DESCRIPTION	TYPE
code	Error code.	Int
error	Error name.	String
msg	Error explanation.	String
data	Object containing relevant upload data.	Object
meta_templates	An array of objects, where each object represents a WhatsApp template and its properties.	String
name	The unique name of the template.	String
previous_category	The previous category of the template, if it has been modified.	String
parameter_format	Format of the template parameters.	String
components	Array describing the sections of the template.	String
type	Component type (e.g., “HEADER”, “BODY”, “FOOTER”, “BUTTONS”).	String
format	Multimedia type if the header is multimedia (e.g., “IMAGE”, “DOCUMENT”, “VIDEO”).	String
example	Contains content examples, such as header_handle (sample multimedia file URLs) or body_text (examples for body variables).	String
text	The text content of the component.	String
buttons	Array of objects describing the buttons (type, text, URL, flow_id, flow_action, Maps_screen for flows). The supported button types in Wolkvox are “URL”, “QUICK_REPLY”, “PHONE_NUMBER”, and “FLOW”. Learn more about button types by clicking [here].	String
language	The language code of the template. It must be one of the languages supported by Meta (see the full list by clicking [here]).	String
status	The template’s status in Meta Business Suite. Possible values are: “APPROVED”: The template has been reviewed and approved, ready for use. “PENDING”: The template is under review. “REJECTED”: The template was not approved.	String
category	The category of the template (e.g., “UTILITY”, “MARKETING”, “AUTHENTICATION”).	String
sub_category	Template subcategory, if applicable (e.g., “CUSTOM”, “FORM”).	String
id	The unique ID of the template in Meta.	String
templateName	This field represents the template’s identifier name as managed internally in Wolkvox Manager. It functions as an alias or user-friendly name for the template within the Wolkvox ecosystem.	String
plantilla	This field contains the body text of the template message. It presents the full message text, including variables, in a more direct and consolidated way.	String

Possible Response Codes

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=list_templates',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS =>'{
    "connector_id": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff --request GET 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=list_templates' \
--header 'wolkvox-token: {{wolkvox-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "connector_id": ""
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"connector_id\": \"\"\r\n}");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=list_templates")
  .method("GET", body)
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

url = "https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=list_templates"

payload = json.dumps({
  "connector_id": ""
})
headers = {
  'wolkvox-token': '{{wolkvox-token}}',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "Templates listed successfully",
    "data": {
        "meta_templates": [
            {
                "name": "",
                "previous_category": "",
                "parameter_format": "POSITIONAL",
                "components": [
                    {
                        "type": "",
                        "text": ""
                    },
                    {
                        "type": "BUTTONS",
                        "buttons": [
                            {
                                "type": "URL",
                                "text": "",
                                "url": ""
                            }
                        ]
                    }
                ],
                "language": "",
                "status": "",
                "category": "",
                "id": ""
            }
        ]
    }
}

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND
ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

< / >

APIs WhatsApp

6. List templates

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

< / >

APIs WhatsApp

6. List templates

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

AUTOMATION AND
ARTIFICIAL INTELLIGENCE