Skip to end of metadata
Go to start of metadata


Get a list of available 'send' groups, including 'merge' groups - pre-defined 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. 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.



String name: 

Name of the delivery report to retrieve or 'all' to retrieve all campaign/API report data.


An array of Hashtable, each group represented by a Hashtable. Each Hashtable has 4 keys: 'is_stop', 'id', 'numbers' and 'name' e.g. name of the first returned group is group["name"]

Each Hashtable has 4 keys:

Hashtable key Value

String. The name of the group.

quantity Integer. The quantity of numbers in the group.

Integer. The unique ID of the group, unique for this account.

is_stopBoolean. Whether the group is a stop group, normally false.

Specific error codes: