Integrations and APIs - Messaging APIs


CivicReady
®

Text/SMS Messaging API

Overview

Text/SMS messaging API allows you to automatically trigger a Text/SMS notification to users who do or do not exist in CivicReady system.

Instruction XML Format
API URL   https://regroup.com/api/v2/smpp_alerts?api_key=NetworkAPIKEY
The SMS Request must contain the body and phone numbers to successfully post a notification.

The telephone numbers do not need to exist in the Regroup database to send a notification.
<?xml version="1.0"?>
<sms>
<body><![CDATA[SMS Api Test 001]]></body>
<phone>1XXXXXXXXXX</phone> 
</sms>
The TTS Request must contain the body, phone numbers and a caller ID to successfully post a notification.

The telephone numbers do not need to exist in the Regroup database to send a notification
<?xml version="1.0"?>
<tts>
<body><![CDATA[TTS Api Test 002]]></body>
<phone>1XXXXXXXXXX</phone>
<callerID> 14151234567</callerID>
</tts>
The SMS and TTS Request must contain the body, phone numbers and a caller ID to successfully post a notification.

The telephone numbers do not need to exist in the Regroup database to send a notification.
<?xml version="1.0"?>
<sms_tts>
<body><![CDATA[TTS and SMS Api Test 003]]></body>
<phone>1XXXXXXXXXX</phone>
<callerID> 14151234567</callerID>
</sms_tts>
Body - the body tag is required, this will be the body of all notifications.

You can also include HTML code within the body tag (HTML code will not play during a TTS transmission only the plain text wording. 
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
   
Phones - The phone tag is required. Multiple telephone numbers can be separated by a comma (,) <phone>1XXXXXXXXXX</phone>

 




I'd Like to Request an Enhancement

0 out of 0 found this helpful

Updated:
Follow