Integrations and APIs - Messaging APIs


CivicReady
®

Standard Messaging API

Overview

Standard Messaging API allows you to automatically trigger a notification to existing members within the CivicReady system. Notifications can be sent to groups as a whole as well as to one or more users.

Instruction XML Format        
           
API URL  https://regroup.com/api/v2/topics?api_key=NetworkAPIKEY        
           
  You have to post the xml data to this URL, Content-Type must be 'application/xml’ and the submit method must be POST to make this work.        
The XML Request must contain the subject, body, groupID tags and message endpoint tag to successfully post a notification.

The desired recipients must already exist in the Regroup database to receive a notification.
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<mail>1</mail>
<sms>1</sms>
<tts>1</tts>
<fb>1</fb>
<pn>1</pn>
<groupID>xxxxxx,yyyyyy</groupID>
</topic>
       
           
Subject - the subject tag is required for all notifications including text and text to speech. Enter the desired subject line within this tag. <subject>Enter your Subject line here</subject>        
           
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>        
           
Mail - This tag is for sending out email notifications.
If there is a value other than 1 or this tag is omitted, an email notification will not go out. 
<mail>1</mail>        
           
SMS - This tag is for sending out text/sms notifications.
If there is a value other than 1 or this tag is omitted, a text/sms notification will not go out. 
<sms>1</sms>        
           
Text to Speech (TTS) - This tag is for sending out Text to speech voice notifications.
If there is a value other than 1 or this tag is omitted, a TTS voice alert notification will not go out. 
<tts>1</tts>        
           
Facebook - This tag is for sending out Facebook notifications.
If there is a value other than 1 or this tag is omitted, a Facebook notification will not go out. 
<fb>1</fb>        
           
Push Notifications - This tag is for sending out push notifications for mobile applications.
If there is a value other than 1 or this tag is omitted, a Push Notification will not go out. 
<pn>1</pn>        
           
Recipient Identifier - In addition to the above tags you will need to include a Recipient Identifier to designate who will receive this notification.        
           
Group ID - Enter the group id of an existing group on your Regroup network. You can send to multiple groups by separating the group id's with a comma (,) <groupID>xxxxxx,yyyyyy</groupID>        
Database ID - Enter the database id of an existing user in your Regroup network. You can send to multiple users by separating the database id's with a comma (,) <databaseID>xxxxxx,yyyyyy</databaseID>        
Email - Enter the email address of an existing user in your Regroup network. You can send to multiple users by separating the email addresses with a comma (,) <email>xxxxxx,yyyyyy</email>        
Username - Enter the username of an existing user in your Regroup network. You can send to multiple users by separating the username's with a comma (,) <userID>xxxxxx,yyyyyy</userID>        
           
Email Customizable Options Tags          
           
fromName - Enter the Name, emails to be sent from. <fromName>NAME</fromName>        
fromEmail - Enter the Email, emails to be sent from. <fromEmail>email@domain.com</fromEmail>        
toName - Enter the Name, emails to be sent to. <toName>NAME</fromName>        
toEmail - Enter the Email, emails to be sent to. <toEmail>email@domain.com</toEmail>        
replyToText - Enter the reply to email, replies to be sent to. <replyText>email@domain.com</replyText>        
subjectPrefixText - Enter the Subject Prefix emails are sent. <subjectPrefixText>Subject Prefix Text</subjectPrefixText>        
footerText - Enter the footer Text, emails to be sent with. <footerText>Footer Text</footerText>        
Messaging Endpoints - You can send to one or more endpoints by including or omitting these tags.
The following examples will show sending to ALL endpoints and Each one individually.

You can have any combination of endpoints when submitting your request. 
       
  All SMS Only Text to Speech only Facebook Only Push Notifications Only
Messaging to one or more Groups <?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<mail>1</mail>
<sms>1</sms>
<tts>1</tts>
<fb>1</fb>
<pn>1</pn>
<groupID>xxxxxx,yyyyyy</groupID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<sms>1</sms>
<groupID>xxxxxx,yyyyyy</groupID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<tts>1</tts>
<groupID>xxxxxx,yyyyyy</groupID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<fb>1</fb>
<groupID>xxxxxx,yyyyyy</groupID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<pn>1</pnl>
<groupID>xxxxxx,yyyyyy</groupID>
</topic>
Messaging to one or more Database ID's <?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<mail>1</mail>
<sms>1</sms>
<tts>1</tts>
<fb>1</fb>
<pn>1</pn>
<databaseID>xxxxxx,yyyyyy</databaseID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<sms>1</sms>
<databaseID>xxxxxx,yyyyyy</databaseID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<tts>1</tts>
<databaseID>xxxxxx,yyyyyy</databaseID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<fb>1</fb>
<databaseID>xxxxxx,yyyyyy</databaseID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<pn>1</pn>
<databaseID>xxxxxx,yyyyyy</databaseID>
</topic>
Messaging to one or more Email addresses <?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<mail>1</mail>
<sms>1</sms>
<tts>1</tts>
<fb>1</fb>
<pn>1</pn>
<email>xxxxxx,yyyyyy</email>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<sms>1</sms>
<email>xxxxxx,yyyyyy</email>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<tts>1</tts>
<email>xxxxxx,yyyyyy</email>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<fb>1</fb>
<email>xxxxxx,yyyyyy</email>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<pn>1</pn>
<email>xxxxxx,yyyyyy</email>
</topic>
Messaging to one or more Usernames <?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<mail>1</mail>
<sms>1</sms>
<tts>1</tts>
<fb>1</fb>
<pn>1</pn>
<userID>xxxxxx,yyyyyy</userID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<sms>1</sms>
<userID>xxxxxx,yyyyyy</userID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<tts>1</tts>
<userID>xxxxxx,yyyyyy</userID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<fb>1</fb>
<userID>xxxxxx,yyyyyy</userID>
</topic>
<?xml version="1.0"?>
<topic>
<subject>Enter your Subject line here</subject>
<body><![CDATA[Enter the body of the message here, including HTML.]]></body>
<pn>1</pn>
<userID>xxxxxx,yyyyyy</userID>
</topic>



I'd Like to Request an Enhancement

0 out of 0 found this helpful

Updated:
Follow