Telnyx SIPREC Connectors 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 SIPREC Connectors 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: SIPREC connectors configuration.
  name: SIPREC Connectors
paths:
  /siprec_connectors:
    post:
      description: Creates a new SIPREC connector configuration.
      operationId: createSiprecConnector
      requestBody:
        $ref: '#/components/requestBodies/SiprecConnectorRequest'
      responses:
        '201':
          $ref: '#/components/responses/SiprecConnectorResponseBody'
        '422':
          $ref: '#/components/responses/siprec_UnprocessableEntityResponse'
        default:
          $ref: '#/components/responses/siprec_GenericErrorResponse'
      summary: Create a SIPREC connector
      tags:
      - SIPREC Connectors
      x-latency-category: responsive
  /siprec_connectors/{connector_name}:
    delete:
      description: Deletes a stored SIPREC connector.
      operationId: deleteSiprecConnector
      parameters:
      - $ref: '#/components/parameters/SiprecConnectorName'
      responses:
        '204':
          description: The SIPREC connector was deleted successfully.
        '404':
          $ref: '#/components/responses/siprec_NotFoundResponse'
        default:
          $ref: '#/components/responses/siprec_GenericErrorResponse'
      summary: Delete a SIPREC connector
      tags:
      - SIPREC Connectors
      x-latency-category: responsive
    get:
      description: Returns details of a stored SIPREC connector.
      operationId: getSiprecConnector
      parameters:
      - $ref: '#/components/parameters/SiprecConnectorName'
      responses:
        '200':
          $ref: '#/components/responses/SiprecConnectorResponseBody'
        '404':
          $ref: '#/components/responses/siprec_NotFoundResponse'
        default:
          $ref: '#/components/responses/siprec_GenericErrorResponse'
      summary: Retrieve a SIPREC connector
      tags:
      - SIPREC Connectors
      x-latency-category: responsive
    put:
      description: Updates a stored SIPREC connector configuration.
      operationId: updateSiprecConnector
      parameters:
      - $ref: '#/components/parameters/SiprecConnectorName'
      requestBody:
        $ref: '#/components/requestBodies/SiprecConnectorRequest'
      responses:
        '200':
          $ref: '#/components/responses/SiprecConnectorResponseBody'
        '404':
          $ref: '#/components/responses/siprec_NotFoundResponse'
        '422':
          $ref: '#/components/responses/siprec_UnprocessableEntityResponse'
        default:
          $ref: '#/components/responses/siprec_GenericErrorResponse'
      summary: Update a SIPREC connector
      tags:
      - SIPREC Connectors
      x-latency-category: responsive
components:
  responses:
    siprec_UnprocessableEntityResponse:
      content:
        application/json:
          example:
            errors:
            - code: 422
              detail: The request parameters failed validation
              title: Unprocessable Entity
          schema:
            $ref: '#/components/schemas/siprec_Errors'
      description: Unprocessable entity. The request was well-formed but contains semantic errors.
    siprec_NotFoundResponse:
      content:
        application/json:
          example:
            errors:
            - code: 404
              detail: The requested resource does not exist
              title: Not Found
          schema:
            $ref: '#/components/schemas/siprec_Errors'
      description: The requested resource does not exist
    SiprecConnectorResponseBody:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SiprecConnectorResponse'
      description: Return details of the SIPREC connector.
    siprec_GenericErrorResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/siprec_Errors'
      description: Unexpected error.
  schemas:
    SiprecConnector:
      example:
        app_subdomain: my-app
        host: siprec.telnyx.com
        name: my-siprec-connector
        port: 5060
      properties:
        app_subdomain:
          description: Subdomain to route the call when using Telnyx SRS (optional for non-Telnyx SRS).
          example: my-app-domain
          type: string
        host:
          description: Hostname/IPv4 address of the SIPREC SRS.
          example: siprec.telnyx.com
          type: string
        name:
          description: Name for the SIPREC connector resource.
          example: my-siprec-connector
          type: string
        port:
          description: Port for the SIPREC SRS.
          example: 5060
          type: integer
      required:
      - host
      - port
      - name
      title: SIPREC connector configuration
      type: object
    SiprecConnectorResponse:
      properties:
        data:
          properties:
            app_subdomain:
              description: Subdomain to route calls when using Telnyx SRS (optional).
              example: my-app-domain
              type: string
            created_at:
              description: ISO 8601 formatted date/time of creation.
              example: '2024-01-23T18:10:02.574Z'
              type: string
            host:
              description: Hostname/IPv4 address of the SIPREC SRS.
              example: siprec.telnyx.com
              type: string
            name:
              description: Name for the SIPREC connector resource.
              example: siprec-connector
              type: string
            port:
              description: Port for the SIPREC SRS.
              example: 5060
              type: integer
            record_type:
              example: siprec_connector
              type: string
            updated_at:
              description: ISO 8601 formatted date/time of last update.
              example: '2024-01-23T18:10:02.574Z'
              type: string
          title: SIPREC Connector
          type: object
      required:
      - data
      title: SIPREC Connector Response
      type: object
    siprec_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/siprec_Error'
          type: array
      type: object
    siprec_Error:
      properties:
        code:
          format: int32
          type: integer
        detail:
          type: string
        meta:
          additionalProperties: true
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
          type: object
        title:
          type: string
      required:
      - code
      - title
      type: object
  parameters:
    SiprecConnectorName:
      description: Uniquely identifies a SIPREC connector.
      in: path
      name: connector_name
      required: true
      schema:
        type: string
  requestBodies:
    SiprecConnectorRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SiprecConnector'
      description: The parameters required to create or update a SIPREC connector.
      required: true
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    branded-calling_bearerAuth:
      description: API key passed as a Bearer token in the Authorization header
      scheme: bearer
      type: http
    oauthClientAuth:
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
      flows:
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
          tokenUrl: https://api.telnyx.com/v2/oauth/token
        clientCredentials:
          scopes:
            admin: Administrative access to Telnyx resources
          tokenUrl: https://api.telnyx.com/v2/oauth/token
      type: oauth2
    outbound-voice-profiles_bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
    pronunciation-dicts_bearerAuth:
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
      scheme: bearer
      type: http
    stored-payment-transactions_bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http