Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

assistant_id
string
required

Unique identifier of the assistant.

Body

application/json
telnyx_conversation_channel
enum<string>
required
Available options:
phone_call,
sms_chat
telnyx_end_user_target
string
required

The phone number, SIP URI, to schedule the call or text to.

telnyx_agent_target
string
required

The phone number, SIP URI, to schedule the call or text from.

scheduled_at_fixed_datetime
string<date-time>
required

The datetime at which the event should be scheduled. Formatted as ISO 8601.

Example:

"2025-04-15T13:07:28.764Z"

text
string

Required for sms scheduled events. The text to be sent to the end user.

conversation_metadata
Conversation Metadata · object

Metadata associated with the conversation. Telnyx provides several pieces of metadata, but customers can also add their own.

dynamic_variables
Dynamic Variables · object

A map of dynamic variable names to values. These variables can be referenced in the assistant's instructions and messages using {{variable_name}} syntax.

max_retries_client_errors
integer
default:0

Configure number of retries on client errors: busy, no-answer, failed, canceled (caller hung up before the callee answered)

Required range: 0 <= x <= 10
retry_interval_secs
integer
Required range: 60 <= x <= 86400
call_settings
ScheduledCallSettings · object

Per-call telephony overrides applied when a scheduled phone-call event dispatches. Phone-call events only. New per-call dispatch options should be added here rather than as top-level event fields.

Response

Successful Response

Union type for different scheduled event response types

telnyx_conversation_channel
enum<string>
required
Available options:
phone_call,
sms_chat
telnyx_end_user_target
string
required
telnyx_agent_target
string
required
scheduled_at_fixed_datetime
string<date-time>
required
assistant_id
string
required
retry_count
integer
default:0
retry_attempts
integer
scheduled_event_id
string
conversation_id
string
created_at
string<date-time>
status
enum<string>
default:pending
Available options:
pending,
in_progress,
completed,
failed
conversation_metadata
Conversation Metadata · object
dynamic_variables
Dynamic Variables · object

A map of dynamic variable names to values. These variables can be referenced in the assistant's instructions and messages using {{variable_name}} syntax.

errors
string[]
call_status
string

Values: busy, canceled, no-answer, ringing, completed, failed, in-progress

call_duration
integer

Duration of the call in seconds

max_retries_client_errors
integer
default:0

Configure number of retries on client errors: busy, no-answer, failed, canceled (caller hung up before the callee answered)

retry_interval_secs
integer
call_attempts
AssistantScheduledCallAttempt · object[]
dispatched_at
string<date-time>

Date time at which call was sent

call_settings
ScheduledCallSettings · object

Per-call telephony overrides applied when a scheduled phone-call event dispatches. Phone-call events only. New per-call dispatch options should be added here rather than as top-level event fields.