Message-ID: <1694453844.15811.1614958262864.JavaMail.confluence@wiki> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_15810_468790395.1614958262864" ------=_Part_15810_468790395.1614958262864 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html getGroups

getGroups

=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20

Get a list of available 'send' groups, including 'merge' groups - pre-de= fined groups containing a list of mobile numbers to send a message to.
Also lists 'stop' groups - numbers in these groups will never be sent mess= ages. Every account has at least one stop group, so that your recipients ca= n always opt out of receiving messages from you. This is a legal requiremen= t.

=20
=20
=20
=20
=20
=20
Example
=20
$groups =3D $tmClient->getGroups();
foreach($groups as $group)
=09foreach($group as $key =3D> $value)
=09=09echo "$key =3D> $value <BR/>";
=20
=20
=20
=20
=20
=20
=20

Arguments:

=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20

string $name: 

=20
=20
=20
=20

Name of the delivery report to retrieve or 'all' to retrieve all campaig= n/API report data

=20
=20
=20
=20
=20
=20

Returns:

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

=20
=20
=20
=20
Array key Value
name 

String. The name of the group.

quantity 

Integer. The quantity of numbers in the group= .

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

Boolean. Whether the group is a stop group, n= ormally false.

=20
=20
=20
=20
=20
=20

Specific error codes:

=20
=20
=20
=20

None

=20
=20
=20
=20
=20
=20

 

=20
=20
=20
=20
=20 =20
=20
=20
=20

 

=20
=20
=20
=20

 

=20
=20
=20
=20
=20
=20
=20

You must know!

=20 =20

Our example code is an illustra= tion of how you might integrate with our systems and is not certified for p= roduction environments. You are responsible for testing and QA.

=20
=20
=20
=20
=20
=20

 

------=_Part_15810_468790395.1614958262864--