Skip to main content
GET
/
ai
/
assistants
/
{assistant_id}
/
scheduled_events
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const scheduledEvents = await client.ai.assistants.scheduledEvents.list('assistant_id');

console.log(scheduledEvents.data);
{
  "meta": {
    "total_pages": 123,
    "total_results": 123,
    "page_number": 123,
    "page_size": 123
  },
  "data": [
    {
      "telnyx_conversation_channel": "phone_call",
      "telnyx_end_user_target": "<string>",
      "telnyx_agent_target": "<string>",
      "scheduled_at_fixed_datetime": "2023-11-07T05:31:56Z",
      "assistant_id": "<string>",
      "retry_count": 0,
      "retry_attempts": 123,
      "scheduled_event_id": "<string>",
      "conversation_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "pending",
      "conversation_metadata": {},
      "errors": [
        "<string>"
      ]
    }
  ]
}

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

Query Parameters

from_date
string<date-time>
to_date
string<date-time>
conversation_channel
enum<string>
Available options:
phone_call,
sms_chat
page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

Successful Response

meta
Meta · object
required
data
(ScheduledPhoneCallEventResponse · object | ScheduledSmsEventResponse · object)[]
required
  • ScheduledPhoneCallEventResponse
  • ScheduledSmsEventResponse