2. WhatsApp API for sending templates - Wolkvox

< / >

APIs Customer

2. WhatsApp API for sending templates

URL:

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

Description:

API for sending mass campaigns through HSM templates

Benefit:

This API allows sending campaigns and mass messages through HSM templates previously approved by Meta, which correspond to a WhatsApp Business line or Cloud API, from an external application.

How it works:

The consumption of this API is done by POST method.
In the json the parameters are added according to the operation or process to be performed.
To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
The wolkvox-token header must be used to make use of the authorization token.
Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
Limit of records that can be downloaded per consumption: 60,000 records.
Limit of records that can be uploaded per consumption: 10,000 records.
Limit of days queried in dates: 31 days.
Limit of result weight: 256 MB.
API consumption time limit: 60 seconds.
Concurrent consumption limit of a token: 2 simultaneous requests.
Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME	DESCRIPTION	TYPE
connector_id	Refers to the identifier number of the mobile whatsapp connector created for the line.	String
telephone	This is the cell phone number to which the message will be sent.	String
template_name	Template name	String
template_vars	Variables	String
customer_id	Customer identification number	String
url_attach	Refers to the public URL where the image is hosted	String

Response

NAME	DESCRIPTION	TYPE
code	Error code	Int
error	Name of error	String
msg	Explanation of error	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=send_template_official',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "connector_id": "{{connector_id}}",
    "telephone": "{{telephone}}",
    "template_name": "{{template_name}}",
    "template_vars": "{{template_vars}}",
    "customer_id": "{{customer_id}}",
    "url_attach": "{{url_attach}}"
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=send_template_official' \
--header 'wolkvox_server: {{wolkvox_server}}' \
--header 'wolkvox-token: {{wolkvox-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "connector_id": "{{connector_id}}",
    "telephone": "{{telephone}}",
    "template_name": "{{template_name}}",
    "template_vars": "{{template_vars}}",
    "customer_id": "{{customer_id}}",
    "url_attach": "{{url_attach}}"
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"connector_id\": \"{{connector_id}}\",\r\n    \"telephone\": \"{{telephone}}\",\r\n    \"template_name\": \"{{template_name}}\",\r\n    \"template_vars\": \"{{template_vars}}\",\r\n    \"customer_id\": \"{{template_vars}}\",\r\n    \"url_attach\": \"{{url_attach}}\"\r\n}");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=send_template_official")
  .method("POST", body)
  .addHeader("wolkvox_server", "{{wolkvox_server}}")
  .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=send_template_official"

payload = json.dumps({
  "connector_id": "{{connector_id}}",
  "telephone": "{{telephone}}",
  "template_name": "{{template_name}}",
  "template_vars": "{{template_vars}}",
  "customer_id": "{{customer_id}}",
  "url_attach": "{{url_attach}}"
})
headers = {
  'wolkvox_server': '{{wolkvox_server}}',
  'wolkvox-token': '{{wolkvox-token}}',
  'Content-Type': 'application/json'
}

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

print(response.text)

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "Message has been sent successfully"
}

wolkvox
worldwide

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Sao Paulo +55 (11) 521 75 933

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

COLOMBIA

Medellín +57 (604) 322 98 80

GUATEMALA

Ciudad de Guatemala +502 (2) 3141344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

|

Information Transfer Policies

Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326

Nosotros

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

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

Information security policy

Information Transfer Policies

Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia