List scheduled events

GET

assistants

{assistant_id}

scheduled_events

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const scheduledEventListResponse of client.ai.assistants.scheduledEvents.list(
  'assistant_id',
)) {
  console.log(scheduledEventListResponse);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.ai.assistants.scheduled_events.list(
    assistant_id="assistant_id",
)
page = page.data[0]
print(page)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.AI.Assistants.ScheduledEvents.List(
		context.TODO(),
		"assistant_id",
		telnyx.AIAssistantScheduledEventListParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.assistants.scheduledevents.ScheduledEventListPage;
import com.telnyx.sdk.models.ai.assistants.scheduledevents.ScheduledEventListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ScheduledEventListPage page = client.ai().assistants().scheduledEvents().list("assistant_id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\AI\Assistants\ScheduledEvents\ConversationChannelType;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->ai->assistants->scheduledEvents->list(
    'assistant_id',
    conversationChannel: ConversationChannelType::PHONE_CALL,
    fromDate: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    pageNumber: 0,
    pageSize: 0,
    toDate: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "meta": {
    "total_pages": 0,
    "total_results": 0,
    "page_number": 0,
    "page_size": 0
  },
  "data": [
    {
      "telnyx_conversation_channel": "phone_call",
      "telnyx_end_user_target": "Telnyx End User Target",
      "telnyx_agent_target": "Telnyx Agent Target",
      "scheduled_at_fixed_datetime": "2024-01-23T18:10:02.574Z",
      "assistant_id": "Assistant Id",
      "retry_count": 0,
      "retry_attempts": 0,
      "scheduled_event_id": "Scheduled Event Id",
      "conversation_id": "Conversation Id",
      "created_at": "2024-01-23T18:10:02.574Z",
      "status": "pending",
      "errors": [
        "string"
      ],
      "call_status": "Call Status",
      "call_duration": 0,
      "max_retries_client_errors": 0,
      "retry_interval_secs": 0,
      "call_attempts": [
        {
          "attempt_number": 0,
          "attempted_at": "2024-01-23T18:10:02.574Z",
          "call_status": "Call Status",
          "call_duration": 0,
          "telnyx_call_control_id": "Telnyx Call Control Id"
        }
      ],
      "dispatched_at": "2024-01-23T18:10:02.574Z",
      "call_settings": {
        "sip_region": "US"
      }
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

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.

Query Parameters

from_date

string<date-time>

Start of the date range filter (inclusive, ISO 8601).

to_date

string<date-time>

End of the date range filter (inclusive, ISO 8601).

conversation_channel

enum<string>

Filter results by conversation channel.

Available options:

phone_call,

sms_chat

page

object

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

Show child attributes

Response

Successful Response

meta

Meta · object

required

Show child attributes

data

(ScheduledPhoneCallEventResponse · object | ScheduledSmsEventResponse · object)[]

required

ScheduledPhoneCallEventResponse
ScheduledSmsEventResponse

Show child attributes

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const scheduledEventListResponse of client.ai.assistants.scheduledEvents.list(
  'assistant_id',
)) {
  console.log(scheduledEventListResponse);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.ai.assistants.scheduled_events.list(
    assistant_id="assistant_id",
)
page = page.data[0]
print(page)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	page, err := client.AI.Assistants.ScheduledEvents.List(
		context.TODO(),
		"assistant_id",
		telnyx.AIAssistantScheduledEventListParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.assistants.scheduledevents.ScheduledEventListPage;
import com.telnyx.sdk.models.ai.assistants.scheduledevents.ScheduledEventListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ScheduledEventListPage page = client.ai().assistants().scheduledEvents().list("assistant_id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\AI\Assistants\ScheduledEvents\ConversationChannelType;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->ai->assistants->scheduledEvents->list(
    'assistant_id',
    conversationChannel: ConversationChannelType::PHONE_CALL,
    fromDate: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
    pageNumber: 0,
    pageSize: 0,
    toDate: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "meta": {
    "total_pages": 0,
    "total_results": 0,
    "page_number": 0,
    "page_size": 0
  },
  "data": [
    {
      "telnyx_conversation_channel": "phone_call",
      "telnyx_end_user_target": "Telnyx End User Target",
      "telnyx_agent_target": "Telnyx Agent Target",
      "scheduled_at_fixed_datetime": "2024-01-23T18:10:02.574Z",
      "assistant_id": "Assistant Id",
      "retry_count": 0,
      "retry_attempts": 0,
      "scheduled_event_id": "Scheduled Event Id",
      "conversation_id": "Conversation Id",
      "created_at": "2024-01-23T18:10:02.574Z",
      "status": "pending",
      "errors": [
        "string"
      ],
      "call_status": "Call Status",
      "call_duration": 0,
      "max_retries_client_errors": 0,
      "retry_interval_secs": 0,
      "call_attempts": [
        {
          "attempt_number": 0,
          "attempted_at": "2024-01-23T18:10:02.574Z",
          "call_status": "Call Status",
          "call_duration": 0,
          "telnyx_call_control_id": "Telnyx Call Control Id"
        }
      ],
      "dispatched_at": "2024-01-23T18:10:02.574Z",
      "call_settings": {
        "sip_region": "US"
      }
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Guides

Missions

AI Insights

Assistants API

Missions API

AI Tests API

Conversations API

For AI Agents

List scheduled events

Authorizations

Path Parameters

Query Parameters

Response