Search
Close this search box.

< / >

APIs Reports Manager

1. Sending SMS message

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/sms.php?api=send_sms

Description:

Sending SMS message.

Benefit:

Allow sending a message quickly to a phone from external applications.

How it works:

  • Consuming this API is done through POST method.
  • In the json, parameters must be added according to the operation or process to be performed.
  • To consume this API, you must replace {{wolkvox_server}} in the URL with the server‘s nomenclature of the operation.
  • The wolkvoxtoken header must be used to make use of the authorization token.
  • Keep in mind that the same token cannot be consumed simultaneously, so you can program 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
telephone Destination phone number String
message Message to send 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/sms.php?api=send_sms',
  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 =>'{
    "telephone": "{{telephone}}",
    "message": "{{message}}"
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-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