PHP SDK to send messages with

1.2.2 2020-05-27 07:45 UTC

This package is auto-updated.

Last update: 2020-07-27 08:31:49 UTC


Build Status codecov Packagist


A software development kit to provide ways to interact with's Text service. API used:


  • php 7.*


Instantiate the client

Using your unique ApiKey (or product token) which authorizes you on the CM platform. Always keep this key secret!

$client = new \CMText\TextClient('your-api-key');

Send a message

By calling SendMessage and providing message text, sender name, recipient phone number(s) and a reference (optional).

$result = $client->SendMessage('Message_Text', '', [ 'Recipient_PhoneNumber' ], 'Your_Reference');

Get the result

SendMessage and send return an object of type TextClientResult, example:

  "statusMessage": "Created 1 message(s)",
  "statusCode": 201,
  "details": [
      "reference": "Example_Reference",
      "status": "Accepted",
      "to": "Example_PhoneNumber",
      "parts": 1,
      "details": null
      "reference": "Example_Reference2",
      "status": "Rejected",
      "to": "Example_PhoneNumber2",
      "parts": 0,
      "details": "A body without content was found"

Sending a rich message

By using the Message class it is possible to create messages with media for channels such as WhatsApp and RCS

$client = new TextClient('your-api-key');
$message = new Message('Message Text', 'Sender_name', ['Recipient_PhoneNumber']);
        new MediaMessage(
        new ReplySuggestion('Opt In', 'OK'),
        new ReplySuggestion('Opt Out', 'STOP'),
$result = $client->send( [$message] );

Status codes

For all possibly returned status codes, please reference the TextClientStatusCodes class.