Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

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 (WMS 56.0X/ 45.0X): use URL https://<pbx-host>/api/v1/doc/ (available only for admin user/ users with admin rights!)

Created: February 2018

Updated: June 2020December 2022

Permalink: https://wildix.atlassian.net/wiki/x/BRrOAQ

...

The POST/GET required parameters are:

  • message: the body SMS messages, length of no more than 300 characters

    Note

    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,...

...

  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

    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.


Note

Note:

  • "%2B" added to the mobile number is "+" character with URL encoding transformation. The full reference is available on the w3school web site.
  • In case SMS sent via CURL contains the following characters, they are replaced with a space:  ' (single quote), “ (double quotes), \ (backslash), / (slash).


Note

Note: the same way you can send SMS using http SMS server. For this purpose, another PBX with a configured GSM trunk can be used.

How to configure:

  1. Go to WMS Settings -> System -> FAX/SMS server
  2. Check off Curl SMS send enabled option and configure the sending. For example, curl -k -X POST -u user:password --url "http://PBX IP Address/api/v1/originate/sms" --data-urlencode "number={TO_NUMBER}" --data-urlencode "message={MESSAGE}" 
  3. When making SMS API request http(s)://<PBX_IP_Address>/api/v1/originate/sms via Custom application, use IP address of the PBX with a configured GSM trunk

...