Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
SMS

Send SMS to Lead

Send a message to a Lead via SMS.

post/communications/send_sms/lead

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_lead_idinteger required
bodystring required

message body

Example request

{
  "send_from_group_phone_number_id": 1234567891234567,
  "send_to_lead_id": 1234567891234567
}

Response

Message Identifier

bodystring required

message body

conversation_idstring

twilio conversation sid

message_idstring

twilio message sid

message_statusstring

twilio delivery_receipt message status: sent, delivered, failed, undelivered

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:

  • an UserException with Abort Transaction = Yes, and a Log Error = No
  • an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

Example response

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