Relay::Messaging | SignalWire

This namespace represents the API interface for the Messaging Relay Service. It is used to send and receive text messages.

Methods

send

Send an outbound SMS or MMS message.

Parameters

Parameter	Type	Required	Description
`to`	String	required	The number you are attempting to send the message to.
`from`	String	required	The phone number to place the message from. Must be a SignalWire phone number or short code that you own.
`context`	String	required	The SignalWire context on which you will receive updates about the message state.
`body`	String	optional	The text body to send. Either `body` or `media` must be specified.
`media`	Array	optional	An array of media URLs to send with an MMS. Either `body` or `media` must be specified.
`tags`	Array	optional	An array of tags to tag the message with. For searching in the UI and identifying messages.

Returns

Signalwire::Relay::Messaging::SendResult - the result of the send command.

Examples

Send a message in the office context.

1 result = client.messaging.send(
2   from: '+1XXXXXXXXXX',
3   to: '+1YYYYYYYYYY',
4   context: 'office',
5   body: 'SignalWire says hello!'
6 )
7 
8 puts "Message #{result.message_id} was successfully sent" if result.successful