From telnyx-javascript
Controls voice calls with Telnyx JavaScript SDK: dial outbound/inbound, transfer, bridge, gather DTMF, stream audio, handle webhook events.
npx claudepluginhub team-telnyx/skillsThis skill uses the workspace's default tool permissions.
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
Controls voice calls with Telnyx JavaScript SDK: dial outbound/inbound, transfer, bridge, gather DTMF, stream audio, handle webhook events.
Provides UI/UX resources: 50+ styles, color palettes, font pairings, guidelines, charts for web/mobile across React, Next.js, Vue, Svelte, Tailwind, React Native, Flutter. Aids planning, building, reviewing interfaces.
Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.
Share bugs, ideas, or general feedback.
npm install telnyx
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
All examples below assume client is already initialized as shown above.
All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
try {
const response = await client.calls.dial({
connection_id: '7267xxxxxxxxxxxxxx',
from: '+18005550101',
to: '+18005550100',
});
} catch (err) {
if (err instanceof Telnyx.APIConnectionError) {
console.error('Network error — check connectivity and retry');
} else if (err instanceof Telnyx.RateLimitError) {
const retryAfter = err.headers?.['retry-after'] || 1;
await new Promise(r => setTimeout(r, retryAfter * 1000));
} else if (err instanceof Telnyx.APIError) {
console.error(`API error ${err.status}: ${err.message}`);
if (err.status === 422) {
console.error('Validation error — check required fields and formats');
}
}
}
Common error codes: 401 invalid API key, 403 insufficient permissions,
404 resource not found, 422 validation error (check field formats),
429 rate limited (retry with exponential backoff).
+13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.for await (const item of result) { ... } to iterate through all pages automatically.dial() or an inbound webhook, issue follow-up commands from webhook handlers using the call_control_id in the event payload.dial(), while inbound calls must be answered from the incoming webhook before other commands run.Do not invent Telnyx parameters, enums, response fields, or webhook fields.
## Additional Operations, read the optional-parameters section and the response-schemas section.Primary voice entrypoint. Agents need the async call-control identifiers returned here.
client.calls.dial() — POST /calls
| Parameter | Type | Required | Description |
|---|---|---|---|
to | string (E.164) | Yes | The DID or SIP URI to dial out to. |
from | string (E.164) | Yes | The from number to be used as the caller id presented to t... |
connectionId | string (UUID) | Yes | The ID of the Call Control App (formerly ID of the connectio... |
timeoutSecs | integer | No | The number of seconds that Telnyx will wait for the call to ... |
billingGroupId | string (UUID) | No | Use this field to set the Billing Group ID for the call. |
clientState | string | No | Use this field to add state to every subsequent webhook. |
| ... | +48 optional params in references/api-details.md |
const response = await client.calls.dial({
connection_id: '7267xxxxxxxxxxxxxx',
from: '+18005550101',
to: '+18005550100',
});
console.log(response.data);
Primary response fields:
response.data.callControlIdresponse.data.callLegIdresponse.data.callSessionIdresponse.data.isAliveresponse.data.recordingIdresponse.data.callDurationPrimary inbound call-control command.
client.calls.actions.answer() — POST /calls/{call_control_id}/actions/answer
| Parameter | Type | Required | Description |
|---|---|---|---|
callControlId | string (UUID) | Yes | Unique identifier and token for controlling the call |
billingGroupId | string (UUID) | No | Use this field to set the Billing Group ID for the call. |
clientState | string | No | Use this field to add state to every subsequent webhook. |
webhookUrl | string (URL) | No | Use this field to override the URL for which Telnyx will sen... |
| ... | +26 optional params in references/api-details.md |
const response = await client.calls.actions.answer('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');
console.log(response.data);
Primary response fields:
response.data.resultresponse.data.recordingIdCommon post-answer control path with downstream webhook implications.
client.calls.actions.transfer() — POST /calls/{call_control_id}/actions/transfer
| Parameter | Type | Required | Description |
|---|---|---|---|
to | string (E.164) | Yes | The DID or SIP URI to dial out to. |
callControlId | string (UUID) | Yes | Unique identifier and token for controlling the call |
timeoutSecs | integer | No | The number of seconds that Telnyx will wait for the call to ... |
clientState | string | No | Use this field to add state to every subsequent webhook. |
webhookUrl | string (URL) | No | Use this field to override the URL for which Telnyx will sen... |
| ... | +33 optional params in references/api-details.md |
const response = await client.calls.actions.transfer('call_control_id', {
to: '+18005550100',
});
console.log(response.data);
Primary response fields:
response.data.resultTelnyx signs webhooks with Ed25519. Each request includes telnyx-signature-ed25519
and telnyx-timestamp headers. Always verify signatures in production:
// In your webhook handler (e.g., Express — use raw body, not parsed JSON):
app.post('/webhooks', express.raw({ type: 'application/json' }), async (req, res) => {
try {
const event = await client.webhooks.unwrap(req.body.toString(), {
headers: req.headers,
});
// Signature valid — event is the parsed webhook payload
console.log('Received event:', event.data.event_type);
res.status(200).send('OK');
} catch (err) {
console.error('Webhook verification failed:', err.message);
res.status(400).send('Invalid signature');
}
});
These webhook payload fields are inline because they are part of the primary integration path.
| Field | Type | Description |
|---|---|---|
data.record_type | enum: event | Identifies the type of the resource. |
data.event_type | enum: call.answered | The type of event being delivered. |
data.id | uuid | Identifies the type of resource. |
data.occurred_at | date-time | ISO 8601 datetime of when the event occurred. |
data.payload.call_control_id | string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id | string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.call_leg_id | string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id | string | ID that is unique to the call session and can be used to correlate webhook ev... |
| Field | Type | Description |
|---|---|---|
data.record_type | enum: event | Identifies the type of the resource. |
data.event_type | enum: call.hangup | The type of event being delivered. |
data.id | uuid | Identifies the type of resource. |
data.occurred_at | date-time | ISO 8601 datetime of when the event occurred. |
data.payload.call_control_id | string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id | string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.call_leg_id | string | ID that is unique to the call and can be used to correlate webhook events. |
data.payload.call_session_id | string | ID that is unique to the call session and can be used to correlate webhook ev... |
| Field | Type | Description |
|---|---|---|
data.record_type | enum: event | Identifies the type of the resource. |
data.event_type | enum: call.initiated | The type of event being delivered. |
data.id | uuid | Identifies the type of resource. |
data.occurred_at | date-time | ISO 8601 datetime of when the event occurred. |
data.payload.call_control_id | string | Call ID used to issue commands via Call Control API. |
data.payload.connection_id | string | Call Control App ID (formerly Telnyx connection ID) used in the call. |
data.payload.connection_codecs | string | The list of comma-separated codecs enabled for the connection. |
data.payload.offered_codecs | string | The list of comma-separated codecs offered by caller. |
If you need webhook fields that are not listed inline here, read the webhook payload reference before writing the handler.
Use these when the core tasks above are close to your flow, but you need a common variation or follow-up step.
End a live call from your webhook-driven control flow.
client.calls.actions.hangup() — POST /calls/{call_control_id}/actions/hangup
| Parameter | Type | Required | Description |
|---|---|---|---|
callControlId | string (UUID) | Yes | Unique identifier and token for controlling the call |
clientState | string | No | Use this field to add state to every subsequent webhook. |
commandId | string (UUID) | No | Use this field to avoid duplicate commands. |
customHeaders | array[object] | No | Custom headers to be added to the SIP BYE message. |
const response = await client.calls.actions.hangup('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');
console.log(response.data);
Primary response fields:
response.data.resultTrigger a follow-up action in an existing workflow rather than creating a new top-level resource.
client.calls.actions.bridge() — POST /calls/{call_control_id}/actions/bridge
| Parameter | Type | Required | Description |
|---|---|---|---|
callControlId | string (UUID) | Yes | The Call Control ID of the call you want to bridge with, can... |
callControlId | string (UUID) | Yes | Unique identifier and token for controlling the call |
clientState | string | No | Use this field to add state to every subsequent webhook. |
commandId | string (UUID) | No | Use this field to avoid duplicate commands. |
videoRoomId | string (UUID) | No | The ID of the video room you want to bridge with, can't be u... |
| ... | +16 optional params in references/api-details.md |
const response = await client.calls.actions.bridge('call_control_id', {
call_control_id_to_bridge_with: 'v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg',
});
console.log(response.data);
Primary response fields:
response.data.resultTrigger a follow-up action in an existing workflow rather than creating a new top-level resource.
client.calls.actions.reject() — POST /calls/{call_control_id}/actions/reject
| Parameter | Type | Required | Description |
|---|---|---|---|
cause | enum (CALL_REJECTED, USER_BUSY) | Yes | Cause for call rejection. |
callControlId | string (UUID) | Yes | Unique identifier and token for controlling the call |
clientState | string | No | Use this field to add state to every subsequent webhook. |
commandId | string (UUID) | No | Use this field to avoid duplicate commands. |
const response = await client.calls.actions.reject('call_control_id', { cause: 'USER_BUSY' });
console.log(response.data);
Primary response fields:
response.data.resultFetch the current state before updating, deleting, or making control-flow decisions.
client.calls.retrieveStatus() — GET /calls/{call_control_id}
| Parameter | Type | Required | Description |
|---|---|---|---|
callControlId | string (UUID) | Yes | Unique identifier and token for controlling the call |
const response = await client.calls.retrieveStatus('v3:550e8400-e29b-41d4-a716-446655440000_gRU1OGRkYQ');
console.log(response.data);
Primary response fields:
response.data.callControlIdresponse.data.callDurationresponse.data.callLegIdresponse.data.callSessionIdresponse.data.clientStateresponse.data.endTimeFetch the current state before updating, deleting, or making control-flow decisions.
client.connections.listActiveCalls() — GET /connections/{connection_id}/active_calls
| Parameter | Type | Required | Description |
|---|---|---|---|
connectionId | string (UUID) | Yes | Telnyx connection id |
page | object | No | Consolidated page parameter (deepObject style). |
// Automatically fetches more pages as needed.
for await (const connectionListActiveCallsResponse of client.connections.listActiveCalls(
'1293384261075731461',
)) {
console.log(connectionListActiveCallsResponse.call_control_id);
}
Response wrapper:
connectionListActiveCallsResponse.dataconnectionListActiveCallsResponse.metaPrimary item fields:
callControlIdcallDurationcallLegIdcallSessionIdclientStaterecordTypeInspect available resources or choose an existing resource before mutating it.
client.callControlApplications.list() — GET /call_control_applications
| Parameter | Type | Required | Description |
|---|---|---|---|
sort | enum (created_at, connection_name, active) | No | Specifies the sort order for results. |
filter | object | No | Consolidated filter parameter (deepObject style). |
page | object | No | Consolidated page parameter (deepObject style). |
// Automatically fetches more pages as needed.
for await (const callControlApplication of client.callControlApplications.list()) {
console.log(callControlApplication.id);
}
Response wrapper:
callControlApplication.datacallControlApplication.metaPrimary item fields:
idcreatedAtupdatedAtactiveanchorsiteOverrideapplicationNameUse the core tasks above first. The operations below are indexed here with exact SDK methods and required params; use references/api-details.md for full optional params, response schemas, and lower-frequency webhook payloads. Before using any operation below, read the optional-parameters section and the response-schemas section so you do not guess missing fields.
| Operation | SDK method | Endpoint | Use when | Required params |
|---|---|---|---|---|
| Create a call control application | client.callControlApplications.create() | POST /call_control_applications | Create or provision an additional resource when the core tasks do not cover this flow. | applicationName, webhookEventUrl |
| Retrieve a call control application | client.callControlApplications.retrieve() | GET /call_control_applications/{id} | Fetch the current state before updating, deleting, or making control-flow decisions. | id |
| Update a call control application | client.callControlApplications.update() | PATCH /call_control_applications/{id} | Modify an existing resource without recreating it. | applicationName, webhookEventUrl, id |
| Delete a call control application | client.callControlApplications.delete() | DELETE /call_control_applications/{id} | Remove, detach, or clean up an existing resource. | id |
| SIP Refer a call | client.calls.actions.refer() | POST /calls/{call_control_id}/actions/refer | Trigger a follow-up action in an existing workflow rather than creating a new top-level resource. | sipAddress, callControlId |
| Send SIP info | client.calls.actions.sendSipInfo() | POST /calls/{call_control_id}/actions/send_sip_info | Trigger a follow-up action in an existing workflow rather than creating a new top-level resource. | contentType, body, callControlId |
| Event | data.event_type | Description |
|---|---|---|
callBridged | call.bridged | Call Bridged |
For exhaustive optional parameters, full response schemas, and complete webhook payloads, see references/api-details.md.