SMS API allows any external software to use Wildix PBX as an SMS Server with the possibility of bulk (mass) SMS sending.
APIs Online Documentation: https://manuals.wildix.com/pbx-control-apis/
Created: February 2018
Permalink: https://confluence.wildix.com/x/WAY8AQ
Requirements:
- W01GSM provisioned to your PBX
- SIM card in the W01GSM able to send SMS
* Before try to send from the dialplan be sure that the SMS can be sent from WEB Collaboration
How to send SMS
Make an HTTP POST/GET request with basic authorization (username/ password of the user who is the SMS sender) to http(s)://<PBX_IP_Address>/api/v1/orginate/sms.
In case a GSM gateway to be used for SMS sending is not specified in the command, the message is sent to a randomly chosen GSM gateway configured in the system.
The timeout for mass sending is 5 sec for each SMS / gateway.
The POST/GET required parameters are
- message: the body SMS messages, length of no more than 300 characters
- number: the phone number or several numbers separated by a comma. Example: +391234567890 or +391234567890,+391234567891,+391234567892,...
The POST/GET optional parameters are
- postpone: date of postponed message delivery. Example: 14/07/2014 15:35
- gsm: GSM gateway MAC address. Example: 9c7514330001
The response of the service is
Success: {"type":"result","result":"Success"}
Warning: {"type":"warning","reason":"Unable to add a SMS to the queue","result":["111"]}
Error: {"type":"error","reason":"Number should not be empty","result":null}
The "reason" part is the description of the warning/error
To try the service, you can use the curl software and run it from the command line.
Here is the working example:
curl -k -X POST -u 101:sms101api --url "https://127.0.0.1/api/v1/originate/sms" --data-urlencode "number=+39123456789" --data-urlencode "message=This API is awesome, now I can add the sms support to my software" --data-urlencode "gsm=9c7514330001"
Example of Dialplan configuration
- Set -> CURLOPT(userpwd) -> 101:sms101api (admin credentials) - allows sending API request. You can use credentials of any user with admin rights
- Custom application -> Set(message=${CURL(http://127.0.0.1/api/v1/originate/sms, message=the message body&number=%2B39333123456)}); - SMS API is applied.
Note: "%2B" added to the mobile number is "+" character with URL encoding transformation. The full reference is available on the w3school web site.