Loading...
Loading...
Telnyx Missions SDK operations. This skill provides JavaScript SDK examples.
npx skill4agent add team-telnyx/telnyx-ext-agent-skills telnyx-missions-javascriptnpm install telnyximport Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});clientGET /ai/missions// Automatically fetches more pages as needed.
for await (const missionListResponse of client.ai.missions.list()) {
console.log(missionListResponse.mission_id);
}POST /ai/missionsnamedescriptionexecution_modeinstructionsmetadatamodelconst mission = await client.ai.missions.create({ name: 'name' });
console.log(mission.data);GET /ai/missions/events// Automatically fetches more pages as needed.
for await (const missionListEventsResponse of client.ai.missions.listEvents()) {
console.log(missionListEventsResponse.event_id);
}GET /ai/missions/runs// Automatically fetches more pages as needed.
for await (const runListRunsResponse of client.ai.missions.runs.listRuns()) {
console.log(runListRunsResponse.mission_id);
}GET /ai/missions/{mission_id}const mission = await client.ai.missions.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(mission.data);PUT /ai/missions/{mission_id}descriptionexecution_modeinstructionsmetadatamodelnameconst response = await client.ai.missions.updateMission('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(response.data);DELETE /ai/missions/{mission_id}await client.ai.missions.deleteMission('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');POST /ai/missions/{mission_id}/cloneconst response = await client.ai.missions.cloneMission('mission_id');
console.log(response);GET /ai/missions/{mission_id}/runs// Automatically fetches more pages as needed.
for await (const runListResponse of client.ai.missions.runs.list(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
console.log(runListResponse.mission_id);
}POST /ai/missions/{mission_id}/runsinputmetadataconst run = await client.ai.missions.runs.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(run.data);GET /ai/missions/{mission_id}/runs/{run_id}const run = await client.ai.missions.runs.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(run.data);PATCH /ai/missions/{mission_id}/runs/{run_id}errormetadataresult_payloadresult_summarystatusconst run = await client.ai.missions.runs.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(run.data);POST /ai/missions/{mission_id}/runs/{run_id}/cancelconst response = await client.ai.missions.runs.cancelRun('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.data);GET /ai/missions/{mission_id}/runs/{run_id}/events// Automatically fetches more pages as needed.
for await (const eventListResponse of client.ai.missions.runs.events.list(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
)) {
console.log(eventListResponse.event_id);
}POST /ai/missions/{mission_id}/runs/{run_id}/eventstypesummaryagent_ididempotency_keypayloadstep_idconst response = await client.ai.missions.runs.events.log('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
summary: 'summary',
type: 'status_change',
});
console.log(response.data);GET /ai/missions/{mission_id}/runs/{run_id}/events/{event_id}const response = await client.ai.missions.runs.events.getEventDetails('event_id', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
run_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.data);POST /ai/missions/{mission_id}/runs/{run_id}/pauseconst response = await client.ai.missions.runs.pauseRun('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.data);GET /ai/missions/{mission_id}/runs/{run_id}/planconst plan = await client.ai.missions.runs.plan.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(plan.data);POST /ai/missions/{mission_id}/runs/{run_id}/planstepsconst plan = await client.ai.missions.runs.plan.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
steps: [
{
description: 'description',
sequence: 0,
step_id: 'step_id',
},
],
});
console.log(plan.data);POST /ai/missions/{mission_id}/runs/{run_id}/plan/stepsstepsconst response = await client.ai.missions.runs.plan.addStepsToPlan(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
steps: [
{
description: 'description',
sequence: 0,
step_id: 'step_id',
},
],
},
);
console.log(response.data);GET /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}const response = await client.ai.missions.runs.plan.getStepDetails('step_id', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
run_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.data);PATCH /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}metadatastatusconst response = await client.ai.missions.runs.plan.updateStep('step_id', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
run_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.data);POST /ai/missions/{mission_id}/runs/{run_id}/resumeconst response = await client.ai.missions.runs.resumeRun('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});
console.log(response.data);GET /ai/missions/{mission_id}/runs/{run_id}/telnyx-agentsconst telnyxAgents = await client.ai.missions.runs.telnyxAgents.list(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);
console.log(telnyxAgents.data);POST /ai/missions/{mission_id}/runs/{run_id}/telnyx-agentstelnyx_agent_idconst response = await client.ai.missions.runs.telnyxAgents.link(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', telnyx_agent_id: 'telnyx_agent_id' },
);
console.log(response.data);DELETE /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents/{telnyx_agent_id}await client.ai.missions.runs.telnyxAgents.unlink('telnyx_agent_id', {
mission_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
run_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
});