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/originate/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
  

  Note: Starting from WMS 6.02.20230306.1:

  • The max. number of characters was increased to 670. 
  • In case SMS sent via CURL contains the following characters, they are replaced with a space:  ' (single quote), “ (double quotes), \ (backslash), / (slash).
• 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"

To send SMS from Dialplan, apply the following configuration:

1. Set -> CURLOPT(userpwd) ->  101:sms101api (user credentials) - allows sending API request

2. 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: You need to specify GSM gateway's MAC address if the option Curl SMS send enabled in WMS Settings -> System -> FAX/ SMS server is activated since it has priority over GSM gateway:

   • Set(message=${CURL(http://127.0.0.1/api/v1/originate/sms, message=the messagebody&number=%2B33611121314&gsm=9c7514330001)});

   By adding MAC address, you can also select a specific GSM gateway if there are > 2 gateways.