Create a scheduled event
Create a scheduled event for an assistant
Documentation Index
Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
phone_call, sms_chat The phone number, SIP URI, to schedule the call or text to.
The phone number, SIP URI, to schedule the call or text from.
The datetime at which the event should be scheduled. Formatted as ISO 8601.
"2025-04-15T13:07:28.764Z"
Required for sms scheduled events. The text to be sent to the end user.
Metadata associated with the conversation. Telnyx provides several pieces of metadata, but customers can also add their own.
A map of dynamic variable names to values. These variables can be referenced in the assistant's instructions and messages using {{variable_name}} syntax.
Configure number of retries on client errors: busy, no-answer, failed, canceled (caller hung up before the callee answered)
0 <= x <= 1060 <= x <= 86400Response
Successful Response
- ScheduledPhoneCallEventResponse
- ScheduledSmsEventResponse
Union type for different scheduled event response types
phone_call, sms_chat pending, in_progress, completed, failed A map of dynamic variable names to values. These variables can be referenced in the assistant's instructions and messages using {{variable_name}} syntax.
Values: busy, canceled, no-answer, ringing, completed, failed, in-progress
Duration of the call in seconds
Configure number of retries on client errors: busy, no-answer, failed, canceled (caller hung up before the callee answered)
Date time at which call was sent