v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Communication

Send SMS

Sends an SMS to the specified lead from the caller's virtual number.

Notes:

leadId and content are required.
phoneNumber + phoneCode select a specific phone on the lead; when omitted, the lead's primary phone is used.
Caller must have manage permission on the lead and must have an active virtual number.

post/v1.0/message/sms/send

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

phoneNumberstring

Recipient phone number

phoneCodestring

Recipient phone code

contentstring required

SMS content

leadIdinteger required

Lead ID. When phoneNumber and phoneCode are not provided or no matching phone is found for the lead, the system will use the primary phone number of this lead.

Example request

{
  "phoneNumber": "5865865860",
  "phoneCode": "1",
  "content": "Hello, this is a test message",
  "leadId": 563172647619608
}

Response

SMS delivered to the provider. Response contains the message ID and destination.

messageIdstring

The ID of the SMS message

phoneNumberstring

Recipient phone number

phoneCodestring

Recipient phone code