fbpx

< / >

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.

NAMEDESCRIPTIONTYPE
connector_idRefers to the identifier number of the mobile whatsapp connector created for the line.String
telephoneThis is the cell phone number to which the message will be sent.String
messageThis is the text to be sent in the messageString

NAMEDESCRIPTIONTYPE
codeError codeInt
errorName of errorString
msgExplanation of errorString

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;
				
			

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "Message has been sent successfully"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data