Skip to end of metadata
Go to start of metadata

 

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:

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: