Integrations and APIs


CivicReady
®

API Processing Requests List

Available Requests

 

 

Processing Rules

  1. Select which API will be activated by clicking the checkbox next to the API service you want to allow access.
  2. Enter all IPs you would like to grant access to that API service. You can enter one or more IP address by separating them with a comma (,).
    Note
    : If you leave the IP textbox empty all IPs anyone with the correct API key will be able to access this service.
    1.png
  3. The data will be processed according to current .csv processing rules Network/Group setting.
 
Membership Import  

First name tag - There can only be one first name. 

XML Format -

<firstName>User1</firstName>

JSON Format -

"firstName": "User1",

 Last name tag - There can only be one last name.
 
 

XML Format -

<lastName>TEST1</lastName>

 

JSON Format -

"lastName": "TEST1",

Email tag - One or more email addresses separated by a semicolon (;).
 

XML Format -

<email>user1test1@email.com</email> OR

<email>user1test1@email.com;user2test2@email.com</email>

 

JSON Format -

"email": "user1test1@email.com", OR

"email": "user1test1@email.com;user2test2@email.com"

 User ID tag - There can only be one user id per user.
 
 XML Format - 

<userID>user1test1</userID>

 JSON Format -

"userID": "user1test1",

Phone tag -
Several phone numbers can be added, separated by comma (,).
 XML Format - 

<phone>5551234567</phone> OR

<phone>5551234567;5551234568</phone>

JSON Format -

"phone": "5551234567", OR

"phone": "5551234567;5551234568",

To designate the carrier or service provider (optional)
 

XML Format - 

<phone>5551234567|att</phone>

JSON Format -

"phone": "5551234567|att"

To designate the type of messages the phone will receive

1 = text only
2 = voice only
3 = text and voice - the default setting

(optional - by default numbers entered with no message type will receive both text and voice alerts)

 

XML Format - 

<phone>5551234567||1</phone> OR

<phone>5551234567||2</phone> OR

<phone>5551234567||3</phone>

JSON Format -

"phone": "5551234567||1", OR

"phone": "5551234567||2", OR

"phone": "5551234567||3"

To designate the country code of the phone number

(numbers entered without a country code will default to a country code of 1)

 

XML Format - 

<phone>5551234567|||1</phone>

JSON Format -

"phone": "5551234567|||1"

To designate the type of phone the number is

  • home
  • work
  • cell
  • other

(by default numbers entered will be labeled as cell)

 

XML Format - 

<phone>5551234567||||home</phone> OR

<phone>5551234567||||work</phone> OR

<phone>5551234567||||cell</phone> OR

<phone>5551234567||||other</phone>

JSON Format -

"phone": "5551234567||||home", OR

"phone": "5551234567||||work", OR

"phone": "5551234567||||cell", OR,

"phone": "5551234567||||other"

You can include full or partial entries, all that is needed is a 10 digit phone number, the other fields are optional. 

XML Format - 

<phone>5551234567|sprint|2|1|cell</phone>

 JSON Format -

"phone": "5551234567|sprint|2|1|cell"

To delete a telephone number 
(if you are not including a database id)

 XML Format - 

<phone>1|5551234567</phone>

JSON Format -

"phone": "1|5551234567"

 Group ID tag - one or more group ID's separated by a semicolon (;).
XML Format - 

<groupID>xxxxxx</groupID> OR

<groupID>xxxxxx;xxxxxx</groupID>

JSON Format -

"groupID": "xxxxxx", OR

"groupID": "xxxxxx;yyyyyy"

To set the permission level for user on a group level - GroupID | permission level | message type | restrict emails

Permission levels

0 - remove admin permissions (set as a regular user)

1 - group admin

2 - network admin

3 - limited admin

4 - authorized sender

XML Format - 

<groupID>xxxxxx|0</groupID> OR

<groupID>xxxxxx|1</groupID> OR

<groupID>xxxxxx|2</groupID> OR

<groupID>xxxxxx|3</groupID> OR

<groupID>xxxxxx|4</groupID>

JSON Format -

"groupID": "xxxxxx|0", OR

"groupID": "xxxxxx|1", OR

"groupID": "xxxxxx|2", OR

"groupID": "xxxxxx|3", OR

"groupID": "xxxxxx|4"

To remove a user from specific groups

( you can remove a user from all groups included in the column with the remove code)
 

XML Format - 

<groupID>00002;xxxxxx;yyyyyy</groupID>

JSON Format -

"groupID": "00002;xxxxxx;yyyyyy"

To remove a user from a specific group, while adding them to other groups
 

XML Format - 

<groupID>xxxxxx|00002;xxxxxx;yyyyyy</groupID>

JSON Format -

"groupID": "xxxxxx|00002;xxxxxx;yyyyyy"

To remove a user from all groups on the network

( you can remove a user from all groups in one row, and add them to new groups in a second row)

 

XML Format - 

<groupID>00001</groupID>

JSON Format -

"groupID": "00001"

To delete a member from the system

XML Format - 

<groupID>00000</groupID>

 JSON Format -

"groupID": "00000"

To define the notification type like SMS or voice or both via xml/json import at the group level.

the number after 2nd | (pipe) is the notification type

1 - text

2 - voice

3 - both (default)

XML Format - 

<groupID>xxxxxx||1</groupID> OR

<groupID>xxxxxx||2</groupID> OR

<groupID>xxxxxx||3</groupID>

JSON Format -

"groupID": "xxxxxx||1", OR

"groupID": "xxxxxx||2", OR

"groupID": "xxxxxx||3"

To define the email digest frequency for each group the user belongs to via xml import

the number after 3rd | (pipe) is the digest frequency setting

1 - daily

2 - weekly

3 - monthly

XML Format - 

<groupID>xxxxxx|||1</groupID> OR

<groupID>xxxxxx|||2</groupID> OR

<groupID>xxxxxx|||3</groupID>

JSON Format -

"groupID": "xxxxxx|||1", OR

"groupID": "xxxxxx|||2", OR

"groupID": "xxxxxx|||3",

Database ID tag

You can have only one database id tag per user,

once entered this id becomes the unique identifier for the record in your network.

 

XML Format - 

<databaseID>User1Test1DB</databaseID>

JSON Format -

"databaseID": "User1Test1DB"

Address tag - To include Address to a user profile and Polygon (for CAD messaging) * poligon data should follow a ´|´(pipe).

XML Format -

<address> street address, city, state, zip</address>

JSON Format -

"address": "street address, city, state, zip"

Custom Fields tag - To Include Custom Fields to a user profile

XML Format - 

<customField>Custom Field 1|Custom Field 2|Custom Field 3|Custom Field 4|Custom Field 5</customField>

JSON Format -

"customField": "Custom Field 1|Custom Field 2|Custom Field 3|Custom Field 4|Custom Field 5"

location name  - To relate a user to a specific location

XML Format - 

<locationName>location-coded-name</locationName>

JSON Format -

"locationName": "location-coded-name"

Set a user to see all groups in the network (including secret group and groups, belonging to all locations) 

XML Format - 

<showAllGroups>1</showAllGroups>

JSON Format -

"showAllGroups": "1"

Group Creation and Management 
Name (mandatory) The name of the group (Group name can not contain more than 50 characters)

XML Format - 

<name>Group Name</name>

 

JSON Format -

"name":
"Group Name"

Coded Name (GET) - Coded name is generated by the system.

 
XML Format -

<codedName>group-name
</codedName>

JSON Format -

"codedName":
"group-name"

 Group Email (GET) - Group email is generated by the system.
 
 XML Format -

<email>networkname-group-name@
regroup.com
</email>

 JSON Format -

"email":
"networkname-group-name@regroup.com"

 Category tag (mandatory) - Enter the number for the desired Category.

1 - General
2 - Classifieds
3 - Class Year
4 - School Status
5 - Field of Study
6 - Residence
7 - Greek Association
8 - Club
9 - Course
10 - Sport
11 - Careers

12 - Emergency Alerts
13 - Schools/Colleges
14 - Branch locations
15 - Institutes & centers
16 - Offices & services
17 - Notification
18 - Publications

19 - Departments

20 - Location

21 - Parent

22 - Community

XML Format - 

<category>12</category>

 JSON Format -

"category": "12"

Group Type tag (mandatory) - Enter the number for the desired Group Type.

1 - Open Discussion

2 - Announcement-Only

3 - Moderated

XML Format - 

<type>2</type>

JSON Format -

"type": "2"

Group Privacy tag (mandatory) - Enter the number for the desired Group Privacy Type.

1 - Public

2 - Private

3 - Secret

XML Format - 

<privacy>1</privacy>

JSON Format -

"privacy": "1"

Description tag (mandatory) - User defined description of what the group is for. 

XML Format - 

<description>This is a group created via API </description>

 JSON Format -

"description": "
This is a group created via API"

Action tag - Enter the action you wish to perform.

  • Purge
  • Delete
  • Modify
     
 XML Format - 

<action>delete</action>

<action>purge</action>

<action>modify</action>

JSON Format -

"action": "delete",

"action": "purge",

"action": "modify"

Email in Restriction 

0 - allow only members of the group to send emails into the group

1 - allow public to send emails into the group

2 - restrict emails into the group

XML Format - 

<unrestrictEmails>1</unrestrictEmails>

 JSON Format -

"unrestrictEmails":
"1"

Default group Setting - New users are added automatically to the group.
 
XML Format - 

<defaultGroup>1</defaultGro
up>

 JSON Format -

"defaultGroup":
"1"

Digest tag - Set a group to sent a daily/weekly/monthly digest

0 - default

1 - daily

2 - weekly

3 - monthly

 XML Format - 

<digestEmails>0</digestEmails>

 JSON Format -

"digestEmails":
"0"

 Set CSV processing Style 

1 - normal

2 - active directory

3 - purge

XML Format - 

<csvProcessing>1</csvProcessing>

JSON Format -

"csvProcessing": "1"

Membership Count (GET) - Member count of the group

XML Format -

<membershipCounttype
="integer"

>
2
</membershipCount>

JSON Format -

"membershipCount"


:
 "2"


location Name- campus, group belongs to.

XML Format -

<locationName>campus-1
</locationName>


JSON Format -

"locationName":
 "location-1"


ShowRSSFeed - Shows Group Topics as the RSS feed.

0 - Disable

1 - Enable

 
XML Format -

<showRssFeed>1
</showRssFeed>


JSON Format -

"showRssFeed":
 "1"


Approval - Group requires admin to approve after being created.

0 - Approval not required

1 - Approval required

 
XML Format -

<approve>1
</approve>


JSON Format -

"approve":
 "1"


Messaging API

The XML/JSON Request must contain the subject, body, recipient ID tags and message endpoint tag to successfully post a notification.

The desired recipients must already exist in the regroup database to receive a notification.

https://regroup.com/api/v2/topics.?api_key=NetworkAPIKEY

https://regroup.com/api/v2/topics.json?api_key=NetworkAPIKEY

<subject> tag is required for all notifications including text and text to speech.

Enter the desired subject line within this tag.

XML Format -

<subject>Enter your Subject line here</subject>

JSON Format -

"subject": "Enter your Subject line here"

<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.

XML Format -

<body><![CDATA[Enter the body of the message here, including HTML.]]></body>

JSON Format -

"body": "![CDATA[Enter the body of the message here, including HTML.]]"

Messaging Endpoints

You can send to one or more endpoints by including or omitting these tags.

You can have any combination of endpoints when submitting your request.

If there is a value other than 1 in any Messaging Endpoints (mail,sms,tts,fb,pn) tags, that type of notification will not go out. 

 

<mail> tag is for sending out email notifications.

XML Format -

<mail>1</mail>

JSON Format -

"mail": "1"

<mail> tag is for sending out email notifications.

 
XML Format -

<sms>1</sms>

JSON Format -

"sms": "1"

<tts> tag is for sending out Text to Speech notifications.

 
XML Format -

<tts>1</tts>

JSON Format -

"tts": "1"

<fb> tag is for sending out Facebook notifications.

 
XML Format -

<fb>1</fb>

JSON Format -

"fb": "1"

<pn> tag is for sending out push notifications.

 
XML Format -

<pn>1</pn>

JSON Format -

"pn": "1"

Recipient Identifier 

In addition to the above tags you will need to include a Recipient Identifier to designate who will receive this notification.

You can send to multiple Recipients by separating the Recipient Identifier's with a comma (,)

  

Group ID - Enter the group id of an existing group on your regroup network.

XML Format -

<groupID>xxxxxx,yyyyyy</groupID>

JSON Format -

"groupID": "xxxxxx,yyyyyy"

Database ID - Enter the database id of an existing user in your regroup network.

 
XML Format -

<databaseID>xxxxxx,yyyyyy</databaseID>

JSON Format -

"databaseID": "xxxxxx,yyyyyy"

Email - Enter the email address of an existing user in your regroup network.

 
XML Format -

<email>xxxxxx,yyyyyy</email>

JSON Format -

"email": "xxxxxx,yyyyyy"

userID - Enter the userID of an existing user in your regroup network.

 
XML Format -

<userID>xxxxxx,yyyyyy</userID>

JSON Format -

"userID": "xxxxxx,yyyyyy"

fromName - Enter the Name, emails to be sent from.

 
XML Format -

<fromName>NAME</fromName>

JSON Format -

"fromName": "NAME"

fromEmail - Enter the Email, emails to be sent from.

 
XML Format -

<fromEmail>email@domain.com</fromNEmail>

JSON Format -

"fromEmail": "email@domain.com"

toName - Enter the Name, emails to be sent to.

 
XML Format -

<toName>NAME</toName>

JSON Format -

"toName": "NAME"

toEmail - Enter the Email, emails to be sent to.

 
XML Format -

<toEmail>email@domain.com</toEmail>

JSON Format -

"toEmail": "email@domain.com"

replyText - Enter the reply to email, replies to be sent to.

 
XML Format -

<replyText>email@domain.com</replyText>

JSON Format -

"replyText": "email@domain.com"

subjectPrefixText - Enter the Subject Prefix emails are sent.

 
XML Format -

<subjectPrefixText>Subject Prefix Text</subjectPrefixText>

JSON Format -

"subjectPrefixText": "Subject Prefix Text"

footerText - Enter the footer Text, emails to be sent with.

 
XML Format -

<footerText>Footer Text</footerText>

JSON Format -

"footerText": "Footer Text"

Text/SMS & Text to Speech Only API

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.

https://regroup.com/api/v2/smpp_alerts?api_key=NetworkAPIKEY

https://regroup.com/api/v2/smpp_alerts.json?api_key=NetworkAPIKEY

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.

XML Format -

<body><![CDATA[Enter the body of the message here, including HTML.]]></body>

JSON Format -

"body": "![CDATA[Enter the body of the message here, including HTML.]]"

Phone - The phone tag is required. Multiple telephone numbers can be separated by a comma (,)

XML Format -

<phone>1XXXXXXXXXX</phone>

JSON Format -

"phone": "1XXXXXXXXXX"

<callerID> tag is required to send out TTS messages

 
XML Format -

<callerID>14151234567</callerID>

JSON Format -

"callerID": "14151234567"

<sms> tag is for sending out text/sms notifications.

 
XML Format -

<sms>1</sms>

JSON Format -

"sms": "1"

<tts> tag is for sending out Text to speech voice notifications.

 
XML Format -

<tts>1</tts>

JSON Format -

"tts": "1"

Back to Top

 

 

Membership API

Messaging API Request URL

XML Format -
 

https://regroup.com/api/v2/topics?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/topics.json?api_key=NetworkAPIKEY

The XML Request must contain the subject, body, recipient ID tags and message endpoint tag to successfully post a notification.

 The desired recipients must already exist in the regroup database to receive a notification.

 

<subject> tag is required for all notifications including text and text to speech.

Enter the desired subject line within this tag.

XML Format -

<subject>Enter your Subject line here</subject>

 

JSON Format -

"subject": "Enter your Subject line here"

 

<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.

XML Format -

<body><![CDATA[Enter the body of the message here, including HTML.]]></body>

 

JSON Format -

"body": "![CDATA[Enter the body of the message here, including HTML.]]"

If there is a value other than 1 in any Messaging Endpoints (mail,sms,tts,fb,pn) tags, that type of notification will not go out. 

<mail> tag is for sending out email notifications.

XML Format -

<mail>1</mail>

JSON Format -

"mail": "1"

<sms> tag is for sending out text/sms notifications.

XML Format -

<sms>1</sms>

JSON Format -

"sms": "1"

<tts> tag is for sending out Text to speech voice notifications.

XML Format -

<tts>1</tts>

JSON Format -

"tts": "1"

<fb> tag is for sending out Facebook notifications.

XML Format -

<fb>1</fb>

JSON Format -

"fb": "1"

<pn> tag is for sending out push notifications for mobile applications.

XML Format -

<pn>1</pn>

JSON Format -

"pn": "1"

Recipient Identifier 

In addition to the above tags you will need to include a Recipient Identifier to designate who will receive this notification.

You can send to multiple Recipients by separating the Recipient Identifier's with a comma (,)

Group ID - Enter the group id of an existing group on your regroup network.

XML Format -

<groupID>xxxxxx,yyyyyy</groupID>

JSON Format -

"groupID": "xxxxxx,yyyyyy"

Database ID - Enter the database id of an existing user in your regroup network.

XML Format -

<databaseID>xxxxxx,yyyyyy</databaseID>

JSON Format -

"databaseID": "xxxxxx,yyyyyy"

Email - Enter the email address of an existing user in your regroup network.

XML Format -

<email>xxxxxx,yyyyyy</email>

JSON Format -

"email": "xxxxxx,yyyyyy"

userID - Enter the userID of an existing user in your regroup network.

XML Format -

<userID>xxxxxx,yyyyyy</userID>

JSON Format -

"userID": "xxxxxx,yyyyyy"

fromName - Enter the Name, emails to be sent from.

XML Format -

<fromName>NAME</fromName>

JSON Format -

"fromName": "NAME"

fromEmail - Enter the Email, emails to be sent from.

XML Format -

<fromEmail>email@domain.com</fromEmail>

JSON Format -

"fromEmail": "email@domain.com"

toName - Enter the Name, emails to be sent to.

XML Format -

<toName>NAME</fromName>

JSON Format -

"toName": "NAME"

toEmail - Enter the Email, emails to be sent to.

XML Format -

<toEmail>email@domain.com</toEmail>

JSON Format -

"toEmail": "email@domain.com"

replyText - Enter the reply to email, replies to be sent to.

XML Format -

<replyText>email@domain.com</replyText>

JSON Format -

"replyText": "email@domain.com"

subjectPrefixText - Enter the Subject Prefix emails are sent.  

XML Format -

<subjectPrefixText>Subject Prefix Text</subjectPrefixText>

JSON Format -

"subjectPrefixText": "Subject Prefix Text"

footerText - Enter the footer Text, emails to be sent with.  

XML Format -

<footerText>Footer Text</footerText>

JSON Format -

"footerText": "Footer Text"

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.

You can have any combination of endpoints when submitting your request.

Messaging to one or more Groups

XML Format -

<?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> 

JSON Format -

{
"topic": {
"subject": "Enter your Subject line here",
"body": "![CDATA[Enter the body of the message here, including HTML.]]",
"mail": "1",
"sms": "1",
"tts": "1",
"fb": "1",
"pn": "1",
"groupID": "xxxxxx,yyyyyy"
}
}

Messaging to one or more Database ID's

XML Format -

<?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> 

 

JSON Format -

{
"topic": {
"subject": "Enter your Subject line here",
"body": "![CDATA[Enter the body of the message here, including HTML.]]",
"mail": "1",
"sms": "1",
"tts": "1",
"fb": "1",
"pn": "1",
"databaseID": "xxxxxx,yyyyyy"
}
}

Messaging to one or more Email addresses

XML Format -

<?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> 

 

JSON Format -

{
"topic": {
"subject": "Enter your Subject line here",
"body": "![CDATA[Enter the body of the message here, including HTML.]]",
"mail": "1",
"sms": "1",
"tts": "1",
"fb": "1",
"pn": "1",
"email": "xxxxxx,yyyyyy"
}
}

Messaging to one or more userIDs

XML Format -

<?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> 

 

JSON Format -

{
"topic": {
"subject": "Enter your Subject line here",
"body": "![CDATA[Enter the body of the message here, including HTML.]]",
"mail": "1",
"sms": "1",
"tts": "1",
"fb": "1",
"pn": "1",
"userID": "xxxxxx,yyyyyy"
}
}

Messaging using custom email options.

XML Format -

<?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>

<email>xxxxxx,yyyyyy</email>

<fromName>NAME</fromName>

<fromEmail>email@domain.com</fromEmail>

<toName>NAME</toName>

<toEmail>email@domain.com</toEmail>

<replyText>email@domain.com</replyText>

<subjectPrefixText>Subject Prefix Text</subjectPrefixText>

<footerText>Footer Text</footerText>

</topic>

 

JSON Format -

{
"topic":
"subject": "Enter your Subject line here"
"body": "![CDATA[Enter the body of the message here, including HTML.]]"
"mail": "1"
"email": "xxxxxx,yyyyyy"
"fromName": "NAME"
"fromEmail": "email@domain.com"
"toName": "NAME"
"toEmail": "email@domain.com"
"replyText": "email@domain.com"
"subjectPrefixText": "Subject Prefix Text"
"footerText": "Footer Text"
}
}

Display a particular topic in a group via RSS feed

XML Format -

<?xml version="1.0"?>

<topic>
<subject>Subject</subject>
<body><![CDATA[test message ]]></body>
<groupID>XXXXXX</groupID>
<showOnRss>1</showOnRss>
</topic>

 

JSON Format -

{
"topic": {
"subject": "Subject ",
"body": "![CDATA[test message ]]",
"groupID": "XXXXXX",
"showOnRss": "1"
}
}

Back to Top

 

Messaging API

Messaging API Request URL

XML Format -
 

https://regroup.com/api/v2/topics?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/topics.json?api_key=NetworkAPIKEY

The XML Request must contain the subject, body, recipient ID tags and message endpoint tag to successfully post a notification.

 The desired recipients must already exist in the regroup database to receive a notification.

 

<subject> tag is required for all notifications including text and text to speech.

Enter the desired subject line within this tag.

XML Format -

<subject>Enter your Subject line here</subject>

 

JSON Format -

"subject": "Enter your Subject line here"

 

<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.

XML Format -

<body><![CDATA[Enter the body of the message here, including HTML.]]></body>

 

JSON Format -

"body": "![CDATA[Enter the body of the message here, including HTML.]]"

If there is a value other than 1 in any Messaging Endpoints (mail,sms,tts,fb,pn) tags, that type of notification will not go out. 

<mail> tag is for sending out email notifications.

XML Format -

<mail>1</mail>

JSON Format -

"mail": "1"

<sms> tag is for sending out text/sms notifications.

XML Format -

<sms>1</sms>

JSON Format -

"sms": "1"

<tts> tag is for sending out Text to speech voice notifications.

XML Format -

<tts>1</tts>

JSON Format -

"tts": "1"

<fb> tag is for sending out Facebook notifications.

XML Format -

<fb>1</fb>

JSON Format -

"fb": "1"

<pn> tag is for sending out push notifications for mobile applications.

XML Format -

<pn>1</pn>

JSON Format -

"pn": "1"

Recipient Identifier 

In addition to the above tags you will need to include a Recipient Identifier to designate who will receive this notification.

You can send to multiple Recipients by separating the Recipient Identifier's with a comma (,)

Group ID - Enter the group id of an existing group on your regroup network.

XML Format -

<groupID>xxxxxx,yyyyyy</groupID>

JSON Format -

"groupID": "xxxxxx,yyyyyy"

Database ID - Enter the database id of an existing user in your regroup network.

XML Format -

<databaseID>xxxxxx,yyyyyy</databaseID>

JSON Format -

"databaseID": "xxxxxx,yyyyyy"

Email - Enter the email address of an existing user in your regroup network.

XML Format -

<email>xxxxxx,yyyyyy</email>

JSON Format -

"email": "xxxxxx,yyyyyy"

userID - Enter the userID of an existing user in your regroup network.

XML Format -

<userID>xxxxxx,yyyyyy</userID>

JSON Format -

"userID": "xxxxxx,yyyyyy"

fromName - Enter the Name, emails to be sent from.

XML Format -

<fromName>NAME</fromName>

JSON Format -

"fromName": "NAME"

fromEmail - Enter the Email, emails to be sent from.

XML Format -

<fromEmail>email@domain.com</fromEmail>

JSON Format -

"fromEmail": "email@domain.com"

toName - Enter the Name, emails to be sent to.

XML Format -

<toName>NAME</fromName>

JSON Format -

"toName": "NAME"

toEmail - Enter the Email, emails to be sent to.

XML Format -

<toEmail>email@domain.com</toEmail>

JSON Format -

"toEmail": "email@domain.com"

replyText - Enter the reply to email, replies to be sent to.

XML Format -

<replyText>email@domain.com</replyText>

JSON Format -

"replyText": "email@domain.com"

subjectPrefixText - Enter the Subject Prefix emails are sent.  

XML Format -

<subjectPrefixText>Subject Prefix Text</subjectPrefixText>

JSON Format -

"subjectPrefixText": "Subject Prefix Text"

footerText - Enter the footer Text, emails to be sent with.  

XML Format -

<footerText>Footer Text</footerText>

JSON Format -

"footerText": "Footer Text"

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.

You can have any combination of endpoints when submitting your request.

Messaging to one or more Groups

XML Format -

<?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> 

JSON Format -

{
"topic": {
"subject": "Enter your Subject line here",
"body": "![CDATA[Enter the body of the message here, including HTML.]]",
"mail": "1",
"sms": "1",
"tts": "1",
"fb": "1",
"pn": "1",
"groupID": "xxxxxx,yyyyyy"
}
}

Messaging to one or more Database ID's

XML Format -

<?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> 

 

JSON Format -

{
"topic": {
"subject": "Enter your Subject line here",
"body": "![CDATA[Enter the body of the message here, including HTML.]]",
"mail": "1",
"sms": "1",
"tts": "1",
"fb": "1",
"pn": "1",
"databaseID": "xxxxxx,yyyyyy"
}
}

Messaging to one or more Email addresses

XML Format -

<?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> 

 

JSON Format -

{
"topic": {
"subject": "Enter your Subject line here",
"body": "![CDATA[Enter the body of the message here, including HTML.]]",
"mail": "1",
"sms": "1",
"tts": "1",
"fb": "1",
"pn": "1",
"email": "xxxxxx,yyyyyy"
}
}

Messaging to one or more userIDs

XML Format -

<?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> 

 

JSON Format -

{
"topic": {
"subject": "Enter your Subject line here",
"body": "![CDATA[Enter the body of the message here, including HTML.]]",
"mail": "1",
"sms": "1",
"tts": "1",
"fb": "1",
"pn": "1",
"userID": "xxxxxx,yyyyyy"
}
}

Messaging using custom email options.

XML Format -

<?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>

<email>xxxxxx,yyyyyy</email>

<fromName>NAME</fromName>

<fromEmail>email@domain.com</fromEmail>

<toName>NAME</toName>

<toEmail>email@domain.com</toEmail>

<replyText>email@domain.com</replyText>

<subjectPrefixText>Subject Prefix Text</subjectPrefixText>

<footerText>Footer Text</footerText>

</topic>

 

JSON Format -

{
"topic":
"subject": "Enter your Subject line here"
"body": "![CDATA[Enter the body of the message here, including HTML.]]"
"mail": "1"
"email": "xxxxxx,yyyyyy"
"fromName": "NAME"
"fromEmail": "email@domain.com"
"toName": "NAME"
"toEmail": "email@domain.com"
"replyText": "email@domain.com"
"subjectPrefixText": "Subject Prefix Text"
"footerText": "Footer Text"
}
}

Display a particular topic in a group via RSS feed

XML Format -

<?xml version="1.0"?>

<topic>
<subject>Subject</subject>
<body><![CDATA[test message ]]></body>
<groupID>XXXXXX</groupID>
<showOnRss>1</showOnRss>
</topic>

 

JSON Format -

{
"topic": {
"subject": "Subject ",
"body": "![CDATA[test message ]]",
"groupID": "XXXXXX",
"showOnRss": "1"
}
}

Back to Top

 

C.A.P Messaging API

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.

GET API XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/cap?api_key=NetworkAPIKey

POST API

XML Format -

https://regroup.com/groups/group-coded-name/api/v2/cap?api_key=NetworkAPIKey

<alert xmlns="urn:oasis:names:tc:emergency:cap:1.2">

<identifier>1314803</identifier>

<sender>ExistingUser1@gold.edu</sender>

<sent>2014-09-23T12:37:21-05: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>ExistingUserID</senderName>

<headLine>CAP Message</headLine>

<description><![CDATA[CAP Message <b>description</b>.]]></description>

<contact>Contact Information</contact>

</info>

</alert>

 

 

 

Messaging Endpoints 

Within the info Tag we have added mail,sms,tts, fb 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> tag is for sending out email notifications.

 

XML Format -

<parameter>

<valueName>mail</valueName>

<value>1</value>

</parameter>

<sms> tag is for sending out text/sms notifications.

 

XML Format -

<parameter>

<valueName>sms</valueName>

<value>1</value>

</parameter>

<tts> tag is for sending outText to speech voice notifications.

 XML Format -

<parameter>

<valueName>tts</valueName>

<value>1</value>

</parameter>

<fb> tag is for sending out Facebook notifications.

 XML Format -

<parameter>

<valueName>fb</valueName>

<value>1</value>

</parameter>

Back to Top

 

Group Management API

Groups API Request URL

XML Format -

https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/groups.json?api_key=NetworkAPIKEY

You have to post xml/json data to this url, Content-Type must be 'application/xml(json)' and submit method must be POST to make this work.


There must be at least one group tag under groups tag and there is no max limit on number of group tags. Data will be processed according to our current csv rules.

Group Membership (GET)
Fetching the members of the Group

XML Format -

https://regroup.com/groups/group-coded-name/api/v2/users?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/users.json?api_key=NetworkAPIKEY

Fetch Default Groups

XML Format -

https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY&defaultGroup=true

JSON Format -

https://regroup.com/api/v2/groups.json?api_key=NetworkAPIKEY&defaultGroup=true

Fetch a Group by category

XML Format -

https://regroup.com/api/v2/groups?api_key=NetworkAPIKEY&categoryID=2

JSON Format -

https://regroup.com/api/v2/groups.json?api_key=NetworkAPIKEY&categoryID=2

Create and Manage Groups (POST)

Following tags are mandatory for group creation:

  • <name> The name of the group. The group name can be 50 characters or less.
  • <category> Enter the number for the desired Category.

    1 - General
    2 - Classifieds
    3 - Class Year
    4 - School Status
    5 - Field of Study
    6 - Residence
    7 - Greek Association
    8 - Club
    9 - Course
    10 - Sport
    11 - Careers
    12 - Emergency Alerts
    13 - Schools/Colleges
    14 - Branch locations
    15 - Institutes & centers
    16 - Offices & services
    17 - Notifications
    18 - Publications

  • <type> Enter the number for the desired Group Type.

    1 - Open Discussion
    2 - Announcement-Only
    3 - Moderated

  • <privacy> Enter the number for the desired Group Privacy Type.

    1 - Public
    2 - Private
    3 - Secret

  • <description>User defined description. The description can be 50 characters or less.

Creating Group

XML Format -

 <?xml version="1.0" encoding="UTF-8"?>

<groups type="array">

<group>

<name>API Created 1</name>

<category>12</category>

<type>1</type>

<privacy>1</privacy>

<description>This is test group 1 created via API </description>

</group>

<group>

<name>API Created 2</name>

<category>1</category>

<type>1</type>

<privacy>2</privacy>

<description>This is test group 2 created via API</description>

<unrestrictEmails>0</unrestrictEmails>

</group>

</groups>

JSON Format -

{

"groups": [

{

"name": "
API Created 1
",

"category": "
12
",

"type": "
1
",

"privacy": "
1
",

"description": "
This is test group 1 created via API JSON
",

"unrestrictEmails": "
1
"

}

{

"name": "
API Created 2
",

"category":
"
1
",

"type":
"
1
",

"privacy":
"
2
",

"description": "
This is test group 2 created via API JSON "
,

"unrestrictEmails": "
0
"

}

]

}

<action> and <name> tags are mandatory for following  requests
Purge group 

<action> purge </action> will remove all non admin members of the group.

 

XML Format -

<?xml version="1.0" encoding="UTF-8"?>

<groups type="array">

<group>

<action>purge</action>

<name>API Test group 1</name>

</group>

</groups>

JSON Format - 

{
"groups": [
{
"action": "purge",
"name": "API Test group 1"
}
]
}

Delete group

<action>delete</action> will delete specific group.

XML Format -

<?xml version="1.0" encoding="UTF-8"?>

<groups type="array">

<group>

<action>
delete
</action>

<name>
API Test group 1
</name>

</group>

</groups>

JSON Format -

{
"groups": [
{
"action": "delete",
"name": "API Test group 1"
}
]
}

Modify group

<action> modify </action> will modify the group's information.( category, type, privacy, description etc).

XML Format -

<?xml version="1.0" encoding="UTF-8"?>

<groups type="array">

<group>

<action>
modify
</action>

<name>
API Test group 2
</name>

<category>
12
</category>

<type>
3
</type>

<privacy>
1
</privacy>

<description>
This is test group created via API that has been modified
</description>
<unrestrictEmails>1</unrestrictEmails>
<digestEmails>1</digestEmails>
<csvProcessing>1</csvProcessing>

</group>

</groups>

JSON Format -

{

"groups": [

{

"name": "API Created 1",

"category": "12",

"type": "3",

"privacy": "1",

"description": "This is test group 1 created via API that has been modified JSON ",

"unrestrictEmails": "1",

"digestEmails": "1",

"csvProcessing": "1"

}

]

}

 Un-Restrict emails
0 - allow only members of the group to send emails into the group
1 - allow public to send emails into the group
2 - restrict emails into the group

XML Format -

<?xml version="1.0" encoding="UTF-8"?>

<groups type="array">

<group>

<name>
API Test group
</name>

<category>
1
</category>

<type>
3
</type>

<privacy>
3
</privacy>

<description>
This is test group 1
</description>

<unrestrictEmails>
1
</unrestrictEmails>

</group>

</groups>

 

JSON Format -

{

"groups": [

{

"name": "API Created 1",

"category": "1",

"type": "3",

"privacy": "3",

"description": "This is test group 1 JSON ",

"unrestrictEmails": "1"

}

]

}

Set email digest preferences for a group

1 - daily

2 - weekly

3 - monthly

XML Format -

<?xml version="1.0" encoding="UTF-8"?>

<groups type="array">

<group>

<name>
API Test group 1
</name>

<category>
1
</category>

<type>
3
</type>

<privacy>
3
</privacy>

<description>
This is test group 1
</description>

<digestEmails>
1
</digestEmails>

</group>

</groups>

JSON Format -

{

"groups": [

{

"name": "API Test group 1",

"category": "1",

"type": "3",

"privacy": "3",

"description": "This is test group 1 JSON ",

"digestEmails": "1"

}

]

}

Set group as Default

New processed users are added automatically to the group.

XML Format -

<?xml version="1.0" encoding="UTF-8"?>
<groups type="array">
<group>
<name>API Test group</name>
<category>1</category>
<type>3</type>
<privacy>3</privacy>
<description>This is test group 1</description>
<defaultGroup>1</defaultGroup>
</group>
</groups>

JSON Format -

{
"groups": [
{
"name": "API Created 1",
"category": "1",
"type": "3",
"privacy": "3",
"description": "This is test group 1 JSON ",
"defaultGroup": "1"
}
]
}

Set the CSV Processing for a group

1 - normal processing ( Group members will not be replaced via csv)
2 - active roster processing ( Replace the users in our group with only what we send you in the .csv. )
3 - purge processing ( Replace the users and user's information in the group with only what we send you in the .csv. )

XML Format -

<?xml version="1.0" encoding="UTF-8"?>

<groups type="array">

<group>

<name>
API Test group
</name>

<category>
1
</category>

<type>
3
</type>

<privacy>
3
</privacy>

<description>
This is test group 1
</description>

<csvProcessing>
1
</csvProcessing>

</group>

</groups>

JSON Format -

{

"groups": [

{

"name": "API Created 1",

"category": "1",

"type": "3",

"privacy": "3",

"description": "This is test group 1 JSON ",

"csvProcessing": "1"

}

]

}

Relate a group to a specific location.<locationName>location-coded-name</locationName> tag will link the group to a specific location.

XML Format -

<?xml version="1.0" encoding="UTF-8"?>
<groups type="array">
<group>
<name>API Test group</name>
<category>1</category>
<type>3</type>
<privacy>3</privacy>
<description>This is test group 1</description>
<locationName>location-1</locationName>
</group>
</groups>

JSON Format -

{

"groups": [

{

"name": "API Created 1",

"category": "1",

"type": "3",

"privacy": "3",

"description": "This is test group 1 JSON ",

"locationName": "location-1"

}

]

}

Show all topics of a group to display on RSS feed

XML Format -

<?xml version="1.0" encoding="UTF-8"?>
<groups type="array">
<group>
<name>API Created 1</name>
<category>12</category>
<type>1</type>
<privacy>1</privacy>
<description>This is test group created via API </description>
<showTopicsRss>1</showTopicsRss>
</group>
</groups>

 

JSON Format -

{

"groups": [

{

"name": "API Created 1",

"category": "12",

"type": "1",

"privacy": "1",

"description": "This is test group created via API JSON ",

"showTopicsRss": "1"

}

]

}

Back to Top

 

Text/SMS & Voice Only API

SMS & Text to Speech API

XML Format -

https://regroup.com/api/v2/smpp_alerts?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/smpp_alerts.json?api_key=NetworkAPIKEY

The telephone numbers do not need to exist in the regroup database to send a notification.

<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. )

XML Format -

<body><![CDATA[Enter the body of the message here, including HTML.]]></body>

 

JSON Format -

"body": "![CDATA[Enter the body of the message here, including HTML.]]"

<phone> tag is required.

Multiple telephone numbers can be separated by a comma (,)

XML Format -

<phone>1XXXXXXXXXX</phone>

 

JSON Format -

"phone": "1XXXXXXXXXX"

The SMS Request must contain the body and phone numbers to successfully post a notification.
 

XML Format -

<?xml version="1.0"?>

<sms>

<body><![CDATA[SMS Api Test 001]]></body>

<phone>1XXXXXXXXXX</phone>

</sms>

JSON Format -

{

"sms": {

"body": "![CDATA[SMS Api Test 001]]",

"phone": "1XXXXXXXXXX"

}

}

 

The TTS Request must contain the body, phone numbers and a caller ID to successfully post a notification.

XML Format -

<?xml version="1.0"?>

<tts>

<body><![CDATA[TTS Api Test 002]]></body>

<phone>1XXXXXXXXXX</phone>

<callerID>1CallerIDphonenumber</callerID>

</tts>

JSON Format -

{
"tts": {
"body": "
![CDATA[TTS Api Test 002]]",
"phone": "
1XXXXXXXXXX",
"callerID": "
1CallerIDphonenumber"
}
}

The SMS and TTS Request must contain the body, phone numbers and a caller ID to successfully post a notification.

XML Format -

<?xml version="1.0"?>

<sms_tts>

<body><![CDATA[TTS and SMS Api Test 003]]></body>

<phone>1XXXXXXXXXX</phone>

<callerID>1CallerIDphonenumber</callerID>

</sms_tts>

JSON Format -

{
"sms_tts": {
"body": "![CDATA[TTS and SMS Api Test 003]]",
"phone": "1XXXXXXXXXX",
"callerID": "1CallerIDphonenumber"
}
}

Back to Top

 

Phone Numbers API

Phone API Request URL

XML Format - 

https://regroup.com/api/v2/phone_numbers?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/phone_numbers.json?api_key=NetworkAPIKEY

To add a new phone number

For <userID> you can use user id, external database ID or email.

It will work for all three...

XML Format -  

<phone_numbers type="array">

<phone_number>

<action>add</action>

<phone>5551234501</phone>

<countryCode>1</countryCode>

<userID>user1test1</userID>

</phone_number>

</phone_numbers>

JSON Format - 

{

"phone_numbers":[


{

"action": "add",

"phone": "5551234501",

"countryCode": "1",

"userID": "user1test1"

}

]

}

To Delete the phone number

For <userID> you can use user id, external database ID or email.

It will work for all three...

 

XML Format - 

<phone_numbers type="array">
<phone_number>
<action>delete</action>
<phone>5551234502</phone>
<userID>user2test2</userID>
</phone_number>
</phone_numbers>

 

JSON Format - 

{

"phone_numbers":[


{

"action": "delete",

"phone": "5551234502",

"countryCode": "1",

"userID": "user2test2"

}

]

}

Fetch Members by Specific Phone Number  

XML Format - 

https://regroup.com/api/v2/phone_numbers?api_key=NetworkAPIKEY&phone=15551234500

JSON Format -

https://regroup.com/api/v2/phone_numbers.json?api_key=NetworkAPIKEY&phone=15551234500

Back to Top

 

Group Unsubscriptions API

Fetch all unsubscribed members at network level

XML Format - 

https://regroup.com/api/v2/group_unsubscriptions?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/group_unsubscriptions.json?api_key=NetworkAPIKEY

 

Fetch all unsubscribed members by group using group id   

XML Format - 

https://regroup.com/api/v2/group_unsubscriptions?api_key=NetworkAPIKEY&groupID=GROUPID1

JSON Format -

https://regroup.com/api/v2/group_unsubscriptions.json?api_key=NetworkAPIKEY&groupID=GROUPID1

Fetch all unsubscribed members by group using multiple group ids   

XML Format - 

https://regroup.com/api/v2/group_unsubscriptions?api_key=NetworkAPIKEY&groupID=GROUPID1, GROUPID2

JSON Format -

https://regroup.com/api/v2/group_unsubscriptions.json?api_key=NetworkAPIKEY&groupID=GROUPID1, GROUPID2

Back to Top

 

Pending Topic Requests API

Group pending requests API Request URL

XML Format -

https://regroup.com/api/v2/pending_topic_requests?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/pending_topic_requests.json?api_key=NetworkAPIKEY

To approve/reject pending topic requests

XML Format -

<?xml version="1.0" encoding="UTF-8"?>

<pending_topic_requests type="array">

<topic_request>

<topicID>test-message-header</topicID>

<groupID>XXXXXX</groupID>

<action>approve</action>

</topic_request>

<topic_request>

<topicID>test-message-header</topicID>

<groupID>XXXXXX</groupID>

<action>reject</action>

</topic_request>

</pending_topic_requests> 

 

JSON Format -

{

"pending_topic_requests":[

{

"topicID": "test-message-header",

"groupID": "XXXXXX",

"action": "approve"

},

{

"topicID": "test-message-header",

"groupID": "XXXXXX",

"action": "reject"

}

]

}

Back to Top

 

Group Membership Requests API

Group pending requests API Request URL

XML Format -

https://regroup.com/api/v2/group_membership_requests?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/group_membership_requests.json?api_key=NetworkAPIKEY

To approve/reject pending group membership requests using email 

XML Format -

<group_membership_requests type="array">

<membership_request>

<email>User1Test1@email.com</email>

<groupID>XXXXXX</groupID>

<action>approve</action>

</membership_request>

<membership_request>

<email>User2Test2@email.com</email>

<groupID>XXXXXX</groupID>

<action>reject</action>

</membership_request>

</group_membership_requests>

JSON Format -

{

"group_membership_requests":[

{

"email": "User1Test1@email.com",

"groupID": "XXXXXX",

"action": "approve"

},

{

"email": "User2Test2@email.com",

"groupID": "XXXXXX",

"action": "reject"

}

]

}

To approve/reject pending group membership requests using DatabaseID 

XML Format -

<group_membership_requests type="array">

<membership_request>

<databaseID>User1Test1DBID</databaseID>

<groupID>XXXXXX</groupID>

<action>approve</action>

</membership_request>

<membership_request>

<databaseID>User2Test2DBID</databaseID>

<groupID>XXXXXX</groupID>

<action>reject</action>

</membership_request>

</group_membership_requests>

JSON Format -

{

"group_membership_requests":[

{

"databaseID": "User1Test1DBID",

"groupID": "XXXXXX",

"action": "approve"

},

{

"databaseID": "User2Test2DBID",

"groupID": "XXXXXX",

"action": "reject"

}

]

}

Back to Top

 

Reports API

Messages sent
All Messages

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY 

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY 

Email Reports

by topic ID

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&topicID=XXXXXX

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&topicID=XXXXXX 

by date
 

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&date=mm/dd/yyyy

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&date=mm/dd/yyyy

by recipient email
 

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&email=user1test1@email.com

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&email=user1test1@email.com

by topic ID and recipient email

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&topicID=XXXXXX&email=user1test1@email.com

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&topicID=XXXXXX&email=user1test1@email.com

by Delivery Status

 

statuses are

Queued

Delivered

Bounced

Deferred

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&status=Bounced

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&status=Bounced

by topic ID and Delivery Status

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&topicID=XXXXXX&status=Bounced

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&topicID=XXXXXX&status=Bounced

by email address and Delivery Status

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&email=user1test1@email.com&status=Bounced

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&email=user1test1@email.com&status=Bounced

by sent until a certain date

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&dateTo=mm/dd/yyyy

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&dateTo=mm/dd/yyyy

by sent from a certain date

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&dateFrom=mm/dd/yyyy

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&dateFrom=mm/dd/yyyy

by period from a certain date to a certain date

XML Format - 

https://regroup.com/api/v2/reports/topics?api_key=NetworkAPIKEY&dateFrom=mm/dd/yyyy&dateTo=mm/dd/yyyy

JSON Format -

https://regroup.com/api/v2/reports/topics.json?api_key=NetworkAPIKEY&dateFrom=mm/dd/yyyy&dateTo=mm/dd/yyyy

   
Responses Received for sent SMS either via WEB or API request
All Responses

XML Format - 

https://regroup.com/api/v2/reports/sms_responses?api_key=NetworkAPIKEY 

JSON Format -

https://regroup.com/api/v2/reports/sms_responses.json?api_key=NetworkAPIKEY 

 

on a specific date

XML Format - 

https://regroup.com/api/v2/reports/sms_responses?api_key=NetworkAPIKEY&date=8/7/2015

JSON Format -

https://regroup.com/api/v2/reports/sms_responses.json?api_key=NetworkAPIKEY&date=8/7/2015 

by SMS ID

XML Format - 

https://regroup.com/api/v2/reports/sms_responses?api_key=NetworkAPIKEY&smsID=TestSMS_ID 

JSON Format -

https://regroup.com/api/v2/reports/sms_responses.json?api_key=NetworkAPIKEY&smsID=TestSMS_ID 

by Phone Number

XML Format - 

https://regroup.com/api/v2/reports/sms_responses?api_key=NetworkAPIKEY&phone=15551234501 

JSON Format -

https://regroup.com/api/v2/reports/sms_responses.json?api_key=NetworkAPIKEY&phone=15551234501

by SMS ID and Phone Number

XML Format - 

https://regroup.com/api/v2/reports/sms_responses?api_key=NetworkAPIKEY&smsID=TestSMS_ID&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/sms_responses.json?api_key=NetworkAPIKEY&smsID=TestSMS_ID&phone=15551234501

SMS sent from WEB
All the sent SMS

XML Format - 

https://regroup.com/api/v2/reports/premium_text?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/reports/premium_text.json?api_key=NetworkAPIKEY

by Phone Number

XML Format - 

https://regroup.com/api/v2/reports/premium_text?api_key=NetworkAPIKEY&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/premium_text.json?api_key=NetworkAPIKEY&phone=15551234501

by SMS ID

XML Format - 

https://regroup.com/api/v2/reports/premium_text?api_key=NetworkAPIKEY&smsID=TestSMS_ID

JSON Format -

https://regroup.com/api/v2/reports/premium_text.json?api_key=NetworkAPIKEY&smsID=TestSMS_ID

by SMS ID and Phone Number

XML Format - 

https://regroup.com/api/v2/reports/premium_text?api_key=NetworkAPIKEY&smsID=TestSMS_ID&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/premium_text.json?api_key=NetworkAPIKEY&smsID=TestSMS_ID&phone=15551234501

 by date

XML Format - 

https://regroup.com/api/v2/reports/premium_text?api_key=NetworkAPIKEY&date=8/7/2015

JSON Format -

https://regroup.com/api/v2/reports/premium_text.json?api_key=NetworkAPIKEY&date=8/7/2015

 SMS sent via API request
 All SMS

XML Format - 

https://regroup.com/api/v2/reports/api_text?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/reports/api_text.json?api_key=NetworkAPIKEY

 by date

XML Format - 

https://regroup.com/api/v2/reports/api_text?api_key=NetworkAPIKEY&date=8/7/2015

JSON Format -

https://regroup.com/api/v2/reports/api_text.json?api_key=NetworkAPIKEY&date=8/7/2015

 by Phone Number

XML Format - 

https://regroup.com/api/v2/reports/api_text?api_key=NetworkAPIKEY&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/api_text.json?api_key=NetworkAPIKEY&phone=15551234501

 by SMS ID

XML Format - 

https://regroup.com/api/v2/reports/api_text?api_key=NetworkAPIKEY&smsID=TestSMSID

JSON Format -

https://regroup.com/api/v2/reports/api_text.json?api_key=NetworkAPIKEY&smsID=TestSMSID

 by SMS ID and Phone Number

XML Format - 

https://regroup.com/api/v2/reports/api_text?api_key=NetworkAPIKEY&smsID=TestSMSID&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/api_text.json?api_key=NetworkAPIKEY&smsID=TestSMSID&phone=15551234501

 Text to Speech sent from WEB 
 All TTS
XML Format - 

https://regroup.com/api/v2/reports/tts_topics?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/reports/tts_topics.json?api_key=NetworkAPIKEY

by date
XML Format - 

https://regroup.com/api/v2/reports/tts_topics?api_key=NetworkAPIKEY&date=8/7/2015

JSON Format -

https://regroup.com/api/v2/reports/tts_topics.json?api_key=NetworkAPIKEY&date=8/7/2015

by topic ID
XML Format - 

https://regroup.com/api/v2/reports/tts_topics?api_key=NetworkAPIKEY&topicID=TestTopicID

JSON Format -

https://regroup.com/api/v2/reports/tts_topics.json?api_key=NetworkAPIKEY&topicID=TestTopicID

by Phone Number
XML Format - 

https://regroup.com/api/v2/reports/tts_topics?api_key=NetworkAPIKEY&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/tts_topics.json?api_key=NetworkAPIKEY&phone=15551234501

by topic ID and Phone Number
XML Format - 

https://regroup.com/api/v2/reports/tts_topics?api_key=NetworkAPIKEY&topicID=TestTopicID&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/tts_topics.json?api_key=NetworkAPIKEY&topicID=TestTopicID&phone=15551234501

Text to Speech send via API request 
 All TTS
XML Format - 

https://regroup.com/api/v2/reports/api_ttsID?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/reports/api_ttsID.json?api_key=NetworkAPIKEY

 by date
XML Format - 

https://regroup.com/api/v2/reports/api_ttsID?api_key=NetworkAPIKEY&date=8/7/2015

JSON Format -

https://regroup.com/api/v2/reports/api_ttsID.json?api_key=NetworkAPIKEY&date=8/7/2015

 by Phone Number
XML Format - 

https://regroup.com/api/v2/reports/api_ttsID?api_key=NetworkAPIKEY&&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/api_ttsID.json?api_key=NetworkAPIKEY&phone=15551234501

 by topic ID
XML Format - 

https://regroup.com/api/v2/reports/api_tts_id?api_key=NetworkAPIKEY&apiTtsID=TestTtsID

JSON Format -

https://regroup.com/api/v2/reports/api_tts_id.json?api_key=NetworkAPIKEY&apiTtsID=TestTtsID

 by topic ID and Phone Number
XML Format - 

https://regroup.com/api/v2/reports/api_tts_id?api_key=NetworkAPIKEY&apiTtsID=TestTtsID&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/api_tts_id.json?api_key=NetworkAPIKEY&apiTtsID=TestTtsID&phone=15551234501

Voice Alerts sent from WEB 
All Voice Alerts
XML Format - 

https://regroup.com/api/v2/reports/voice_alerts?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/reports/voice_alerts.json?api_key=NetworkAPIKEY

by date
 XML Format - 

https://regroup.com/api/v2/reports/voice_alerts?api_key=NetworkAPIKEY&date=8/7/2015

JSON Format -

https://regroup.com/api/v2/reports/voice_alerts.json?api_key=NetworkAPIKEY&date=8/7/2015

by Voice Alert ID
 XML Format - 

https://regroup.com/api/v2/reports/voice_alerts?api_key=NetworkAPIKEY&voiceAlertID=TestVoiceAlert_id

JSON Format -

https://regroup.com/api/v2/reports/voice_alerts.json?api_key=NetworkAPIKEY&voiceAlertID=TestVoiceAlert_id

by Phone Number
 XML Format - 

https://regroup.com/api/v2/reports/voice_alerts?api_key=NetworkAPIKEY&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/voice_alerts.json?api_key=NetworkAPIKEY&phone=15551234501

by Voice Alert ID and Phone Number
 XML Format - 

https://regroup.com/api/v2/reports/voice_alerts?api_key=NetworkAPIKEY&voiceAlertID=TestVoiceAlert_id&phone=15551234501

JSON Format -

https://regroup.com/api/v2/reports/voice_alerts.json?api_key=NetworkAPIKEY&voiceAlertID=TestVoiceAlert_id&phone=15551234501

Scheduled Messages - Network Wide
All Scheduled Topics
XML Format - 

https://regroup.com/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY

by specific date
XML Format - 

https://regroup.com/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateSent=mm/dd/yyyy

JSON Format -

https://regroup.com/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateSent=mm/dd/yyyy

from a specific date

XML Format - 

https://regroup.com/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateSentFrom=mm/dd/yyyy

JSON Format -

https://regroup.com/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateSentFrom=mm/dd/yyyy

up until a specific date
XML Format - 

https://regroup.com/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateSentTo=mm/dd/yyyy

JSON Format -

https://regroup.com/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateSentTo=mm/dd/yyyy

in a date range
XML Format - 

https://regroup.com/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateSentTo=mm/dd/yyyy&dateSentFrom=mm/dd/yyyy

JSON Format -

https://regroup.com/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateSentTo=mm/dd/yyyy&dateSentFrom=mm/dd/yyyy

by topic ID
XML Format - 

https://regroup.com/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&topicID=XXXXXXX

JSON Format -

https://regroup.com/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&topicID=XXXXXXX

Scheduled Messages - Group Specific 
all scheduled topics XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY

sent on date XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateSent=mm/dd/yyyy

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateSent=mm/dd/yyyy

sent from a date XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateSentFrom=mm/dd/yyyy

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateSentFrom=mm/dd/yyyy

sent to a date XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateSentTo=mm/dd/yyyy

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateSentTo=mm/dd/yyyy

sent in a range
XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateSentTo=mm/dd/yyyy&dateSentFrom=mm/dd/yyyy

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateSentTo=mm/dd/yyyy&dateSentFrom=mm/dd/yyyy

scheduled on date XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateScheduled=mm/dd/yyyy

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateScheduled=mm/dd/yyyy

scheduled from date XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateScheduledFrom=mm/dd/yyyy

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateScheduledFrom=mm/dd/yyyy

scheduled to date XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateScheduledTo=mm/dd/yyyy

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateScheduledTo=mm/dd/yyyy

scheduled in date range XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&dateScheduledTo=mm/dd/yyyy&dateScheduledFrom=mm/dd/yyyy

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&dateScheduledTo=mm/dd/yyyy&dateScheduledFrom=mm/dd/yyyy

by topic ID XML Format - 

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics?api_key=NetworkAPIKEY&topicID=XXXXXXX

JSON Format -

https://regroup.com/groups/group-coded-name/api/v2/reports/scheduled_topics.json?api_key=NetworkAPIKEY&topicID=XXXXXXX

 

Back to Top

 

Locations Management API

roups API Request URL

XML Format -

https://regroup.com/api/v2/locations?api_key=NetworkAPIKEY

JSON Format -

https://regroup.com/api/v2/locations.json?api_key=NetworkAPIKEY

Root tag must be named "locations" and type must be array. If the locations tag and type is missing api will not process the request.

Add location via API

XML Format -

<?xml version="1.0" encoding="UTF-8"?>
<locations type="array">
<location>
<name>API Created location 1</name>
</location>
</locations>

JSON Format -

{

"locations": [

{

"name": "API Created location 1"

}

]

}

Add multiple locations

XML Format -

<?xml version="1.0" encoding="UTF-8"?>
<locations type="array">
<location>
<name>API Created location 1</name>
</location>

<location>
<name>API Created location 2</name>
</location>
</locations>

 

JSON Format -

{

"locations": [

{

"name": "API Created location 1",

}

{

"name": "API Created location 2"

}

]

}

 

Delete location via API

location can not be deleted via api if associated to any group or user

<?xml version="1.0" encoding="UTF-8"?>

<locations type="array">

<location>

<action>delete</action>

<name>API Created location 1</name>

</location>

</locations>
{

"locations": [

{

"action": "delete",

"name": "API Created location 1"

}

]

}

Back to Top




I'd Like to Request an Enhancement

0 out of 0 found this helpful

Updated:
Follow