Relay.Messaging
This represents the API interface for the Messaging Relay Service. This object is used to make requests related to managing SMS and MMS messages.
Methods
send
Send a message to the destination number.
Available In:
Parameters
context | string | required | The context to receive inbound events. |
from | string | required | The phone number to place the message from. Must be a SignalWire phone number or short code that you own. |
to | string | required | The phone number to send to. |
body | string | required | The content of the message. Optional if media is present. |
media | string[] | required | Array of URLs to send in the message. Optional if body is present. |
tags | string[] | optional | Array of strings to tag the message with for searching in the UI. |
Returns
React\Promise\Promise
- Promise
that will be fulfilled with a Relay.Messaging.SendResult
object.
Examples
Send a message in the context 'office'.
<?php
$params = [
'context' => 'office',
'from' => '+1XXXXXXXXXX',
'to' => '+1YYYYYYYYYY',
'body' => 'Welcome at SignalWire!'
];
$client->messaging->send($params)->done(function($sendResult) {
if ($sendResult->isSuccessful()) {
echo "Message ID: " . $sendResult->getMessageId();
}
});