Telnyx TeXML REST Commands API

openapi: 3.1.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 Access Tokens 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:
    DialConferenceParticipantRequest:
      example:
        From: '+12065550200'
        To: '+12065550100'
      properties:
        AmdStatusCallback:
          description: The URL the result of answering machine detection will be sent to.
          example: https://www.example.com/amd_result
          type: string
        AmdStatusCallbackMethod:
          description: HTTP request type used for `AmdStatusCallback`. Defaults to `POST`.
          enum:
          - GET
          - POST
          example: GET
          type: string
        ApplicationSid:
          description: The SID of the TeXML application that will handle the new participant's call. Required unless joining an existing conference by its ConferenceSid.
          example: '1846572522338780702'
          type: string
        Beep:
          description: Whether to play a notification beep to the conference when the participant enters and exits.
          enum:
          - 'true'
          - 'false'
          - onEnter
          - onExit
          example: onExit
          type: string
        CallSidToCoach:
          description: The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.
          example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ
          type: string
        CallerId:
          description: To be used as the caller id name (SIP From Display Name) presented to the destination (`To` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and `-_~!.+` special characters. If ommited, the display name will be the same as the number in the `From` field.
          example: Info
          type: string
        CancelPlaybackOnDetectMessageEnd:
          default: true
          description: Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`.
          example: false
          type: boolean
        CancelPlaybackOnMachineDetection:
          default: true
          description: Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
          example: false
          type: boolean
        Coaching:
          description: Whether the participant is coaching another call. When `true`, `CallSidToCoach` has to be given.
          example: false
          type: boolean
        ConferenceRecord:
          description: Whether to record the conference the participant is joining. Defualts to `do-not-record`. The boolean values `true` and `false` are synonymous with `record-from-start` and `do-not-record` respectively.
          enum:
          - 'true'
          - 'false'
          - record-from-start
          - do-not-record
          example: record-from-start
          type: string
        ConferenceRecordingStatusCallback:
          description: The URL the conference recording callbacks will be sent to.
          example: https://example.com/conference_recording_status_callback
          type: string
        ConferenceRecordingStatusCallbackEvent:
          description: 'The changes to the conference recording''s state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`. `failed` and `absent` are synonymous.'
          example: in-progress completed failed absent
          type: string
        ConferenceRecordingStatusCallbackMethod:
          description: HTTP request type used for `ConferenceRecordingStatusCallback`. Defaults to `POST`.
          enum:
          - GET
          - POST
          example: GET
          type: string
        ConferenceRecordingTimeout:
          default: 0
          description: The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)
          example: 5
          type: integer
        ConferenceStatusCallback:
          description: The URL the conference callbacks will be sent to.
          example: https://example.com/conference_status_callback
          type: string
        ConferenceStatusCallbackEvent:
          description: 'The changes to the conference''s state that should generate a call to `ConferenceStatusCallback`. Can be: `start`, `end`, `join` and `leave`. Separate multiple values with a space. By default no callbacks are sent.'
          example: start end join leave
          type: string
        ConferenceStatusCallbackMethod:
          description: HTTP request type used for `ConferenceStatusCallback`. Defaults to `POST`.
          enum:
          - GET
          - POST
          example: GET
          type: string
        ConferenceTrim:
          description: Whether to trim any leading and trailing silence from the conference recording. Defaults to `trim-silence`.
          enum:
          - trim-silence
          - do-not-trim
          example: trim-silence
          type: string
        CustomHeaders:
          description: Custom HTTP headers to be sent with the call. Each header should be an object with 'name' and 'value' properties.
          example:
          - name: X-Custom-Header
            value: custom-value
          items:
            properties:
              name:
                description: The name of the custom header
                type: string
              value:
                description: The value of the custom header
                type: string
            required:
            - name
            - value
            type: object
          type: array
        EarlyMedia:
          default: false
          description: Whether participant shall be bridged to conference before the participant answers (from early media if available). Defaults to `false`.
          example: true
          type: boolean
        EndConferenceOnExit:
          description: Whether to end the conference when the participant leaves. Defaults to `false`.
          example: true
          type: boolean
        From:
          description: The phone number of the party that initiated the call. Phone numbers are formatted

# --- 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