Telnyx Sip Integrations - JavaScript
Installation
npm install telnyxSetup
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.
Error Handling
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 result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
if (err instanceof Telnyx.APIConnectionError) {
console.error('Network error — check connectivity and retry');
} else if (err instanceof Telnyx.RateLimitError) {
// 429: rate limited — wait and retry with exponential backoff
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).
Important Notes
- Pagination: List methods return an auto-paginating iterator. Use
for await (const item of result) {...}to iterate through all pages automatically.
Retrieve a stored credential
Returns the information about custom storage credentials.
GET /custom_storage_credentials/{connection_id}
const customStorageCredential = await client.customStorageCredentials.retrieve('connection_id');
console.log(customStorageCredential.connection_id);Returns: backend (enum: gcs, s3, azure), configuration (object)
Create a custom storage credential
Creates a custom storage credentials configuration.
POST /custom_storage_credentials/{connection_id}
const customStorageCredential = await client.customStorageCredentials.create('connection_id', {
backend: 'gcs',
configuration: { backend: 'gcs' },
});
console.log(customStorageCredential.connection_id);Returns: backend (enum: gcs, s3, azure), configuration (object)
Update a stored credential
Updates a stored custom credentials configuration.
PUT /custom_storage_credentials/{connection_id}
const customStorageCredential = await client.customStorageCredentials.update('connection_id', {
backend: 'gcs',
configuration: { backend: 'gcs' },
});
console.log(customStorageCredential.connection_id);Returns: backend (enum: gcs, s3, azure), configuration (object)
Delete a stored credential
Deletes a stored custom credentials configuration.
DELETE /custom_storage_credentials/{connection_id}
await client.customStorageCredentials.delete('connection_id');Retrieve stored Dialogflow Connection
Return details of the Dialogflow connection associated with the given CallControl connection.
GET /dialogflow_connections/{connection_id}
const dialogflowConnection = await client.dialogflowConnections.retrieve('connection_id');
console.log(dialogflowConnection.data);Returns: connection_id (string), conversation_profile_id (string), environment (string), record_type (string), service_account (string)
Create a Dialogflow Connection
Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services.
POST /dialogflow_connections/{connection_id}
const dialogflowConnection = await client.dialogflowConnections.create('connection_id', {
service_account: {
type: 'bar',
project_id: 'bar',
private_key_id: 'bar',
private_key: 'bar',
client_email: 'bar',
client_id: 'bar',
auth_uri: 'bar',
token_uri: 'bar',
auth_provider_x509_cert_url: 'bar',
client_x509_cert_url: 'bar',
},
});
console.log(dialogflowConnection.data);Returns: connection_id (string), conversation_profile_id (string), environment (string), record_type (string), service_account (string)
Update stored Dialogflow Connection
Updates a stored Dialogflow Connection.
PUT /dialogflow_connections/{connection_id}
const dialogflowConnection = await client.dialogflowConnections.update('connection_id', {
service_account: {
type: 'bar',
project_id: 'bar',
private_key_id: 'bar',
private_key: 'bar',
client_email: 'bar',
client_id: 'bar',
auth_uri: 'bar',
token_uri: 'bar',
auth_provider_x509_cert_url: 'bar',
client_x509_cert_url: 'bar',
},
});
console.log(dialogflowConnection.data);Returns: connection_id (string), conversation_profile_id (string), environment (string), record_type (string), service_account (string)
Delete stored Dialogflow Connection
Deletes a stored Dialogflow Connection.
DELETE /dialogflow_connections/{connection_id}
await client.dialogflowConnections.delete('connection_id');List all External Connections
This endpoint returns a list of your External Connections inside the 'data' attribute of the response. External Connections are used by Telnyx customers to seamless configure SIP trunking integrations with Telnyx Partners, through External Voice Integrations in Mission Control Portal.
GET /external_connections
// Automatically fetches more pages as needed.
for await (const externalConnection of client.externalConnections.list()) {
console.log(externalConnection.id);
}Returns: active (boolean), created_at (string), credential_active (boolean), external_sip_connection (enum: zoom, operator_connect), id (string), inbound (object), outbound (object), record_type (string), tags (array[string]), updated_at (string), webhook_api_version (enum: 1, 2), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer | null)
Creates an External Connection
Creates a new External Connection based on the parameters sent in the request. The external_sip_connection and outbound voice profile id are required. Once created, you can assign phone numbers to your application using the /phone_numbers endpoint.
POST /external_connections — Required: external_sip_connection, outbound
Optional: active (boolean), inbound (object), tags (array[string]), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer | null)
const externalConnection = await client.externalConnections.create({
external_sip_connection: 'zoom',
outbound: {},
});
console.log(externalConnection.data);Returns: active (boolean), created_at (string), credential_active (boolean), external_sip_connection (enum: zoom, operator_connect), id (string), inbound (object), outbound (object), record_type (string), tags (array[string]), updated_at (string), webhook_api_version (enum: 1, 2), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer | null)
List all log messages
Retrieve a list of log messages for all external connections associated with your account.
GET /external_connections/log_messages
// Automatically fetches more pages as needed.
for await (const logMessageListResponse of client.externalConnections.logMessages.list()) {
console.log(logMessageListResponse.code);
}Returns: log_messages (array[object]), meta (object)
Retrieve a log message
Retrieve a log message for an external connection associated with your account.
GET /external_connections/log_messages/{id}
const logMessage = await client.externalConnections.logMessages.retrieve('1293384261075731499');
console.log(logMessage.log_messages);Returns: log_messages (array[object])
Dismiss a log message
Dismiss a log message for an external connection associated with your account.
DELETE /external_connections/log_messages/{id}
const response = await client.externalConnections.logMessages.dismiss('1293384261075731499');
console.log(response.success);Returns: success (boolean)
Retrieve an External Connection
Return the details of an existing External Connection inside the 'data' attribute of the response.
GET /external_connections/{id}
const externalConnection = await client.externalConnections.retrieve('1293384261075731499');
console.log(externalConnection.data);Returns: active (boolean), created_at (string), credential_active (boolean), external_sip_connection (enum: zoom, operator_connect), id (string), inbound (object), outbound (object), record_type (string), tags (array[string]), updated_at (string), webhook_api_version (enum: 1, 2), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer | null)
Update an External Connection
Updates settings of an existing External Connection based on the parameters of the request.
PATCH /external_connections/{id} — Required: outbound
Optional: active (boolean), inbound (object), tags (array[string]), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer | null)
const externalConnection = await client.externalConnections.update('1293384261075731499', {
outbound: { outbound_voice_profile_id: '1911630617284445511' },
});
console.log(externalConnection.data);Returns: active (boolean), created_at (string), credential_active (boolean), external_sip_connection (enum: zoom, operator_connect), id (string), inbound (object), outbound (object), record_type (string), tags (array[string]), updated_at (string), webhook_api_version (enum: 1, 2), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer | null)
Deletes an External Connection
Permanently deletes an External Connection. Deletion may be prevented if the application is in use by phone numbers, is active, or if it is an Operator Connect connection. To remove an Operator Connect integration please contact Telnyx support.
DELETE /external_connections/{id}
const externalConnection = await client.externalConnections.delete('1293384261075731499');
console.log(externalConnection.data);Returns: active (boolean), created_at (string), credential_active (boolean), external_sip_connection (enum: zoom, operator_connect), id (string), inbound (object), outbound (object), record_type (string), tags (array[string]), updated_at (string), webhook_api_version (enum: 1, 2), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer | null)
List all civic addresses and locations
Returns the civic addresses and locations from Microsoft Teams.
GET /external_connections/{id}/civic_addresses
const civicAddresses = await client.externalConnections.civicAddresses.list('1293384261075731499');
console.log(civicAddresses.data);Returns: city_or_town (string), city_or_town_alias (string), company_name (string), country (string), country_or_district (string), default_location_id (uuid), description (string), house_number (string), house_number_suffix (string), id (uuid), locations (array[object]), postal_or_zip_code (string), record_type (string), state_or_province (string), street_name (string), street_suffix (string)
Retrieve a Civic Address
Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response.
GET /external_connections/{id}/civic_addresses/{address_id}
const civicAddress = await client.externalConnections.civicAddresses.retrieve(
'318fb664-d341-44d2-8405-e6bfb9ced6d9',
{ id: '1293384261075731499' },
);
console.log(civicAddress.data);Returns: city_or_town (string), city_or_town_alias (string), company_name (string), country (string), country_or_district (string), default_location_id (uuid), description (string), house_number (string), house_number_suffix (string), id (uuid), locations (array[object]), postal_or_zip_code (string), record_type (string), state_or_province (string), street_name (string), street_suffix (string)
Update a location's static emergency address
PATCH /external_connections/{id}/locations/{location_id} — Required: static_emergency_address_id
const response = await client.externalConnections.updateLocation(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{
id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
static_emergency_address_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
},
);
console.log(response.data);Returns: accepted_address_suggestions (boolean), location_id (uuid), static_emergency_address_id (uuid)
List all phone numbers
Returns a list of all active phone numbers associated with the given external connection.
GET /external_connections/{id}/phone_numbers
// Automatically fetches more pages as needed.
for await (const externalConnectionPhoneNumber of client.externalConnections.phoneNumbers.list(
'1293384261075731499',
)) {
console.log(externalConnectionPhoneNumber.civic_address_id);
}Returns: acquired_capabilities (array[string]), civic_address_id (uuid), displayed_country_code (string), location_id (uuid), number_id (string), telephone_number (string), ticket_id (uuid)
Retrieve a phone number
Return the details of a phone number associated with the given external connection.
GET /external_connections/{id}/phone_numbers/{phone_number_id}
const phoneNumber = await client.externalConnections.phoneNumbers.retrieve('1234567889', {
id: '1293384261075731499',
});
console.log(phoneNumber.data);Returns: acquired_capabilities (array[string]), civic_address_id (uuid), displayed_country_code (string), location_id (uuid), number_id (string), telephone_number (string), ticket_id (uuid)
Update a phone number
Asynchronously update settings of the phone number associated with the given external connection.
PATCH /external_connections/{id}/phone_numbers/{phone_number_id}
Optional: location_id (uuid)
const phoneNumber = await client.externalConnections.phoneNumbers.update('1234567889', {
id: '1293384261075731499',
});
console.log(phoneNumber.data);Returns: acquired_capabilities (array[string]), civic_address_id (uuid), displayed_country_code (string), location_id (uuid), number_id (string), telephone_number (string), ticket_id (uuid)
List all Releases
Returns a list of your Releases for the given external connection. These are automatically created when you change the connection_id of a phone number that is currently on Microsoft Teams.
GET /external_connections/{id}/releases
// Automatically fetches more pages as needed.
for await (const releaseListResponse of client.externalConnections.releases.list(
'1293384261075731499',
)) {
console.log(releaseListResponse.tenant_id);
}Returns: created_at (string), error_message (string), status (enum: pending_upload, pending, in_progress, complete, failed, expired, unknown), telephone_numbers (array[object]), tenant_id (uuid), ticket_id (uuid)
Retrieve a Release request
Return the details of a Release request and its phone numbers.
GET /external_connections/{id}/releases/{release_id}
const release = await client.externalConnections.releases.retrieve(
'7b6a6449-b055-45a6-81f6-f6f0dffa4cc6',
{ id: '1293384261075731499' },
);
console.log(release.data);Returns: created_at (string), error_message (string), status (enum: pending_upload, pending, in_progress, complete, failed, expired, unknown), telephone_numbers (array[object]), tenant_id (uuid), ticket_id (uuid)
List all Upload requests
Returns a list of your Upload requests for the given external connection.
GET /external_connections/{id}/uploads
// Automatically fetches more pages as needed.
for await (const upload of client.externalConnections.uploads.list('1293384261075731499')) {
console.log(upload.location_id);
}Returns: available_usages (array[string]), error_code (string), error_message (string), location_id (uuid), status (enum: pending_upload, pending, in_progress, partial_success, success, error), tenant_id (uuid), ticket_id (uuid), tn_upload_entries (array[object])
Creates an Upload request
Creates a new Upload request to Microsoft teams with the included phone numbers. Only one of civic_address_id or location_id must be provided, not both. The maximum allowed phone numbers for the numbers_ids array is 1000.
POST /external_connections/{id}/uploads — Required: number_ids
Optional: additional_usages (array[string]), civic_address_id (uuid), location_id (uuid), usage (enum: calling_user_assignment, first_party_app_assignment)
const upload = await client.externalConnections.uploads.create('1293384261075731499', {
number_ids: [
'3920457616934164700',
'3920457616934164701',
'3920457616934164702',
'3920457616934164703',
],
});
console.log(upload.ticket_id);Returns: success (boolean), ticket_id (uuid)
Refresh the status of all Upload requests
Forces a recheck of the status of all pending Upload requests for the given external connection in the background.
POST /external_connections/{id}/uploads/refresh
const response = await client.externalConnections.uploads.refreshStatus('1293384261075731499');
console.log(response.success);Returns: success (boolean)
Get the count of pending upload requests
Returns the count of all pending upload requests for the given external connection.
GET /external_connections/{id}/uploads/status
const response = await client.externalConnections.uploads.pendingCount('1293384261075731499');
console.log(response.data);Returns: pending_numbers_count (integer), pending_orders_count (integer)
Retrieve an Upload request
Return the details of an Upload request and its phone numbers.
GET /external_connections/{id}/uploads/{ticket_id}
const upload = await client.externalConnections.uploads.retrieve(
'7b6a6449-b055-45a6-81f6-f6f0dffa4cc6',
{ id: '1293384261075731499' },
);
console.log(upload.data);Returns: available_usages (array[string]), error_code (string), error_message (string), location_id (uuid), status (enum: pending_upload, pending, in_progress, partial_success, success, error), tenant_id (uuid), ticket_id (uuid), tn_upload_entries (array[object])
Retry an Upload request
If there were any errors during the upload process, this endpoint will retry the upload request. In some cases this will reattempt the existing upload request, in other cases it may create a new upload request. Please check the ticket_id in the response to determine if a new upload request was created.
POST /external_connections/{id}/uploads/{ticket_id}/retry
const response = await client.externalConnections.uploads.retry(
'7b6a6449-b055-45a6-81f6-f6f0dffa4cc6',
{ id: '1293384261075731499' },
);
console.log(response.data);Returns: available_usages (array[string]), error_code (string), error_message (string), location_id (uuid), status (enum: pending_upload, pending, in_progress, partial_success, success, error), tenant_id (uuid), ticket_id (uuid), tn_upload_entries (array[object])
List uploaded media
Returns a list of stored media files.
GET /media
const media = await client.media.list();
console.log(media.data);Returns: content_type (string), created_at (string), expires_at (string), media_name (string), updated_at (string)
Upload media
Upload media file to Telnyx so it can be used with other Telnyx services
POST /media — Required: media_url
Optional: media_name (string), ttl_secs (integer)
const response = await client.media.upload({ media_url: 'http://www.example.com/audio.mp3' });
console.log(response.data);Returns: content_type (string), created_at (string), expires_at (string), media_name (string), updated_at (string)
Retrieve stored media
Returns the information about a stored media file.
GET /media/{media_name}
const media = await client.media.retrieve('media_name');
console.log(media.data);Returns: content_type (string), created_at (string), expires_at (string), media_name (string), updated_at (string)
Update stored media
Updates a stored media file.
PUT /media/{media_name}
Optional: media_url (string), ttl_secs (integer)
const media = await client.media.update('media_name');
console.log(media.data);Returns: content_type (string), created_at (string), expires_at (string), media_name (string), updated_at (string)
Deletes stored media
Deletes a stored media file.
DELETE /media/{media_name}
await client.media.delete('media_name');Download stored media
Downloads a stored media file.
GET /media/{media_name}/download
const response = await client.media.download('media_name');
console.log(response);
const content = await response.blob();
console.log(content);Refresh Operator Connect integration
This endpoint will make an asynchronous request to refresh the Operator Connect integration with Microsoft Teams for the current user. This will create new external connections on the user's account if needed, and/or report the integration results as log messages.
POST /operator_connect/actions/refresh
const response = await client.operatorConnect.actions.refresh();
console.log(response.message);Returns: message (string), success (boolean)
List all recording transcriptions
Returns a list of your recording transcriptions.
GET /recording_transcriptions
// Automatically fetches more pages as needed.
for await (const recordingTranscription of client.recordingTranscriptions.list()) {
console.log(recordingTranscription.id);
}Returns: created_at (string), duration_millis (int32), id (string), record_type (enum: recording_transcription), recording_id (string), status (enum: in-progress, completed), transcription_text (string), updated_at (string)
Retrieve a recording transcription
Retrieves the details of an existing recording transcription.
GET /recording_transcriptions/{recording_transcription_id}
const recordingTranscription = await client.recordingTranscriptions.retrieve(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(recordingTranscription.data);Returns: created_at (string), duration_millis (int32), id (string), record_type (enum: recording_transcription), recording_id (string), status (enum: in-progress, completed), transcription_text (string), updated_at (string)
Delete a recording transcription
Permanently deletes a recording transcription.
DELETE /recording_transcriptions/{recording_transcription_id}
const recordingTranscription = await client.recordingTranscriptions.delete(
'6a09cdc3-8948-47f0-aa62-74ac943d6c58',
);
console.log(recordingTranscription.data);Returns: created_at (string), duration_millis (int32), id (string), record_type (enum: recording_transcription), recording_id (string), status (enum: in-progress, completed), transcription_text (string), updated_at (string)
List all call recordings
Returns a list of your call recordings.
GET /recordings
// Automatically fetches more pages as needed.
for await (const recordingResponseData of client.recordings.list()) {
console.log(recordingResponseData.id);
}Returns: call_control_id (string), call_leg_id (string), call_session_id (string), channels (enum: single, dual), conference_id (string), connection_id (string), created_at (string), download_urls (object), duration_millis (int32), from (string), id (string), initiated_by (string), record_type (enum: recording), recording_ended_at (string), recording_started_at (string), source (enum: conference, call), status (enum: completed), to (string), updated_at (string)
Delete a list of call recordings
Permanently deletes a list of call recordings.
POST /recordings/actions/delete
const action = await client.recordings.actions.delete({
ids: ['428c31b6-7af4-4bcb-b7f5-5013ef9657c1', '428c31b6-7af4-4bcb-b7f5-5013ef9657c2'],
});
console.log(action.status);Returns: status (enum: ok)
Retrieve a call recording
Retrieves the details of an existing call recording.
GET /recordings/{recording_id}
const recording = await client.recordings.retrieve('recording_id');
console.log(recording.data);Returns: call_control_id (string), call_leg_id (string), call_session_id (string), channels (enum: single, dual), conference_id (string), connection_id (string), created_at (string), download_urls (object), duration_millis (int32), from (string), id (string), initiated_by (string), record_type (enum: recording), recording_ended_at (string), recording_started_at (string), source (enum: conference, call), status (enum: completed), to (string), updated_at (string)
Delete a call recording
Permanently deletes a call recording.
DELETE /recordings/{recording_id}
const recording = await client.recordings.delete('recording_id');
console.log(recording.data);Returns: call_control_id (string), call_leg_id (string), call_session_id (string), channels (enum: single, dual), conference_id (string), connection_id (string), created_at (string), download_urls (object), duration_millis (int32), from (string), id (string), initiated_by (string), record_type (enum: recording), recording_ended_at (string), recording_started_at (string), source (enum: conference, call), status (enum: completed), to (string), updated_at (string)
Create a SIPREC connector
Creates a new SIPREC connector configuration.
POST /siprec_connectors
const siprecConnector = await client.siprecConnectors.create({
host: 'siprec.telnyx.com',
name: 'my-siprec-connector',
port: 5060,
});
console.log(siprecConnector.data);Returns: app_subdomain (string), created_at (string), host (string), name (string), port (integer), record_type (string), updated_at (string)
Retrieve a SIPREC connector
Returns details of a stored SIPREC connector.
GET /siprec_connectors/{connector_name}
const siprecConnector = await client.siprecConnectors.retrieve('connector_name');
console.log(siprecConnector.data);Returns: app_subdomain (string), created_at (string), host (string), name (string), port (integer), record_type (string), updated_at (string)
Update a SIPREC connector
Updates a stored SIPREC connector configuration.
PUT /siprec_connectors/{connector_name}
const siprecConnector = await client.siprecConnectors.update('connector_name', {
host: 'siprec.telnyx.com',
name: 'my-siprec-connector',
port: 5060,
});
console.log(siprecConnector.data);Returns: app_subdomain (string), created_at (string), host (string), name (string), port (integer), record_type (string), updated_at (string)
Delete a SIPREC connector
Deletes a stored SIPREC connector.
DELETE /siprec_connectors/{connector_name}
await client.siprecConnectors.delete('connector_name');