Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
SMS

Send SMS to Client

Send a message to a Client via SMS.

post/communications/send_sms/client

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Request body

send_from_group_phone_number_idinteger required

group number id, use the GET group_phone_numbers endpoint to get the list

send_to_client_idinteger required

client id

bodystring required

message body

Example request

{
  "send_from_group_phone_number_id": 1234567891234567,
  "send_to_client_id": 1234567891234567
}

Response

Message Data

bodystring required

message body

conversation_idstring

twilio conversation sid

message_idstring

twilio message sid

message_statusstring
  • sent: Twilio has sent the message
  • delivered: Twilio has received confirmation of message delivery from the carrier (and, where available, the destination handset). See below for more information.
  • read: The user has opened the message on their device, and the read status has been reported back to Twilio. This applies only to over-the-top, or OTT, channels, such as WhatsApp.
  • failed: The message could not be sent.
  • undelivered: Twilio has received a delivery receipt indicating that the message was not delivered.
  • null: The message has been created, but it's still within Twilio. Message status values: (reference:https://www.twilio.com/docs/conversations/delivery-receipts#what-are-the-possible-message-statuses)
sent_datetimestring date-time

Datetime message was sent

errorstring

if there was an error

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions:

Example response

{
  "sent_datetime": "2014-12-31T23:59:59.938Z"
}