telnyx-texml-javascript

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. --> # Telnyx Texml - JavaScript ## Installation ```bash npm install telnyx ``` ## Setup ```javascript 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. ## List all TeXML Applications Returns a list of your TeXML Applications. `GET /texml_applications` ```javascript // Automatically fetches more pages as needed. for await (const texmlApplication of client.texmlApplications.list()) { console.log(texmlApplication.id); } ``` ## Creates a TeXML Application Creates a TeXML Application. `POST /texml_applications` — Required: `friendly_name`, `voice_url` ```javascript const texmlApplication = await client.texmlApplications.create({ friendly_name: 'call-router', voice_url: 'https://example.com', }); console.log(texmlApplication.data); ``` ## Retrieve a TeXML Application Retrieves the details of an existing TeXML Application. `GET /texml_applications/{id}` ```javascript const texmlApplication = await client.texmlApplications.retrieve('1293384261075731499'); console.log(texmlApplication.data); ``` ## Update a TeXML Application Updates settings of an existing TeXML Application. `PATCH /texml_applications/{id}` — Required: `friendly_name`, `voice_url` ```javascript const texmlApplication = await client.texmlApplications.update('1293384261075731499', { friendly_name: 'call-router', voice_url: 'https://example.com', }); console.log(texmlApplication.data); ``` ## Deletes a TeXML Application Deletes a TeXML Application. `DELETE /texml_applications/{id}` ```javascript const texmlApplication = await client.texmlApplications.delete('1293384261075731499'); console.log(texmlApplication.data); ``` ## Fetch multiple call resources Returns multiple call resources for an account. `GET /texml/Accounts/{account_sid}/Calls` ```javascript const response = await client.texml.accounts.calls.retrieveCalls('account_sid'); console.log(response.calls); ``` ## Initiate an outbound call Initiate an outbound TeXML call. `POST /texml/Accounts/{account_sid}/Calls` — Required: `To`, `From`, `ApplicationSid` ```javascript const response = await client.texml.accounts.calls.calls('account_sid', { ApplicationSid: 'example-app-sid', From: '+13120001234', To: '+13121230000', }); console.log(response.from); ``` ## Fetch a call Returns an individual call identified by its CallSid. `GET /texml/Accounts/{account_sid}/Calls/{call_sid}` ```javascript const call = await client.texml.accounts.calls.retrieve('call_sid', { account_sid: 'account_sid' }); console.log(call.account_sid); ``` ## Update call Update TeXML call. `POST /texml/Accounts/{account_sid}/Calls/{call_sid}` ```javascript const call = await client.texml.accounts.calls.update('call_sid', { account_sid: 'account_sid' }); console.log(call.account_sid); ``` ## List conference participants Lists conference participants `GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants` ```javascript const response = await client.texml.accounts.conferences.participants.retrieveParticipants( 'conference_sid', { account_sid: 'account_sid' }, ); console.log(response.end); ``` ## Dial a new conference participant Dials a new conference participant `POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants` ```javascript const response = await client.texml.accounts.conferences.participants.participants( 'conference_sid', { account_sid: 'account_sid' }, ); console.log(response.account_sid); ``` ## Get conference participant resource Gets conference participant resource `GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}` ```javascript const participant = await client.texml.accounts.conferences.participants.retrieve( 'call_sid_or_participant_label', { account_sid: 'account_sid', conference_sid: 'conference_sid' }, ); console.log(participant.account_sid); ``` ## Update a conference participant Updates a conference participant `POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}` ```javascript const participant = await client.texml.accounts.conferences.participants.update( 'call_sid_or_participant_label', { account_sid: 'account_sid', conference_sid: 'conference_sid' }, ); console.log(participant.account_sid); ``` ## Delete a conference participant Deletes a conference participant `DELETE /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}` ```javascript await client.texml.accounts.conferences.participants.delete('call_sid_or_participant_label', { account_sid: 'account_sid', conference_sid: 'conference_sid', }); ``` ## List conference resources Lists conference resources. `GET /texml/Accounts/{account_sid}/Conferences` ```javascript const response = await client.texml.accounts.conferences.retrieveConferences('account_sid'); console.log(response.conferences); ``` ## Fetch a conference resource Returns a conference resource. `GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}` ```javascript const conference = await client.texml.accounts.conferences.retrieve('conference_sid', { account_sid: 'account_sid', }); console.log(conference.account_sid); ``` ## Update a conference resource Updates a conference resource. `POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}` ```javascript const conference = await client.texml.accounts.conferences.update('conference_sid', { account_sid: 'account_sid', }); console.log(conference.account_sid); ``` ## List queue resources Lists queue resources. `GET /texml/Accounts/{account_sid}/Queues` ```javascript // Automatically fetches more pages as needed. for await (const queueListResponse of client.texml.accounts.queues.list('account_sid')) { console.log(queueListResponse.account_sid); } ``` ## Create a new queue Creates a new queue resource. `POST /texml/Accounts/{account_sid}/Queues` ```javascript const queue = await client.texml.accounts.queues.create('account_sid'); console.log(queue.account_sid); ``` ## Fetch a queue resource Returns a queue resource. `GET /texml/Accounts/{account_sid}/Queues/{queue_sid}` ```javascript const queue = await client.texml.accounts.queues.retrieve('queue_sid', { account_sid: 'account_sid', }); console.log(queue.account_sid); ``` ## Update a queue resource Updates a queue resource. `POST /texml/Accounts/{account_sid}/Queues/{queue_sid}` ```javascript const queue = await client.texml.accounts.queues.update('queue_sid', { account_sid: 'account_sid', }); console.log(queue.account_sid); ``` ## Delete a queue resource Delete a queue resource. `DELETE /texml/Accounts/{account_sid}/Queues/{queue_sid}` ```javascript await client.texml.accounts.queues.delete('queue_sid', { account_sid: 'account_sid' }); ``` ## Fetch multiple recording resources Returns multiple recording resources for an account. `GET /texml/Accounts/{account_sid}/Recordings.json` ```javascript const response = await client.texml.accounts.retrieveRecordingsJson('account_sid'); console.log(response.end); ``` ## Fetch recording resource Returns recording resource identified by recording id. `GET /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json` ```javascript const texmlGetCallRecordingResponseBody = await client.texml.accounts.recordings.json.retrieveRecordingSidJson( '6a09cdc3-8948-47f0-aa62-74ac943d6c58', { account_sid: 'account_sid' }, ); console.log(texmlGetCallRecordingResponseBody.account_sid); ``` ## Delete recording resource Deletes recording resource identified by recording id. `DELETE /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json` ```javascript await client.texml.accounts.recordings.json.deleteRecordingSidJson( '6a09cdc3-8948-47f0-aa62-74ac943d6c58', { account_sid: 'account_sid' }, ); ``` ## Fetch recordings for a call Returns recordings for a call identified by call_sid. `GET /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json` ```javascript const response = await client.texml.accounts.calls.recordingsJson.retrieveRecordingsJson( 'call_sid', { account_sid: 'account_sid' }, ); console.log(response.end); ``` ## Request recording for a call Starts recording with specified parameters for call idientified by call_sid. `POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json` ```javascript const response = await client.texml.accounts.calls.recordingsJson.recordingsJson('call_sid', { account_sid: 'account_sid', }); console.log(response.account_sid); ``` ## Update recording on a call Updates recording resource for particular call. `POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json` ```javascript const response = await client.texml.accounts.calls.recordings.recordingSidJson( '6a09cdc3-8948-47f0-aa62-74ac943d6c58', { account_sid: 'account_sid', call_sid: 'call_sid' }, ); console.log(response.account_sid); ``` ## List conference recordings Lists conference recordings `GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings` ```javascript const response = await client.texml.accounts.conferences.retrieveRecordings('conference_sid', { account_sid: 'account_sid', }); console.log(response.end); ``` ## Fetch recordings for a conference Returns recordings for a conference identified by conference_sid. `GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json` ```javascript const response = await client.texml.accounts.conferences.retrieveRecordingsJson('conference_sid', { account_sid: 'account_sid', }); console.log(response.end); ``` ## Create a TeXML secret Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. `POST /texml/secrets` — Required: `name`, `value` ```javascript const response = await client.texml.secrets({ name: 'My Secret Name', value: 'My Secret Value' }); console.log(response.data); ``` ## Request siprec session for a call Starts siprec session with specified parameters for call idientified by call_sid. `POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json` ```javascript const response = await client.texml.accounts.calls.siprecJson('call_sid', { account_sid: 'account_sid', }); console.log(response.account_sid); ```