groups GET method

=20

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

=20

Example successful response body XML:

=20

<?xml version=3D"1.0" encoding=3D"ISO-8859-1"?&=
gt;
<!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=3D"2011-04-14T16:32:40+01:00">
=09<groups quantity=3D"2" >
=09=09<group name=3D"short_ZDZY" numbers=3D"0" id=3D=
"56" is_stop=3D"true"/>
=09=09<group name=3D"mygroup" numbers=3D"0" id=3D&qu=
ot;78" is_stop=3D"false"/>
=09</groups>
</response>

=20

Response meanings:

=20

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' =E2=80= =93 true/false.
numbers	The quantity of numbers present in the group.

=20

Specific errors:

=20

None.

=20

DTD for groups GET:

=20

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

=20

Next: The keywords res= ource

Home: All Documentation

=20