Schedule an SMS message for delivery

Schedules a message to be sent via the queue service

POST

https://api.channelautomation.com/api/queue/schedule-sms

Authorization

bearerAuth
bearerAuth
required

Request body JSON required

to
string
required
Recipient phone number
content
string
required
Message content
workspaceId
string
required
Workspace ID
contactId
optional
string
Contact ID (optional)
scheduledFor
optional
string
When to send the message (optional, immediate if not specified)

format: date-time
metadata
optional
object
Additional metadata for the message

Returns

200

Message scheduled successfully

JSON

success
optional
boolean
jobId
optional
string
Queue job ID for tracking
scheduledFor
optional
string
When the message is scheduled to be sent

format: date-time

400

Invalid input

401

Unauthorized

500

Internal server error

Schedule an SMS message for delivery

curl --request POST \
  --url https://api.channelautomation.com/api/queue/schedule-sms \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "string",
  "content": "string",
  "workspaceId": "string",
  "contactId": "string",
  "scheduledFor": "2019-08-24T14:15:22Z",
  "metadata": {}
}
'

const url = 'https://api.channelautomation.com/api/queue/schedule-sms';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    to: 'string',
    content: 'string',
    workspaceId: 'string',
    contactId: 'string',
    scheduledFor: '2019-08-24T14:15:22Z',
    metadata: {}
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/queue/schedule-sms"

payload = {
    "to": "string",
    "content": "string",
    "workspaceId": "string",
    "contactId": "string",
    "scheduledFor": "2019-08-24T14:15:22Z",
    "metadata": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "success": true,
  "jobId": "string",
  "scheduledFor": "2019-08-24T14:15:22Z"
}