API DOCUMENTATION Last Update: Apr 2022

SMS Templates - Retrieve Information

Retrieves information about an existing SMS tempalte.

The data to be submitted to the API is composed of the following fields:


  field   Example   Note
API 1.5 Required
user_id john1970 Required
user_api_key 1959ca5645adac9b13dcb3 Required
account_id greatwidgets Required
type manage_sms_templates Required
action info Required
template_id 1 Required
Output Format:
output JSON or XML Optional. If not provided, defaults to XML
callback someFunctionName Optional: JSONP format
condensed yes Optional (No white space)
Applies only to JSON(P) output



Example PHP Request:

If you are using PHP, the $data array would look like this:

  1. $data['user_id'] = 'john1970';
  2. $data['user_password'] = '1959caadac9b13dcb3';
  3. $data['type'] = 'manage_sms_templates';
  4. $data['action'] = 'info';
  5. $data['account_id'] = 'greatwidgets';


Success XML Response

  1. <response status="success">
  2. <template>
  3. <account_id>greatwidgets</account_id>
  4. <template_id>2</template_id>
  5. <template_name>SMS Points Earned</template_name>
  6. <campaign_id>1111222233334444</campaign_id>
  7. <template_rule>record</template_rule>
  8. <sms_body>Congratulations! You have earned more points!</sms_body>
  9. <include_balance>Y</include_balance>
  10. </template>
  11. </response>

Error XML Response:

  1. <response status="error">
  2. <error>Error message</error>
  3. </response>