-
voice
-
text
-
(optional) The name of the voice on your account that you wish to use. Default if omitted.
-
from
-
44NNNNNNNNNN
-
(required) The originating phone number.
-
to
-
44NNNNNNNNNN
-
(required) The destination phone number.
-
scheduled_for
-
YYYY-MM-DD HH:NN:SS
-
(optional) The date/time the message should be sent. Default now if omitted.
-
welcome_message
-
text
-
The initial audio the user will hear upon answering; "Hi, this is an important message from MyCompany…"
-
detect_message
-
text
-
The secondary audio the user will hear and will be requested to press a key; "Press X if you wish to hear this message now"
-
human_message
-
text
-
The main audio message for the user. Will be played if a key was pressed during "detect_message"
-
voicemail_message
-
text
-
The main audio message for the user. Will be played if a key was not pressed during "detect_message"
-
receipt_url
-
text
-
A URL on your system to send an HTTPS confirmation of the transaction, in real-time.
-
send_ref
-
text
-
A reference from your system for tracking purposes.
-
attempts
-
N
-
The amount of attempts at re-dialling the user, should they not answer.
-
attempt_interval
-
NNNN
-
Time between retry attempts in seconds, eg 300 for 5 minutes.
-
ringtime
-
NN
-
Time the phone should ring for before it's assumed it's unanswered.
-
skip_detect
-
boolean
-
If true, the detect message will not be played.
-
account_code
-
text
-
Your account code.