Telnyx

Telnyx TeXML REST Commands API

TeXML REST Commands

GitHub OpenAPI

Operations 34

GET /texml/Accounts/{account_sid}/Calls Fetch multiple call resources #
POST /texml/Accounts/{account_sid}/Calls Initiate an outbound call #
GET /texml/Accounts/{account_sid}/Calls/{call_sid} Fetch a call #
POST /texml/Accounts/{account_sid}/Calls/{call_sid} Update call #
GET /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json Fetch recordings for a call #
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json Request recording for a call #
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json Update recording on a call #
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json Request siprec session for a call #
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec/{siprec_sid}.json Updates siprec session for a call #
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams.json Start streaming media from a call. #
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams/{streaming_sid}.json Update streaming on a call #
GET /texml/Accounts/{account_sid}/Conferences List conference resources #
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid} Fetch a conference resource #
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid} Update a conference resource #
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants List conference participants #
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants Dial a new conference participant #
DELETE /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label} Delete a conference participant #
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label} Get conference participant resource #
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label} Update a conference participant #
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings List conference recordings #
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json Fetch recordings for a conference #
GET /texml/Accounts/{account_sid}/Queues List queue resources #
POST /texml/Accounts/{account_sid}/Queues Create a new queue #
DELETE /texml/Accounts/{account_sid}/Queues/{queue_sid} Delete a queue resource #
GET /texml/Accounts/{account_sid}/Queues/{queue_sid} Fetch a queue resource #
POST /texml/Accounts/{account_sid}/Queues/{queue_sid} Update a queue resource #
GET /texml/Accounts/{account_sid}/Recordings.json Fetch multiple recording resources #
DELETE /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json Delete recording resource #
GET /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json Fetch recording resource #
GET /texml/Accounts/{account_sid}/Transcriptions.json List recording transcriptions #
DELETE /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json Delete a recording transcription #
GET /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json Fetch a recording transcription resource #
POST /texml/ai_calls/{connection_id} Initiate an outbound AI call #
POST /texml/secrets Create a TeXML secret #

Documentation

📖
Documentation
https://developers.telnyx.com/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/openapi/telnyx-texml-rest-commands-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/telnyx-texml-rest-commands-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

telnyx-texml-rest-commands-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@telnyx.com
  description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform.
  title: Telnyx TeXML REST Commands API
  version: 2.0.0
  x-endpoint-cost: light
servers:
- description: Version 2.0.0 of the Telnyx API
  url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: TeXML REST Commands
  name: TeXML REST Commands
paths:
  /texml/Accounts/{account_sid}/Calls:
    get:
      description: Returns multiple call resouces for an account. This endpoint is eventually consistent.
      operationId: GetTexmlCalls
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PageToken'
      - $ref: '#/components/parameters/To'
      - $ref: '#/components/parameters/From'
      - $ref: '#/components/parameters/Status'
      - $ref: '#/components/parameters/StartTime'
      - $ref: '#/components/parameters/StartTime_gt'
      - $ref: '#/components/parameters/StartTime_lt'
      - $ref: '#/components/parameters/EndTime'
      - $ref: '#/components/parameters/EndTime_gt'
      - $ref: '#/components/parameters/EndTime_lt'
      responses:
        '200':
          $ref: '#/components/responses/GetCallsResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch multiple call resources
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    post:
      description: Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal.
      operationId: InitiateTexmlCall
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitiateCallRequest'
        description: Iniatiate Call request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/InitiateCallResponse'
        '422':
          $ref: '#/components/responses/call-scripting_UnprocessableEntityResponse'
      summary: Initiate an outbound call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Calls/{call_sid}:
    get:
      description: Returns an individual call identified by its CallSid. This endpoint is eventually consistent.
      operationId: GetTexmlCall
      parameters:
      - $ref: '#/components/parameters/CallSid'
      - $ref: '#/components/parameters/AccountSid'
      responses:
        '200':
          $ref: '#/components/responses/GetCallResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch a call
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    post:
      description: Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example.
      operationId: UpdateTexmlCall
      parameters:
      - $ref: '#/components/parameters/CallSid'
      - $ref: '#/components/parameters/AccountSid'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateCallRequest'
        description: Update Call request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/GetCallResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
        '422':
          $ref: '#/components/responses/call-scripting_UnprocessableEntityResponse'
      summary: Update call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json:
    get:
      description: Returns recordings for a call identified by call_sid.
      operationId: FetchTeXMLCallRecordings
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/CallSid'
      responses:
        '200':
          $ref: '#/components/responses/TexmlGetCallRecordingsResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch recordings for a call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
    post:
      description: Starts recording with specified parameters for call idientified by call_sid.
      operationId: StartTeXMLCallRecording
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/CallSid'
      requestBody:
        $ref: '#/components/requestBodies/TexmlCreateCallRecordingRequest'
      responses:
        '200':
          $ref: '#/components/responses/TexmlCreateCallRecordingResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Request recording for a call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json:
    post:
      description: Updates recording resource for particular call.
      operationId: UpdateTeXMLCallRecording
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/CallSid'
      - $ref: '#/components/parameters/RecordingSid'
      requestBody:
        $ref: '#/components/requestBodies/TexmlUpdateCallRecordingRequest'
      responses:
        '200':
          $ref: '#/components/responses/TexmlCreateCallRecordingResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Update recording on a call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json:
    post:
      description: Starts siprec session with specified parameters for call idientified by call_sid.
      operationId: StartTeXMLSiprecSession
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/CallSid'
      requestBody:
        $ref: '#/components/requestBodies/TexmlCreateSiprecSessionRequest'
      responses:
        '200':
          $ref: '#/components/responses/TexmlCreateSiprecSessionResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Request siprec session for a call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec/{siprec_sid}.json:
    post:
      description: Updates siprec session identified by siprec_sid.
      operationId: UpdateTeXMLSiprecSession
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/CallSid'
      - $ref: '#/components/parameters/SiprecSid'
      requestBody:
        $ref: '#/components/requestBodies/TexmlUpdateSiprecSessionRequest'
      responses:
        '200':
          $ref: '#/components/responses/TexmlUpdateSiprecSessionResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Updates siprec session for a call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams.json:
    post:
      description: Starts streaming media from a call to a specific WebSocket address.
      operationId: StartTeXMLCallStreaming
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/CallSid'
      requestBody:
        $ref: '#/components/requestBodies/TexmlCreateCallStreamingRequest'
      responses:
        '200':
          $ref: '#/components/responses/TexmlCreateCallStreamingResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Start streaming media from a call.
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams/{streaming_sid}.json:
    post:
      description: Updates streaming resource for particular call.
      operationId: UpdateTeXMLCallStreaming
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/CallSid'
      - $ref: '#/components/parameters/StreamingSid'
      requestBody:
        $ref: '#/components/requestBodies/TexmlUpdateCallStreamingRequest'
      responses:
        '200':
          $ref: '#/components/responses/TexmlUpdateCallStreamingResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Update streaming on a call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Conferences:
    get:
      description: Lists conference resources.
      operationId: GetTexmlConferences
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PageToken'
      - $ref: '#/components/parameters/FriendlyName'
      - $ref: '#/components/parameters/ConferenceStatus'
      - $ref: '#/components/parameters/DateCreated'
      - $ref: '#/components/parameters/DateUpdated'
      responses:
        '200':
          $ref: '#/components/responses/GetConferencesResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: List conference resources
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Conferences/{conference_sid}:
    get:
      description: Returns a conference resource.
      operationId: GetTexmlConference
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      responses:
        '200':
          $ref: '#/components/responses/GetConferenceResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch a conference resource
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    post:
      description: Updates a conference resource.
      operationId: UpdateTexmlConference
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/call-scripting_UpdateConferenceRequest'
        description: Update Conference request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/GetConferenceResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Update a conference resource
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants:
    get:
      description: Lists conference participants
      operationId: GetTexmlConferenceParticipants
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      responses:
        '200':
          $ref: '#/components/responses/GetParticipantsResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: List conference participants
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    post:
      description: Dials a new conference participant
      operationId: DialTexmlConferenceParticipant
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DialConferenceParticipantRequest'
        description: Dial Conference Participant request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/DialParticipantResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Dial a new conference participant
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}:
    delete:
      description: Deletes a conference participant
      operationId: DeleteTexmlConferenceParticipant
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      - $ref: '#/components/parameters/CallSidOrParticipantLabel'
      responses:
        '204':
          description: The resource was deleted successfully.
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Delete a conference participant
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    get:
      description: Gets conference participant resource
      operationId: GetTexmlConferenceParticipant
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      - $ref: '#/components/parameters/CallSidOrParticipantLabel'
      responses:
        '200':
          $ref: '#/components/responses/GetParticipantResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Get conference participant resource
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    post:
      description: Updates a conference participant
      operationId: UpdateTexmlConferenceParticipant
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      - $ref: '#/components/parameters/CallSidOrParticipantLabel'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/call-scripting_UpdateConferenceParticipantRequest'
        description: Update Conference Participant request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/GetParticipantResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Update a conference participant
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings:
    get:
      description: Lists conference recordings
      operationId: GetTexmlConferenceRecordings
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      responses:
        '200':
          $ref: '#/components/responses/GetConferenceRecordingsResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: List conference recordings
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json:
    get:
      description: Returns recordings for a conference identified by conference_sid.
      operationId: FetchTeXMLConferenceRecordings
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/ConferenceSid'
      responses:
        '200':
          $ref: '#/components/responses/TexmlGetCallRecordingsResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch recordings for a conference
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Queues:
    get:
      description: Lists queue resources.
      operationId: GetTexmlQueues
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PageToken'
      - $ref: '#/components/parameters/DateCreated'
      - $ref: '#/components/parameters/DateUpdated'
      responses:
        '200':
          $ref: '#/components/responses/GetQueuesResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: List queue resources
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    post:
      description: Creates a new queue resource.
      operationId: CreateTexmlQueue
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/call-scripting_CreateQueueRequest'
        description: Create Queue request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/GetQueueResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Create a new queue
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Queues/{queue_sid}:
    delete:
      description: Delete a queue resource.
      operationId: DeleteTexmlQueue
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/QueueSid'
      responses:
        '204':
          description: The resource was deleted successfully.
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Delete a queue resource
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    get:
      description: Returns a queue resource.
      operationId: GetTexmlQueue
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/QueueSid'
      responses:
        '200':
          $ref: '#/components/responses/GetQueueResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch a queue resource
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
    post:
      description: Updates a queue resource.
      operationId: UpdateTexmlQueue
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/QueueSid'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/call-scripting_UpdateQueueRequest'
        description: Update Queue request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/GetQueueResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Update a queue resource
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Recordings.json:
    get:
      description: Returns multiple recording resources for an account.
      operationId: GetTeXMLCallRecordings
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PageSizeTexml'
      - $ref: '#/components/parameters/TexmlDateCreated'
      responses:
        '200':
          $ref: '#/components/responses/TexmlGetCallRecordingsResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch multiple recording resources
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json:
    delete:
      description: Deletes recording resource identified by recording id.
      operationId: DeleteTeXMLCallRecording
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/RecordingSid'
      responses:
        '204':
          description: The resource was deleted successfully.
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Delete recording resource
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
    get:
      description: Returns recording resource identified by recording id.
      operationId: GetTeXMLCallRecording
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/RecordingSid'
      responses:
        '200':
          $ref: '#/components/responses/TexmlGetCallRecordingResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch recording resource
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Transcriptions.json:
    get:
      description: Returns multiple recording transcription resources for an account.
      operationId: GetTeXMLRecordingTranscriptions
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/PageToken'
      - $ref: '#/components/parameters/PageSize'
      responses:
        '200':
          $ref: '#/components/responses/TexmlListRecordingTranscriptionResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: List recording transcriptions
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json:
    delete:
      description: Permanently deletes a recording transcription.
      operationId: DeleteTeXMLRecordingTranscription
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/RecordingTranscriptionSid'
      responses:
        '204':
          description: The resource was deleted successfully.
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Delete a recording transcription
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
    get:
      description: Returns the recording transcription resource identified by its ID.
      operationId: GetTeXMLRecordingTranscription
      parameters:
      - $ref: '#/components/parameters/AccountSid'
      - $ref: '#/components/parameters/RecordingTranscriptionSid'
      responses:
        '200':
          $ref: '#/components/responses/TexmlGetRecordingTranscriptionResponse'
        '404':
          $ref: '#/components/responses/call-scripting_NotFoundResponse'
      summary: Fetch a recording transcription resource
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/ai_calls/{connection_id}:
    post:
      description: Initiate an outbound AI call with warm-up support. Validates parameters, builds an internal TeXML with an AI Assistant configuration, encodes instructions into client state, and calls the dial API. The Twiml, Texml, and Url parameters are not allowed and will result in a 422 error.
      operationId: InitiateTexmlAICall
      parameters:
      - description: The ID of the TeXML connection to use for the call.
        in: path
        name: connection_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitiateAICallRequest'
        description: Initiate AI Call request object
        required: true
      responses:
        '200':
          $ref: '#/components/responses/InitiateAICallResponse'
        '401':
          $ref: '#/components/responses/UnauthenticatedResponse'
        '422':
          $ref: '#/components/responses/call-scripting_UnprocessableEntityResponse'
      summary: Initiate an outbound AI call
      tags:
      - TeXML REST Commands
      x-group-parameters: 'true'
      x-latency-category: responsive
  /texml/secrets:
    post:
      description: Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to use your secret name, and this name will be replaced by the actual secret value when processing the TeXML on Telnyx side.  The secrets are not visible in any logs.
      operationId: CreateTexmlSecret
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTeXMLSecretRequest'
        description: Create TeXML secret request object
        required: true
      responses:
        '201':
          $ref: '#/components/responses/CreateTeXMLSecretResponse'
        '422':
          $ref: '#/components/responses/call-scripting_UnprocessableEntityResponse'
      summary: Create a TeXML secret
      tags:
      - TeXML REST Commands
      x-latency-category: responsive
components:
  schemas:
    DateTimeRFC2822:
      example: '2023-08-11T19:12:11Z'
      format: date-time
      type: string
    ConferenceResource:
      example:
        account_sid: 4e71926f-8f13-450e-b91c-23c2ef786aa6
        api_version: v2/texml
        date_created: Fri, 27 Oct 2023 07:41:58 +0000
        date_updated: Fri, 27 Oct 2023 07:41:58 +0000
        friendly_name: weekly_review_call
        region: dc2
        sid: cd5a70f4-759b-4d5e-9c06-88c00f16f3c1
        status: in-progress
        subresource_uris:
          participants: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants.json
          recordings: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Recordings.json
        uri: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1.json
      properties:
        account_sid:
          description: The id of the account the resource belongs to.
          example: 61bf923e-5e4d-4595-a110-56190ea18a1b
          type: string
        api_version:
          description: The version of the API that was used to make the request.
          example: v2/texml
          type: string
        call_sid_ending_conference:
          description: Caller ID, if present.
          example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ
          type: string
        date_created:
          description: The timestamp of when the resource was created.
          example: Thu, 15 Jun 2023 09:56:45 +0000
          type: string
        date_updated:
          description: The timestamp of when the resource was last updated.
          example: Thu, 15 Jun 2023 09:56:45 +0000
          type: string
        friendly_name:
          description: A string that you assigned to describe this conference room.
          example: weekly_review_call
          type: string
        reason_conference_ended:
          description: The reason why a conference ended. When a conference is in progress, will be null.
          enum:
          - participant-with-end-conference-on-exit-left
          - last-participant-left
          - conference-ended-via-api
          - time-exceeded
          example: time-exceeded
          type: string
        region:
          description: A string representing the region where the conference is hosted.
          example: dc2
          type: string
        sid:
          description: The unique identifier of the conference.
          example: cd5a70f4-759b-4d5e-9c06-88c00f16f3c1
          type: string
        status:
          description: The status of this conference.
          enum:
          - init
          - in-progress
          - completed
          example: in-progress
          type: string
        subresource_uris:
          additionalProperties: true
          description: A list of related resources identified by their relative URIs.
          example:
            participants: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants.json
            recordings: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Recordings.json
          type: object
        uri:
          description: The relative URI for this conference.
          example: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1.json
          type: string
      title: Conference resource
      type: object
    TexmlBidirectionalStreamCodec:
      default: PCMU
      description: Indicates codec for bidirectional streaming RTP payloads. Used only with stream_bidirectional_mode=rtp. Case sensitive.
      enum:
      - PCMU
      - PCMA
      - G722
      example: G722
      title: Stream Bidirectional Codec
      type: string
    TexmlCreateSiprecSessionRequestBody:
      properties:
        ConnectorName:
          description: The name of the connector to use for the SIPREC session.
          example: my_connector
          type: string
        IncludeMetadataCustomHeaders:
          description: When set, custom parameters will be added as metadata (recording.session.ExtensionParameters). Otherwise, they’ll be added to sip headers.
          enum:
          - true
          - false
          example: true
          type: boolean
        Name:
          description: Name of the SIPREC session. May be used to stop the SIPREC session from TeXML instruction.
          example: my_siprec_session
          type: string
        Secure:
          description: Controls whether to encrypt media sent to your SRS using SRTP and TLS. When set you need to configure SRS port in your connector to 5061.
          enum:
          - true
          - false
          example: true
          type: boolean
        SessionTimeoutSecs:
          default: 1800
          description: Sets `Session-Expires` header to the INVITE. A reinvite is sent every half the value set. Usefull for session keep alive. Minimum value is 90, set to 0 to disable.
          example: 900
          type: integer
        SipTransport:
          default: udp
          description: Specifies SIP transport protocol.
          enum:
          - udp
          - tcp
          - tls
          example: tcp
          type: string
        StatusCallback:
          description: URL destination for Telnyx to send status callback events to for the siprec session.
          example: https://www.example.com/callback
          type: string
        StatusCallbackMethod:
          description: HTTP request type used for `StatusCallback`.
          enum:
          - GET
          - POST
          example: GET
          type: string
        Track:
          description: The track to be used for siprec session. Can be `both_tracks`, `inbound_track` or `outbound_track`. Defaults to `both_tracks`.
          enum:
          - both_tracks
          - inbound_track
          - outbound_track
          example: both_tracks
          type: string
      title: Create Siprec Session Request
      type: object
    CallControlId:
      example: v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA
      type: string
    ErrorResponse:
      properties:
        errors:
          items:
            pro

# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/openapi/telnyx-texml-rest-commands-api-openapi.yml