Relay.Messaging

View as Markdown

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.

Parameters

ParameterTypeRequiredDescription
contextstringrequiredThe context to receive inbound events.
fromstringrequiredThe phone number to place the message from. Must be a SignalWire phone number or short code that you own.
tostringrequiredThe phone number to send to.
bodystringrequiredThe content of the message.
Optional if media is present.
mediastring[]requiredArray of URLs to send in the message.
Optional if body is present.
tagsstring[]optionalArray 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.

1<?php
2
3$params = [
4  'context' => 'office',
5  'from' => '+1XXXXXXXXXX',
6  'to' => '+1YYYYYYYYYY',
7  'body' => 'Welcome at SignalWire!'
8];
9$client->messaging->send($params)->done(function($sendResult) {
10  if ($sendResult->isSuccessful()) {
11    echo "Message ID: " . $sendResult->getMessageId();
12  }
13});