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.

Example

Arguments:

 

string $name: 

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

Returns:

an array of groups, each group represented by a nested array. Each nested array has 4 keys: 'is_stop', 'id','numbers' and 'name' e.g. name of the first returned group is
$groups[0]['name']

Array keyValue
name 

String. The name of the group.

quantity 

Integer. The quantity of numbers in the group.

idInteger. The unique ID of the group, unique for this account.
is_stop 

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

Specific error codes:

None

 

 

 

You must know!

Our example code is an illustration of how you might integrate with our systems and is not certified for production environments. You are responsible for testing and QA.