3. Official WhatsApp API for sending free messages - Wolkvox

< / >

APIs Billing

3. Official WhatsApp API for sending free messages

URL:

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

Description:

This API allows sending free messages through the WhatsApp Business line from an external application.

Benefit:

In case you need to send free messages that are only for notification or other subject and these are emitted from another platform, it is possible to perform this process with this API.

How it works:

For this API to work, it is essential to have previously consumed the API “2. Official WhatsApp API for sending HSM templates” and that the client has answered the first message.
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.
It should be noted that it can only be used after having previously initiated the conversation with the client and within 24 hours that the conversation is open.
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
message	This is the text to be sent in the message	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_message_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": "1",
    "telephone": "9319xxxxxxxx",
    "message": "it is a message"
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request POST 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=send_message_official' 
--header 'wolkvox-token: {{token}}' 
--header 'Content-Type: application/json' 
--data-raw '{
    "connector_id": "1",
    "telephone": "9319xxxxxxxx",
    "message": "it is a message"
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
    "connector_id": "255",
    "telephone": "9319xxxxxxxx",
    "message": "it is a message"
}');
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/whatsapp.php?api=send_message_official")
  .method("POST", body)
  .addHeader("wolkvox-token", "{{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_message_official"

payload = json.dumps({
  "connector_id": "255",
  "telephone": "9319xxxxxxxx",
  "message": "it is a message"
})
headers = {
  'wolkvox-token': '{{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

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