Get a list of available 'send groups' – pre-defned groups containing a list of mobile numbers to send a message to. Also lists 'stop groups' – numbers in these groups will never be sent messages to. Every account has at least one stop group, so that your recipients can always opt out of receiving messages from you. This is a legal requirement.

 

Example successful response body XML:

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE response PUBLIC
"-//textmarketer.co.uk//DTD Web Services REST 1.6//EN""http://api.textmarketer.co.uk/services/rest/DTD/groups_get.dtd">
<response processed_date="2011-04-14T16:32:40+01:00">
	<groups quantity="2" >
		<group name="short_ZDZY" numbers="0" id="56" is_stop="true"/>
		<group name="mygroup" numbers="0" id="78" is_stop="false"/>
	</groups>
</response>

Response meanings:

XML tag/attribute 

Meaning

groups 

Contains a list of available groups.

quantity 

The number of groups available.

group 

Details of the group.

name 

The name of the group.

id 

The unique ID of the group.

is_stop 

Whether or not this is a 'stop group' – true/false.

numbers The quantity of numbers present in the group.

Specific errors:

None.

DTD for groups GET:

<?xml version="1.0" encoding="UTF-8"?>
<!--
 	PUBLIC ID : -//textmarketer.co.uk//DTD Web Services REST 1.6//EN
	 SYSTEM ID : http://api.textmarketer.co.uk/services/rest/DTD/groups_get.dtd
-->
<!ELEMENT response (groups)>
<!ATTLIST response
 	processed_date CDATA #REQUIRED
>
<!ELEMENT groups (group*)>
<!ATTLIST groups
	quantity CDATA #REQUIRED
>
<!ELEMENT group (#PCDATA) >
<!ATTLIST group
 	name CDATA #REQUIRED
 	numbers CDATA #REQUIRED
 	id CDATA #REQUIRED
 	is_stop CDATA #REQUIRED
>

Next: The keywords resource

Home: All Documentation