Integrations and APIs - Messaging APIs


CivicReady
®

C.A.P. 1.2 Messaging API

Overview

C.A.P. 1.2 Messaging API allows you to automatically trigger a notification via a valid C.A.P 1.2 message.

Instruction XML Format
   
API URL  https://regroup.com/groups/group-coded-name/api/v2/cap?api_key=NetworkAPIKEY

(You have to post the xml data to this URL, Content-Type must be 'application/xml’ and the submitmethod must be POST to make this work. This is a group specific URL.)
   
The C.A.P 1.2 Request must contain the headline, description and message endpoint tags to successfully post a notification.

The desired Group must already exist in the Regroup database to send a notification.
<alert xmlns="urn:oasis:names:tc:emergency:cap:1.2">
<identifier>xxxxxx</identifier>
<sender>sender-email@email.com</sender>
<sent>2016-03-09T16:41:28-06:00</sent>
<status>Actual</status>
<msgType>Alert</msgType>
<scope>Public</scope>
<info>
<language>en-US</language>
<category>Fire</category>
<event>Emergency</event>
<urgency>Immediate</urgency>
<severity>Severe</severity>
<certainty>Observed</certainty>
<senderName>Sender Name</senderName>
<headLine>Message Headline</headLine>
<description>test body</description>
<contact>Contact Information</contact>
<parameter>
<valueName>mail</valueName>
<value>1</value>
</parameter>
<parameter>
<valueName>sms</valueName>
<value>1</value>
</parameter>
<parameter>
<valueName>tts</valueName>
<value>1</value>
</parameter>
<parameter>
<valueName>fb</valueName>
<value>1</value>
</parameter>
</info>
</alert>
   
Headline - the Headline tag is required for all notifications including text and text to speech. Enter the desired subject line within this tag. (The Headline must be different each time you send a message) <headLine>CAP Message</headLine>
   
Description - the Description 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.  <description><![CDATA[CAP Message <b>description</b>.]]></description>
   
   
Messaging Endpoints - Within the info Tag we have added cusUSER_ID,12345,EMAIL_Name@regroup.edu parameters to designate which messaging endpoint will be triggered.

If a value other than 1 is included or the specific messaging end point tag is omitted, then that endpoint will not be triggered.
 
   
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.  <parameter>
<valueName>mail</valueName>
<value>1</value>
</parameter>
   
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.  <parameter>
<valueName>sms</valueName>
<value>1</value>
</parameter>
   
Text to Speech (TTS) - This tag is for sending outText 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.  <parameter>
<valueName>tts</valueName>
<value>1</value>
</parameter>
   
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.  <parameter>
<valueName>fb</valueName>
<value>1</value>
</parameter>



I'd Like to Request an Enhancement

0 out of 0 found this helpful

Updated:
Follow