Shows the details of a group. Only gets the details of one group at a ti=
me, and includes all the numbers in the group, if there are any.
Also =
lists the numbers in a 'stop' groups - numbers in these groups will never b=
e sent messages. Every account has at least one stop group, so that your re=
cipients can always opt out of receiving messages from you. This is a legal=
requirement.
$result =3D $tmClient->getGroup('My Group');
echo "Numbers in group: {$result['numbers']}<br/>\n";
foreach ($result['number'] as $number)
=09echo "$number <br/>\n";
=20
Arguments:
string/integer $group:
Group name (string) or group ID (integer) to get the details of.
Returns:
an array with 5 keys: 'name', 'numbers', 'id', 'is_stop' and 'number'
| Array key | Value |
|---|---|
| name | String. The name of the group just created. |
| numbers | DEPRECATED =E2=80=93 do not use. |
| 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 new group is a stop grou= p. Always false. |
| number | Array. Array of strings =E2=80=93 the numbers= in the group, in international format, e.g. 447000000000. |
Specific error codes:
None.
error code 404 is reported if the group does not exist; error code 400 i= s reported if the group name was not specified. See General error codes.
You must know!
=20 =20Our 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.