Skip to main content

Request Body

Parameters

NameTypeRequiredSample ValueDescription
fromStringYes1234567890Assigned 10 digits Caller ID
sandboxModeBooleanNotrueDefault: false (send for production). If true, sends SMS only to whitelisted numbers.
useDraftTemplateBooleanNofalseDefault: false. If true, sends SMS using the template in draft mode. If false, sends using the latest published version.
templateIdIntegerYes1..9999Numeric value template set via IntelSend admin portal
parametersArrayNo[ { "uid": "abc-123", "to": "13233933379", "name": "Deepak", "address": "1234" }, { "uid": "xyz-123", "to": "19495790525", "name": "Jim", "address": "1234" } ]Array of objects with key-value pairs. Keys are variables in the SMS template, and values replace those variables.
sendAtDateTimeNo2024-11-01 11:00:00Datetime format as YYYY-MM-DD HH:mm:ss in UTC timezone. Default: Current datetime.
uidStringYesabc-123Limit: 40 characters, used for tracking purposes. Unique for each request.
programIdIntegerYes12345Limit: 6 digits, used to bundle multiple requests for reporting and billing purposes.
checkOptoutBooleanNotrueDefault: true. If false, will not check if the number has opted out of the sender ID.
maxRetryIntegerNo0-3Default: 0. Number of retries in case a voice message is not successfully left.
retryAfterIntegerNo5-60Number of minutes to wait after each retry to get Live/Machine voice result.
repeatKeyIntegerNo0-9,-13,-6Default: -13 or #. Which key press should repeat the entire message.
maxRepeatIntegerNo0-5Default: 1. Maximum number of times the message can be repeated.

Refer to the Examples for sample requests.