Get a scheduled event
Returns the details of a single scheduled event configured for the specified assistant.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const scheduledEventResponse = await client.ai.assistants.scheduledEvents.retrieve('event_id', {
assistant_id: 'assistant_id',
});
console.log(scheduledEventResponse);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
scheduled_event_response = client.ai.assistants.scheduled_events.retrieve(
event_id="event_id",
assistant_id="assistant_id",
)
print(scheduled_event_response)
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"),
)
scheduledEventResponse, err := client.AI.Assistants.ScheduledEvents.Get(
context.TODO(),
"event_id",
telnyx.AIAssistantScheduledEventGetParams{
AssistantID: "assistant_id",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", scheduledEventResponse)
}
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.ScheduledEventResponse;
import com.telnyx.sdk.models.ai.assistants.scheduledevents.ScheduledEventRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
ScheduledEventRetrieveParams params = ScheduledEventRetrieveParams.builder()
.assistantId("assistant_id")
.eventId("event_id")
.build();
ScheduledEventResponse scheduledEventResponse = client.ai().assistants().scheduledEvents().retrieve(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
scheduled_event_response = telnyx.ai.assistants.scheduled_events.retrieve("event_id", assistant_id: "assistant_id")
puts(scheduled_event_response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$scheduledEventResponse = $client->ai->assistants->scheduledEvents->retrieve(
'event_id', assistantID: 'assistant_id'
);
var_dump($scheduledEventResponse);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx ai:assistants:scheduled-events retrieve \
--api-key 'My API Key' \
--assistant-id assistant_id \
--event-id event_idcurl --request GET \
--url https://api.telnyx.com/v2/ai/assistants/{assistant_id}/scheduled_events/{event_id} \
--header 'Authorization: Bearer <token>'{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier of the assistant.
Unique identifier of the event.
Response
Successful Response
- ScheduledPhoneCallEventResponse
- ScheduledSmsEventResponse
Union type for different scheduled event response types
phone_call, sms_chat pending, in_progress, completed, failed Show child attributes
Show child attributes
A map of dynamic variable names to values. These variables can be referenced in the assistant's instructions and messages using {{variable_name}} syntax.
Show child attributes
Show child attributes
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)
Show child attributes
Show child attributes
Date time at which call was sent
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.
Show child attributes
Show child attributes
Was this page helpful?
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const scheduledEventResponse = await client.ai.assistants.scheduledEvents.retrieve('event_id', {
assistant_id: 'assistant_id',
});
console.log(scheduledEventResponse);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
scheduled_event_response = client.ai.assistants.scheduled_events.retrieve(
event_id="event_id",
assistant_id="assistant_id",
)
print(scheduled_event_response)
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"),
)
scheduledEventResponse, err := client.AI.Assistants.ScheduledEvents.Get(
context.TODO(),
"event_id",
telnyx.AIAssistantScheduledEventGetParams{
AssistantID: "assistant_id",
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", scheduledEventResponse)
}
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.ScheduledEventResponse;
import com.telnyx.sdk.models.ai.assistants.scheduledevents.ScheduledEventRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
ScheduledEventRetrieveParams params = ScheduledEventRetrieveParams.builder()
.assistantId("assistant_id")
.eventId("event_id")
.build();
ScheduledEventResponse scheduledEventResponse = client.ai().assistants().scheduledEvents().retrieve(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
scheduled_event_response = telnyx.ai.assistants.scheduled_events.retrieve("event_id", assistant_id: "assistant_id")
puts(scheduled_event_response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$scheduledEventResponse = $client->ai->assistants->scheduledEvents->retrieve(
'event_id', assistantID: 'assistant_id'
);
var_dump($scheduledEventResponse);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx ai:assistants:scheduled-events retrieve \
--api-key 'My API Key' \
--assistant-id assistant_id \
--event-id event_idcurl --request GET \
--url https://api.telnyx.com/v2/ai/assistants/{assistant_id}/scheduled_events/{event_id} \
--header 'Authorization: Bearer <token>'{
"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"
}
]
}