Transactional message (PHP SDK 1.0)

The BulkGate\Sms\Message class represents the object of the SMS message, which consists of the content of the message and the recipient.

use BulkGate\Sms\Message;

Recipient

The class accepts as the first argument a phone number that can be entered by a string:

$message = new Message('447971700001', 'test message');

or accepts an instance of the object `Message\PhoneNumber`:

$message = new Sms\Message(new Message\PhoneNumber('447971700001'), 'test message');

You can also enter the phone number after creating an instance of the object using the method phoneNumber($phone_number, $iso = null):

$message = new Sms\Message(); $message->phoneNumber('447971700001'); // řetězec $message->phoneNumber('7971700001', BulkGate\Sms\Country::UNITED_KINGDOM); // The option with filling international prefix $message->phoneNumber(new Message\PhoneNumber('447971700001'));

To obtain a phone number, you can use the method getPhoneNumber(), which always returns an instance of the `Message\PhoneNumber` object.

/** @var Message\PhoneNumber $phone_number */ $phone_number = $message->getPhoneNumber();

Text of the message

The second parameter is the input of the text of the message. There are also 2 options where the first is to enter text using a string, and the other is an instance of the class `Message\Text`.

$message = new Message( new Message\PhoneNumber('447971700001'), new Message\Text('test message') );

Of course, you can define text even after creating an instance of an object using the method text($text, array $variables = [])

$message = new Sms\Message(); $message->phoneNumber('447971700001'); // string $message->text('test message'); // string $message->text(new Message\Text('test message')); $message->text( 'Hello <first_name> <last_name>', [ 'first_name' => 'John', 'last_name' => 'Doe' ]); // filling variables; the output is "Hello John Doe"

You can use the getText() method, to retrieve the message text, which always returns an instance of the `Message\Text` object.

/** @var Message\Text $text */ $text = $message->getText();

JSON Support

The BulkGate\Sms\Message object implements the \JsonSerializable interface that lets you convert it via the json_encode() to JSON format.

/** @var BulkGate\Sms\Message $message */ $message = new Message('447971700001', 'test message'); echo json_encode($message);

The output is:

{ "number": { "number": "447971700001", "iso": null }, "text": "test message", "status": "preparation", "price": 0.0, "credit": 0.0, "id": null, "scheduled": null }

The status, price, credit and id keys are filled in only after sending, scheduled once you call schedule().

Convert to string

The BulkGate\Sms\Message object implements the magic method __string()

/** @var BulkGate\Sms\Message $message */ $message = (string) $message; // into the variable echo $message; // to the output

The output is:

447971700001: test message

Convert to array

/** @var BulkGate\Sms\Message $message */ $array = $message->toArray();

Fluent interface

Fluent interface is the technique of chaining methods.

$message = new Sms\Message(); $message->phoneNumber('447971700001') ->text('test message');

Information after posting

After you send the message, you can get the price, status, and the message id from the message.

$id = $message->getId(); // message id $status = $message->getStatus(); // status $price = $message->getPrice(); // price $credit = $message->getCredit(); // credit balance after sending

Scheduling the message

The schedule() method sets the time of sending as a Unix timestamp. Without a parameter it cancels the scheduling.

$message->schedule(strtotime('2026-01-15 09:00')); // schedule $message->schedule(); // cancel the scheduling

Was this page helpful?

Ask AI Copied