Maintainers
Pricing
Enterprise
More
More
Documentation
Try Live
Rankings
Install
Blog
Docs7
Ask
New
Add Docs
Telnyx Node
https://github.com/team-telnyx/telnyx-node
Admin
Node SDK for the Telnyx API
Tokens:
1,922,545
Snippets:
3,686
Trust Score:
9.8
License:
MIT
Update:
5 days ago
Context
Chat
Benchmark
66
Latest
Show doc for...
Code
Info
Show Results
Tokens:
Raw
Copy
Link
Tokens:
Raw
Copy
Link
### GET /requirements Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists requirements. Returns a paginated list of requirements. ```APIDOC ## GET /requirements ### Description Lists requirements. ### Method GET ### Endpoint /requirements ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **DocReqsRequirementsDefaultFlatPagination** (object) - The paginated list of requirements. ``` -------------------------------- ### GET /connections Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all connections. Returns a paginated list of connections. ```APIDOC ## [GET] /connections ### Description Lists all connections. Returns a paginated list of connections. ### Method GET ### Endpoint /connections ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **ConnectionsDefaultFlatPagination** - Paginated list of connections. ``` -------------------------------- ### GET /pricing/products/{slug} Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a specific pricing product by its slug. Use this endpoint to get detailed pricing information for a single product. ```APIDOC ## [GET] /pricing/products/{slug} ### Description Retrieves a specific pricing product by its slug. Use this endpoint to get detailed pricing information for a single product. ### Method GET ### Endpoint /pricing/products/{slug} ### Parameters #### Path Parameters - `slug` (string) - Required - The unique slug identifier of the pricing product. #### Query Parameters - `params` (object) - Optional - Additional query parameters. ### Response #### Success Response (200) - `ProductRetrieveResponse` - The pricing details for the specified product. ``` -------------------------------- ### GET /rooms Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all rooms. Returns a paginated list of rooms. ```APIDOC ## GET /rooms ### Description Lists all rooms. Returns a paginated list of rooms. ### Method GET ### Endpoint /rooms ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **RoomsDefaultFlatPagination** (object) - Paginated list of rooms. ``` -------------------------------- ### GET /ai/assistants Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all assistants. Returns an AssistantsList object. ```APIDOC ## [GET] /ai/assistants ### Description Lists all assistants. ### Method GET ### Endpoint /ai/assistants ### Response #### Success Response (200) - **AssistantsList** - List of assistants. ``` -------------------------------- ### GET /ai/integrations Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists integrations. Returns a list of integrations. ```APIDOC ## GET /ai/integrations ### Description Lists integrations. ### Method GET ### Endpoint /ai/integrations ### Response #### Success Response (200) Returns an `IntegrationListResponse` object. ``` -------------------------------- ### Setup: Install dependencies and run with environment variables Source: https://github.com/team-telnyx/telnyx-node/blob/master/examples/webrtc-login-token/README.md Install dependencies, set required environment variables (TELNYX_API_KEY, TELNYX_CONNECTION_ID), and start the server. Optionally set TELNYX_CREDENTIAL_ID to reuse an existing credential. ```bash npm install export TELNYX_API_KEY=KEY... export TELNYX_CONNECTION_ID=1234567890 # a credential connection npm start ``` -------------------------------- ### GET /pricing/products Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all available pricing products. This endpoint returns a paginated list of products with their pricing tiers. ```APIDOC ## [GET] /pricing/products ### Description Lists all available pricing products. This endpoint returns a paginated list of products with their pricing tiers. ### Method GET ### Endpoint /pricing/products ### Parameters #### Query Parameters - `params` (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - `ProductListResponse` - A paginated list of pricing products. ``` -------------------------------- ### downloadSample Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Downloads a sample of a voice clone. ```APIDOC ## GET /voice_clones/{id}/sample ### Description Downloads a sample of a voice clone. ### Method GET ### Endpoint /voice_clones/{id}/sample ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the voice clone. ### Response #### Success Response (200) - **Response** - The sample file. ``` -------------------------------- ### Install dependencies and start the server Source: https://github.com/team-telnyx/telnyx-node/blob/master/examples/webhook-verification/README.md Run npm install and then start the main script in package.json with tsx. ```bash npm install npm start ``` -------------------------------- ### GET /portouts Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists portouts. Returns a paginated list of portout details. ```APIDOC ## GET /portouts ### Description Lists portouts. ### Method GET ### Endpoint /portouts ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **PortoutDetailsDefaultFlatPagination** - Paginated list of portout details. ``` -------------------------------- ### Run the Addresses example with npm start Source: https://github.com/team-telnyx/telnyx-node/blob/master/examples/addresses/README.md Install dependencies and run the main script using ts-node. Requires a Telnyx API key set via the TELNYX_API_KEY environment variable. ```bash npm run start ``` -------------------------------- ### POST /bundle_pricing/user_bundles/bulk Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates user bundles in bulk. Returns the created user bundle resources. ```APIDOC ## [POST] /bundle_pricing/user_bundles/bulk ### Description Creates user bundles in bulk. Returns the created user bundle resources. ### Method POST ### Endpoint /bundle_pricing/user_bundles/bulk ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating user bundles in bulk. ### Response #### Success Response (200) - **UserBundleCreateResponse** - The created user bundle resources. ``` -------------------------------- ### Install and set API key Source: https://github.com/team-telnyx/telnyx-node/blob/master/examples/ai/README.md Install dependencies and set the TELNYX_API_KEY environment variable. Required before running any example. ```bash npm ci --ignore-scripts export TELNYX_API_KEY='your-api-key' ``` -------------------------------- ### create - POST /whatsapp/hosted_signups Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new hosted signup. This method initiates a hosted signup process. ```APIDOC ## POST /whatsapp/hosted_signups ### Description Creates a new hosted signup. ### Method POST ### Endpoint /whatsapp/hosted_signups ### Parameters #### Request Body - `params` (object) - Required - The parameters for creating a hosted signup. ### Response #### Success Response (200) Returns a `HostedSignupCreateResponse` object. ``` -------------------------------- ### GET /storage/cloudfs Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all Cloudfs filesystems. Returns a paginated list of Cloudfs filesystems. ```APIDOC ## GET /storage/cloudfs ### Description Lists all Cloudfs filesystems. Returns a paginated list of Cloudfs filesystems. ### Method GET ### Endpoint /storage/cloudfs ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **CloudfListResponsesCloudfsCursorPagination** - The paginated list of Cloudfs filesystems. ``` -------------------------------- ### POST /bot_signup Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a bot signup. This method is used to register a new bot. ```APIDOC ## POST /bot_signup ### Description Creates a bot signup. This method is used to register a new bot. ### Method POST ### Endpoint /bot_signup ### Parameters #### Request Body - **params** (object) - Required - The parameters for creating a bot signup. ### Response #### Success Response (200) - **SuccessResponse** (object) - The success response. ``` -------------------------------- ### Install from git Source: https://github.com/team-telnyx/telnyx-node/blob/master/CONTRIBUTING.md Installs the repository directly from GitHub via npm. ```sh $ npm install git+ssh://git@github.com:team-telnyx/telnyx-node.git ``` -------------------------------- ### Install dependencies and build Source: https://github.com/team-telnyx/telnyx-node/blob/master/CONTRIBUTING.md Sets up the repository by installing dependencies with pnpm and building output files to dist/. ```sh $ pnpm install $ pnpm build ``` -------------------------------- ### create /ai/assistants/{assistant_id}/canary-deploys Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a canary deploy for an assistant. Returns the canary deploy response. ```APIDOC ## POST /ai/assistants/{assistant_id}/canary-deploys ### Description Creates a canary deploy for an assistant. ### Method POST ### Endpoint /ai/assistants/{assistant_id}/canary-deploys ### Parameters #### Path Parameters - `assistant_id` (string) - Required - The ID of the assistant. #### Request Body - `params` (object) - Required - Parameters for creating the canary deploy. ### Response #### Success Response (200) - `CanaryDeployResponse` - The canary deploy response. ``` -------------------------------- ### Make example executable and run Source: https://github.com/team-telnyx/telnyx-node/blob/master/CONTRIBUTING.md Makes the example file executable and runs it against your API using pnpm tsn. ```sh $ chmod +x examples/<your-example>.ts # run the example against your api $ pnpm tsn -T examples/<your-example>.ts ``` -------------------------------- ### create Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new queue. Returns the created queue. ```APIDOC ## POST /queues ### Description Creates a new queue. ### Method POST ### Endpoint /queues ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating a queue. ### Response #### Success Response (200) Returns a QueueCreateResponse object. ``` -------------------------------- ### create Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new voice clone. ```APIDOC ## POST /voice_clones ### Description Creates a new voice clone. ### Method POST ### Endpoint /voice_clones ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating a voice clone. ### Response #### Success Response (200) - **VoiceCloneResponse** - The created voice clone. ``` -------------------------------- ### Add an example file Source: https://github.com/team-telnyx/telnyx-node/blob/master/CONTRIBUTING.md Template for adding a new example file in the examples/ directory. The shebang line enables running with pnpm tsn. ```ts // add an example to examples/<your-example>.ts #!/usr/bin/env -S npm run tsn -T … ``` -------------------------------- ### Install Telnyx with npm Source: https://github.com/team-telnyx/telnyx-node/blob/master/README.md Install the Telnyx Node.js library using npm. ```sh npm install telnyx ``` -------------------------------- ### POST /calls/{call_control_id}/actions/record_start Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Starts recording the call. This action begins capturing the audio of the call session. ```APIDOC ## [POST] /calls/{call_control_id}/actions/record_start ### Description Starts recording the call. This action begins capturing the audio of the call session. ### Method POST ### Endpoint /calls/{call_control_id}/actions/record_start ### Parameters #### Path Parameters - **call_control_id** (string) - Required - The unique identifier for the call control session. #### Request Body - **params** (object) - Required - The parameters for the record start action. ### Response #### Success Response (200) - **ActionStartRecordingResponse** (object) - The response object confirming recording started. ``` -------------------------------- ### get - GET /whatsapp/phone_numbers Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves WhatsApp phone numbers. This method returns phone number information. ```APIDOC ## [GET] /whatsapp/phone_numbers ### Description Retrieves WhatsApp phone numbers. ### Method GET ### Endpoint /whatsapp/phone_numbers ### Response #### Success Response (200) - **PhoneNumberGetResponse** - Phone number information ``` -------------------------------- ### POST /ai/assistants/import Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Imports assistants. Returns an AssistantsList object. ```APIDOC ## [POST] /ai/assistants/import ### Description Imports assistants. ### Method POST ### Endpoint /ai/assistants/import ### Parameters #### Request Body - **params** (object) - Required - Import parameters. ### Response #### Success Response (200) - **AssistantsList** - List of imported assistants. ``` -------------------------------- ### List available models Source: https://github.com/team-telnyx/telnyx-node/blob/master/examples/ai/README.md Run the default example to list available models, including IDs usable for chat. ```bash npm start ``` -------------------------------- ### list Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a list of media resources. This method corresponds to the GET /media endpoint. ```APIDOC ## GET /media ### Description Retrieves a list of media resources. ### Method GET ### Endpoint /media ### Parameters #### Query Parameters - **params** (object) - Required - Query parameters for filtering or pagination. ### Response #### Success Response (200) - **MediaListResponse** - The list of media resources. ``` -------------------------------- ### GET /storage/kvs Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all KV namespaces. Returns a paginated list of KV namespaces. ```APIDOC ## GET /storage/kvs ### Description Lists all KV namespaces. Returns a paginated list of KV namespaces. ### Method GET ### Endpoint /storage/kvs ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **data** (array) - List of KV namespaces. - **meta** (object) - Pagination metadata. ``` -------------------------------- ### GET /storage/sqldbs Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists SQL databases. Returns a paginated list of SQL databases. ```APIDOC ## GET /storage/sqldbs ### Description Lists SQL databases. Returns a paginated list of SQL databases. ### Method GET ### Endpoint /storage/sqldbs ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **SqlDatabasesDefaultFlatPagination** - Paginated list of SQL databases. ``` -------------------------------- ### downloadSample Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Downloads a sample of a voice design. ```APIDOC ## GET /voice_designs/{id}/sample ### Description Downloads a sample of a voice design. ### Method GET ### Endpoint /voice_designs/{id}/sample ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the voice design. #### Query Parameters - **params** (object) - Optional - Additional query parameters. ### Response #### Success Response (200) - **Response** - The sample file. ``` -------------------------------- ### GET /pay_connectors Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists pay connectors. Returns a paginated list of pay connectors. ```APIDOC ## GET /pay_connectors ### Description Lists pay connectors. Returns a paginated list of pay connectors. ### Method GET ### Endpoint /pay_connectors ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **PayConnectorsEmailBracketCursorPagination** (object) - The list of pay connectors. ``` -------------------------------- ### POST /room_compositions Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new room composition. ```APIDOC ## POST /room_compositions ### Description Creates a new room composition. ### Method POST ### Endpoint /room_compositions ### Parameters #### Request Body - **params** (object) - Required - The room composition creation parameters. ### Response #### Success Response (200) - **RoomCompositionCreateResponse** (object) - The created room composition. ``` -------------------------------- ### GET /dir/{dir_id}/comments Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists comments for a directory. This method is part of the Telnyx Node SDK and corresponds to the HTTP GET endpoint. ```APIDOC ## [GET] /dir/{dir_id}/comments ### Description Lists comments for a directory. ### Method GET ### Endpoint /dir/{dir_id}/comments ### Parameters #### Path Parameters - **dir_id** (string) - Required - The ID of the directory. ### Response #### Success Response (200) - **data** (array) - List of comments. ``` -------------------------------- ### GET /dir/{dir_id}/phone_numbers Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists phone numbers in a directory. This method is part of the Telnyx Node SDK and corresponds to the HTTP GET endpoint. ```APIDOC ## [GET] /dir/{dir_id}/phone_numbers ### Description Lists phone numbers in a directory. ### Method GET ### Endpoint /dir/{dir_id}/phone_numbers ### Parameters #### Path Parameters - **dir_id** (string) - Required - The ID of the directory. ### Response #### Success Response (200) - **data** (array) - List of phone numbers. ``` -------------------------------- ### POST /calls/{call_control_id}/actions/playback_start Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Starts playing an audio file on the call. This action initiates media playback to the caller. ```APIDOC ## [POST] /calls/{call_control_id}/actions/playback_start ### Description Starts playing an audio file on the call. This action initiates media playback to the caller. ### Method POST ### Endpoint /calls/{call_control_id}/actions/playback_start ### Parameters #### Path Parameters - **call_control_id** (string) - Required - The unique identifier for the call control session. #### Request Body - **params** (object) - Required - The parameters for the playback start action. ### Response #### Success Response (200) - **ActionStartPlaybackResponse** (object) - The response object confirming playback started. ``` -------------------------------- ### POST /ai/assistants Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new assistant. Returns an InferenceEmbedding object. ```APIDOC ## [POST] /ai/assistants ### Description Creates a new assistant. ### Method POST ### Endpoint /ai/assistants ### Parameters #### Request Body - **params** (object) - Required - Assistant creation parameters. ### Response #### Success Response (200) - **InferenceEmbedding** - The created assistant. ``` -------------------------------- ### GET /dir/{dir_id}/phone_number_batches Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists phone number batches for a directory. This method is part of the Telnyx Node SDK and corresponds to the HTTP GET endpoint. ```APIDOC ## [GET] /dir/{dir_id}/phone_number_batches ### Description Lists phone number batches for a directory. ### Method GET ### Endpoint /dir/{dir_id}/phone_number_batches ### Parameters #### Path Parameters - **dir_id** (string) - Required - The ID of the directory. ### Response #### Success Response (200) - **data** (array) - List of phone number batches. ``` -------------------------------- ### GET /room_compositions Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists room compositions. Returns a paginated list of room compositions. ```APIDOC ## GET /room_compositions ### Description Lists room compositions. ### Method GET ### Endpoint /room_compositions ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **RoomCompositionsDefaultFlatPagination** (object) - The paginated list of room compositions. ``` -------------------------------- ### Set Telnyx API key environment variable Source: https://github.com/team-telnyx/telnyx-node/blob/master/examples/connections/README.md Export your Telnyx API key before running the example. Replace KEY... with your actual key. ```bash export TELNYX_API_KEY=KEY... ``` -------------------------------- ### POST /storage/sqldbs Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new SQL database. Returns the created SQL database. ```APIDOC ## POST /storage/sqldbs ### Description Creates a new SQL database. Returns the created SQL database. ### Method POST ### Endpoint /storage/sqldbs ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating a SQL database. ### Response #### Success Response (200) - **SqlDatabaseResponseWrapper** - The created SQL database. ``` -------------------------------- ### GET /dir/{dir_id}/phone_number_batches/{batch_id} Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a specific phone number batch by ID. This method is part of the Telnyx Node SDK and corresponds to the HTTP GET endpoint. ```APIDOC ## [GET] /dir/{dir_id}/phone_number_batches/{batch_id} ### Description Retrieves a specific phone number batch by ID. ### Method GET ### Endpoint /dir/{dir_id}/phone_number_batches/{batch_id} ### Parameters #### Path Parameters - **dir_id** (string) - Required - The ID of the directory. - **batch_id** (string) - Required - The ID of the phone number batch. ### Response #### Success Response (200) - **data** (object) - The phone number batch details. ``` -------------------------------- ### POST /rooms Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new room. Returns the created room details. ```APIDOC ## POST /rooms ### Description Creates a new room. Returns the created room details. ### Method POST ### Endpoint /rooms ### Parameters #### Request Body - **params** (object) - Required - Room creation parameters. ### Response #### Success Response (200) - **RoomCreateResponse** (object) - The created room. ``` -------------------------------- ### Run offline regression tests Source: https://github.com/team-telnyx/telnyx-node/blob/master/examples/ai/README.md Build the SDK and run the example tests. These tests use fixtures and block real network connections, so they do not use your API key or make billable requests. ```bash pnpm build node --test examples/tests/list-examples.test.cjs ``` -------------------------------- ### list Versions Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all versions of a specific assistant. This method returns a list of assistant versions. ```APIDOC ## GET /ai/assistants/{assistant_id}/versions ### Description Lists all versions of a specific assistant. ### Method GET ### Endpoint /ai/assistants/{assistant_id}/versions ### Parameters #### Path Parameters - **assistant_id** (string) - Required - The ID of the assistant. ### Response #### Success Response (200) - **AssistantsList** - The list of versions. ``` -------------------------------- ### Send non-streaming chat completion Source: https://github.com/team-telnyx/telnyx-node/blob/master/examples/ai/README.md Set the model ID and run the chat example. Sends a real inference request and may incur charges; requests at most 128 completion tokens. Prints full JSON response including usage. ```bash export TELNYX_MODEL='your-model-id' npm run chat ``` -------------------------------- ### create Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new TeXML application. This method corresponds to the POST /texml_applications endpoint. ```APIDOC ## [POST] /texml_applications ### Description Creates a new TeXML application. ### Method POST ### Endpoint /texml_applications ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating the TeXML application. ### Response #### Success Response (200) - **TexmlApplicationCreateResponse** - The created TeXML application. ``` -------------------------------- ### GET /ai/embeddings/buckets Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists buckets. Returns a BucketListResponse. ```APIDOC ## GET /ai/embeddings/buckets ### Description Lists buckets. ### Method GET ### Endpoint /ai/embeddings/buckets ### Response #### Success Response (200) - **BucketListResponse** - The list of buckets. ``` -------------------------------- ### list - GET /whatsapp/signup Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists WhatsApp signups. This method retrieves a paginated list of signup records. ```APIDOC ## GET /whatsapp/signup ### Description Lists WhatsApp signups. ### Method GET ### Endpoint /whatsapp/signup ### Parameters #### Query Parameters - `params` (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) Returns a `SignupListResponsesDefaultFlatPagination` object. ``` -------------------------------- ### GET /ai/embeddings Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists embeddings. Returns an EmbeddingListResponse. ```APIDOC ## GET /ai/embeddings ### Description Lists embeddings. ### Method GET ### Endpoint /ai/embeddings ### Response #### Success Response (200) - **EmbeddingListResponse** - The list of embeddings. ``` -------------------------------- ### POST /calls/{call_control_id}/actions/siprec_start Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Starts SIPREC session recording. This action initiates metadata-rich recording of the call. ```APIDOC ## [POST] /calls/{call_control_id}/actions/siprec_start ### Description Starts SIPREC session recording. This action initiates metadata-rich recording of the call. ### Method POST ### Endpoint /calls/{call_control_id}/actions/siprec_start ### Parameters #### Path Parameters - **call_control_id** (string) - Required - The unique identifier for the call control session. #### Request Body - **params** (object) - Required - The parameters for the SIPREC start action. ### Response #### Success Response (200) - **ActionStartSiprecResponse** (object) - The response object confirming SIPREC recording started. ``` -------------------------------- ### GET /organizations/users/users_groups_report Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a report of user groups for the organization. ```APIDOC ## GET /organizations/users/users_groups_report ### Description Retrieves a report of user groups for the organization. ### Method GET ### Endpoint /organizations/users/users_groups_report ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for the report. ### Response #### Success Response (200) - **UserGetGroupsReportResponse** - The user groups report. ``` -------------------------------- ### POST /storage/cloudfs Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new Cloudfs filesystem. Returns the created filesystem wrapped in a response wrapper. ```APIDOC ## POST /storage/cloudfs ### Description Creates a new Cloudfs filesystem. Returns the created filesystem wrapped in a response wrapper. ### Method POST ### Endpoint /storage/cloudfs ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating the filesystem. ### Response #### Success Response (200) - **CloudfsFilesystemResponseWrapper** - The created filesystem wrapped in a response wrapper. ``` -------------------------------- ### GET /requirements/{id} Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a specific requirement by its ID. ```APIDOC ## GET /requirements/{id} ### Description Retrieves a specific requirement. ### Method GET ### Endpoint /requirements/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the requirement. #### Query Parameters - **params** (object) - Optional - Additional query parameters. ### Response #### Success Response (200) - **RequirementRetrieveResponse** (object) - The requirement details. ``` -------------------------------- ### POST /ai/mcp_servers Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new MCP server. Returns the created MCP server. ```APIDOC ## POST /ai/mcp_servers ### Description Creates a new MCP server. Returns the created MCP server. ### Method POST ### Endpoint /ai/mcp_servers ### Parameters #### Request Body - **params** (object) - Required - MCP server creation parameters. ### Response #### Success Response (200) - **McpServer** (object) - The created MCP server. ``` -------------------------------- ### POST /portouts/{id}/supporting_documents Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new supporting document for a specific portout. Returns the created supporting document. ```APIDOC ## POST /portouts/{id}/supporting_documents ### Description Creates a new supporting document for a specific portout. ### Method POST ### Endpoint /portouts/{id}/supporting_documents ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the portout. #### Request Body - **params** (object) - Required - Parameters for creating the supporting document. ### Response #### Success Response (200) - **SupportingDocumentCreateResponse** - The created supporting document. ``` -------------------------------- ### GET /speech-to-text/transcription Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a transcription. This method returns void. ```APIDOC ## [GET] /speech-to-text/transcription ### Description Retrieves a transcription. This method returns void. ### Method GET ### Endpoint /speech-to-text/transcription ### Parameters #### Query Parameters - **params** (object) - Required - Parameters for the request ### Response #### Success Response (200) - **void** - No response body ``` -------------------------------- ### GET /rcs/brands Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all RCS brands. Returns a BrandListResponse. ```APIDOC ## GET /rcs/brands ### Description Lists all RCS brands. ### Method GET ### Endpoint /rcs/brands ### Response #### Success Response (200) - **BrandListResponse** - List of brands ``` -------------------------------- ### list Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a paginated list of voice clones. ```APIDOC ## GET /voice_clones ### Description Retrieves a paginated list of voice clones. ### Method GET ### Endpoint /voice_clones ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **VoiceCloneDataDefaultFlatPagination** - Paginated list of voice clone data. ``` -------------------------------- ### GET /rcs/agents Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all RCS agents. Returns an AgentListResponse. ```APIDOC ## GET /rcs/agents ### Description Lists all RCS agents. ### Method GET ### Endpoint /rcs/agents ### Response #### Success Response (200) - **AgentListResponse** - List of agents ``` -------------------------------- ### list Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all profiles within a namespace. Returns a paginated list of profiles. ```APIDOC ## GET /ai/memory/namespaces/{namespace}/profiles ### Description Lists all profiles within a namespace. Returns a paginated list of profiles. ### Method GET ### Endpoint /ai/memory/namespaces/{namespace}/profiles ### Parameters #### Path Parameters - **namespace** (string) - Required - The namespace identifier. ### Response #### Success Response (200) - **ProfileListResponse** - The list of profiles. ``` -------------------------------- ### GET /bundle_pricing/user_bundles Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists user bundles. Returns a paginated list of user bundles. ```APIDOC ## [GET] /bundle_pricing/user_bundles ### Description Lists user bundles. Returns a paginated list of user bundles. ### Method GET ### Endpoint /bundle_pricing/user_bundles ### Parameters #### Query Parameters - **params** (object) - Required - Query parameters for filtering and pagination. ### Response #### Success Response (200) - **UserBundlesDefaultFlatPagination** - Paginated list of user bundles. ``` -------------------------------- ### Start a Call Control call Source: https://github.com/team-telnyx/telnyx-node/blob/master/README.md Dial a call using the Call Control API. ```ts const { data: call } = await client.calls.dial({ connection_id: 'your-connection-id', from: '+15551234567', to: '+15557654321', webhook_url: 'https://example.com/webhooks', }); ``` -------------------------------- ### GET /bundle_pricing/billing_bundles Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists billing bundles. Returns a paginated list of billing bundle summaries. ```APIDOC ## [GET] /bundle_pricing/billing_bundles ### Description Lists billing bundles. Returns a paginated list of billing bundle summaries. ### Method GET ### Endpoint /bundle_pricing/billing_bundles ### Parameters #### Query Parameters - **params** (object) - Required - Query parameters for filtering and pagination. ### Response #### Success Response (200) - **BillingBundleSummariesDefaultFlatPagination** - Paginated list of billing bundle summaries. ``` -------------------------------- ### sources.list Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all sources associated with a specific profile. Returns a paginated list of sources. ```APIDOC ## GET /ai/memory/namespaces/{namespace}/profiles/{profile_id}/sources ### Description Lists all sources associated with a specific profile. Returns a paginated list of sources. ### Method GET ### Endpoint /ai/memory/namespaces/{namespace}/profiles/{profile_id}/sources ### Parameters #### Path Parameters - **namespace** (string) - Required - The namespace identifier. - **profile_id** (string) - Required - The profile identifier. ### Response #### Success Response (200) - **SourceListResponse** - The list of sources. ``` -------------------------------- ### Run tests Source: https://github.com/team-telnyx/telnyx-node/blob/master/CONTRIBUTING.md Runs the test suite. ```sh $ pnpm run test ``` -------------------------------- ### create Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new fax application. This method corresponds to the POST /fax_applications endpoint. ```APIDOC ## [POST] /fax_applications ### Description Creates a new fax application. ### Method POST ### Endpoint /fax_applications ### Parameters #### Request Body - **params** (object) - Required - The fax application parameters. ### Response #### Success Response (200) - **FaxApplicationCreateResponse** (object) - The created fax application. ``` -------------------------------- ### GET /alphanumeric_sender_ids/{id} Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves an alphanumeric sender ID by ID. ```APIDOC ## GET /alphanumeric_sender_ids/{id} ### Description Retrieves an alphanumeric sender ID by ID. ### Method GET ### Endpoint /alphanumeric_sender_ids/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the alphanumeric sender ID to retrieve. ### Response #### Success Response (200) - **AlphanumericSenderIDRetrieveResponse** - The alphanumeric sender ID details. ``` -------------------------------- ### GET /organizations/users/{id} Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a specific organization user by ID. ```APIDOC ## GET /organizations/users/{id} ### Description Retrieves a specific organization user by ID. ### Method GET ### Endpoint /organizations/users/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the user to retrieve. #### Query Parameters - **params** (object) - Optional - Additional query parameters. ### Response #### Success Response (200) - **UserRetrieveResponse** - The user details. ``` -------------------------------- ### POST /ai/assistants/{assistant_id}/chat Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Starts a chat with an assistant. Returns an AssistantChatResponse object. ```APIDOC ## [POST] /ai/assistants/{assistant_id}/chat ### Description Starts a chat with an assistant. ### Method POST ### Endpoint /ai/assistants/{assistant_id}/chat ### Parameters #### Path Parameters - **assistant_id** (string) - Required - The ID of the assistant. #### Request Body - **params** (object) - Required - Chat parameters. ### Response #### Success Response (200) - **AssistantChatResponse** - Chat response. ``` -------------------------------- ### POST /authentication_providers Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new authentication provider. Returns the created authentication provider response. ```APIDOC ## POST /authentication_providers ### Description Creates a new authentication provider. Returns the created authentication provider response. ### Method POST ### Endpoint /authentication_providers ### Request Body - **params** (object) - Required - The parameters for creating an authentication provider. ### Response #### Success Response (200) - **AuthenticationProviderCreateResponse** (object) - The created authentication provider response. ### Request Example ``` client.authenticationProviders.create({ ...params }) ``` ### Response Example ``` AuthenticationProviderCreateResponse ``` ``` -------------------------------- ### GET /rooms/{room_id} Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves details of a specific room by its ID. ```APIDOC ## GET /rooms/{room_id} ### Description Retrieves details of a specific room by its ID. ### Method GET ### Endpoint /rooms/{room_id} ### Parameters #### Path Parameters - **room_id** (string) - Required - The ID of the room to retrieve. #### Query Parameters - **params** (object) - Optional - Additional query parameters. ### Response #### Success Response (200) - **RoomRetrieveResponse** (object) - The room details. ``` -------------------------------- ### create Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new porting order. This method corresponds to the POST /porting_orders endpoint. ```APIDOC ## POST /porting_orders ### Description Creates a new porting order. ### Method POST ### Endpoint /porting_orders ### Parameters #### Request Body - **params** (object) - Required - The porting order details. ### Response #### Success Response (200) - **PortingOrderCreateResponse** - The created porting order. ``` -------------------------------- ### GET /room_compositions/{room_composition_id} Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a specific room composition by its ID. ```APIDOC ## GET /room_compositions/{room_composition_id} ### Description Retrieves a specific room composition. ### Method GET ### Endpoint /room_compositions/{room_composition_id} ### Parameters #### Path Parameters - **room_composition_id** (string) - Required - The ID of the room composition. ### Response #### Success Response (200) - **RoomCompositionRetrieveResponse** (object) - The room composition details. ``` -------------------------------- ### create Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new API for the specified agent gateway instance. This method returns the created AgentGatewayAPIResponse. ```APIDOC ## [POST] /agent_gateways/{instance_id}/apis ### Description Creates a new API for the specified agent gateway instance. ### Method POST ### Endpoint /agent_gateways/{instance_id}/apis ### Parameters #### Path Parameters - **instanceID** (string) - Required - The ID of the agent gateway instance. #### Request Body - **params** (object) - Required - The parameters for creating the API. ### Response #### Success Response (200) - **AgentGatewayAPIResponse** - The created API. ``` -------------------------------- ### createFromUpload Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a voice clone from an uploaded file. ```APIDOC ## POST /voice_clones/from_upload ### Description Creates a voice clone from an uploaded file. ### Method POST ### Endpoint /voice_clones/from_upload ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating a voice clone from upload. ### Response #### Success Response (200) - **VoiceCloneResponse** - The created voice clone. ``` -------------------------------- ### GET /requirement_types/{id} Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves a specific requirement type by its ID. ```APIDOC ## GET /requirement_types/{id} ### Description Retrieves a specific requirement type. ### Method GET ### Endpoint /requirement_types/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the requirement type. ### Response #### Success Response (200) - **RequirementTypeRetrieveResponse** (object) - The requirement type details. ``` -------------------------------- ### POST /email/dedicated_ips/{id}/actions/start_warmup Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Starts the warmup process for a dedicated IP. This method is part of the DedicatedIPs Actions resource. ```APIDOC ## POST /email/dedicated_ips/{id}/actions/start_warmup ### Description Starts the warmup process for a dedicated IP. ### Method POST ### Endpoint /email/dedicated_ips/{id}/actions/start_warmup ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the dedicated IP. ### Response #### Success Response (200) - **DedicatedIPShowResponse** - The dedicated IP after warmup start. ``` -------------------------------- ### create Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new voice design. ```APIDOC ## POST /voice_designs ### Description Creates a new voice design. ### Method POST ### Endpoint /voice_designs ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating a voice design. ### Response #### Success Response (200) - **VoiceDesignResponse** - The created voice design. ``` -------------------------------- ### GET /charges_summary Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves the charges summary. Returns a ChargesSummaryRetrieveResponse object. ```APIDOC ## GET /charges_summary ### Description Retrieves the charges summary. Returns a ChargesSummaryRetrieveResponse object. ### Method GET ### Endpoint /charges_summary ### Parameters #### Query Parameters - **params** (object) - Required - Query parameters for the retrieve operation. ### Response #### Success Response (200) - **ChargesSummaryRetrieveResponse** - The charges summary data. ``` -------------------------------- ### POST /ai/fine_tuning/jobs Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new fine-tuning job. Returns the created fine-tuning job. ```APIDOC ## POST /ai/fine_tuning/jobs ### Description Creates a new fine-tuning job. ### Method POST ### Endpoint /ai/fine_tuning/jobs ### Parameters #### Request Body - `params` (object) - Required - Parameters for creating the job. ### Response #### Success Response (200) Returns a `FineTuningJob` object. ``` -------------------------------- ### GET /charges_breakdown Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Retrieves the charges breakdown. Returns a ChargesBreakdownRetrieveResponse object. ```APIDOC ## GET /charges_breakdown ### Description Retrieves the charges breakdown. Returns a ChargesBreakdownRetrieveResponse object. ### Method GET ### Endpoint /charges_breakdown ### Parameters #### Query Parameters - **params** (object) - Required - Query parameters for the retrieve operation. ### Response #### Success Response (200) - **ChargesBreakdownRetrieveResponse** - The charges breakdown data. ``` -------------------------------- ### GET /ai/missions/runs Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists all runs. Returns a paginated list of runs. ```APIDOC ## GET /ai/missions/runs ### Description Lists all runs. Returns a paginated list of runs. ### Method GET ### Endpoint /ai/missions/runs ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **MissionRunDataDefaultFlatPagination** (array) - Paginated list of runs. ``` -------------------------------- ### POST /pay_connectors Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new pay connector. Returns the created pay connector. ```APIDOC ## POST /pay_connectors ### Description Creates a new pay connector. Returns the created pay connector. ### Method POST ### Endpoint /pay_connectors ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating a pay connector. ### Response #### Success Response (200) - **PayConnectorResponse** (object) - The created pay connector. ``` -------------------------------- ### create Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Creates a new FQDN connection. This method corresponds to the POST /fqdn_connections endpoint. ```APIDOC ## POST /fqdn_connections ### Description Creates a new FQDN connection. ### Method POST ### Endpoint /fqdn_connections ### Parameters #### Request Body - **params** (object) - Required - Parameters for creating the FQDN connection. ### Response #### Success Response (200) - **FqdnConnectionCreateResponse** - The created FQDN connection. ``` -------------------------------- ### GET /ai/missions Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists missions. Returns a paginated list of missions. ```APIDOC ## GET /ai/missions ### Description Lists missions. Returns a paginated list of missions. ### Method GET ### Endpoint /ai/missions ### Parameters #### Query Parameters - **params** (object) - Optional - Query parameters for pagination and filtering. ### Response #### Success Response (200) - **MissionDataDefaultFlatPagination** (array) - Paginated list of missions. ``` -------------------------------- ### GET /ai/integrations/connections Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Lists integration connections. Returns a list of connections. ```APIDOC ## GET /ai/integrations/connections ### Description Lists integration connections. ### Method GET ### Endpoint /ai/integrations/connections ### Response #### Success Response (200) Returns a `ConnectionListResponse` object. ``` -------------------------------- ### POST /calls/{call_control_id}/actions/fork_start Source: https://github.com/team-telnyx/telnyx-node/blob/master/api.md Starts forking media from a call. This endpoint initiates media forking for the specified call control ID. ```APIDOC ## [POST] /calls/{call_control_id}/actions/fork_start ### Description Starts forking media from a call. This endpoint initiates media forking for the specified call control ID. ### Method POST ### Endpoint /calls/{call_control_id}/actions/fork_start ### Parameters #### Path Parameters - **call_control_id** (string) - Required - The unique identifier for the call control. #### Request Body - **params** (object) - Required - Additional parameters for the fork start action. ### Response #### Success Response (200) - **ActionStartForkingResponse** (object) - The response object for the fork start action. ```