latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Messages

Send SMS by number

REQUIRED SCOPES <code>[‘messages:write’]</code><br>Using the given endpoint, you can send an SMS message via API by phone number. <br><br>As a result, instead of team’s id and conversation’s id, it is allowed to indicate the user’s phone number in order to send them a message.

post/messages

Query parameters

numberstring required
Example:+12025550018

Number

team_idinteger required
Example:1

Team ID

messagestring textarea required

Message

send_atstring date-time

Send At

media_url[][url]string[]

Url for media

[
  "https://example.com/image.png"
]

Response

OK

idinteger
conversation_idinteger
automatedboolean
statusstring
typestring
mms_statusstring
bodystring
body_rawstring
has_taggingboolean
iconstring
received_atstring
send_atstring
queued_atstring
sent_atstring
delivered_atstring
failed_atstring
failed_reasonstring
created_atstring
stop_on_responseboolean
is_hipaaboolean
user_idinteger
source_idstring
sourcestring