Skip to content

Setting up the link with SMS API providers

Abhiroop Bhatnagar edited this page Aug 17, 2013 · 2 revisions

Typically, you will need to configure the following from the Configuration Panel in order to set up the link with any SMS-forwarding API providers:

  • SMS Character Limit: Almost everywhere, it is 160.

  • Use SMS Keyword?: If you are using a shared shortcode, you will own a keyword on that shortcode. All SMS sent to that shortcode will be forwarded to your server only if they begin with that shortcode. If that is tha case, set this option to 'Yes'.

  • SMS Keyword: If the previous option is set at Yes, enter the SMS Keyword here.

  • SMS Response Format: This is the required format in which your server must return the response to the SMS API provider. By default, the XML response is set to be compatible with Twilio's API. You can edit the responses in the following files:

  • HTML : /templates/html/SMS.inc

  • XML : /templates/xml/SMS.inc

  • SMS Body Parameter: This corresponds to the GET/POST parameter which will contain the body of the SMS in the request the SMS API will make to this application.

  • SMS From Parameter: This corresponds to the GET/POST parameter which will contain the phone number of the sender of the SMS in the request the SMS API will make to this application.

  • Is API Key Required?: Some API providers will also provide you with an API key to verify that the incoming requests to your application are indeed from their API. If your API provider has provided you with an API Key with an API Key, set this to 'Yes'.

  • SMS API Key Parameter: The parameter which is supplied by the API provider. By default, it is set to the one provided by Twilio.

  • SMS API Key: The API Key provided by the API provider.

Link to Twilio Docs