Telnyx Enum API

openapi: 3.2.0
info:
  title: Telnyx Enum API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Enum across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Enum
paths:
  /10dlc/enum/{endpoint}:
    get:
      tags:
      - Enum
      summary: Get Enum
      operationId: GetEnumEndpoint
      parameters:
      - required: true
        schema:
          title: Endpoint
          type: string
          enum:
          - mno
          - optionalAttributes
          - usecase
          - vertical
          - altBusinessIdType
          - brandIdentityStatus
          - brandRelationship
          - campaignStatus
          - entityType
          - extVettingProvider
          - vettingStatus
          - brandStatus
          - operationStatus
          - approvedPublicCompany
          - stockExchange
          - vettingClass
        name: endpoint
        in: path
        description: Unique identifier of the endpoint.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/EnumStringListResponse'
                - $ref: '#/components/schemas/EnumObjectListResponse'
                - $ref: '#/components/schemas/EnumObjectToStringResponse'
                - $ref: '#/components/schemas/EnumObjecToObjecttResponse'
                - $ref: '#/components/schemas/EnumPaginatedResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
              example:
                errors:
                - code: '10005'
                  title: Resource not found
                  detail: The requested resource or URL could not be found.
        4XX:
          $ref: '#/components/responses/10dlc_GenericErrorResponse_ca4eb0ad6f'
      description: Returns the accepted values for the selected 10DLC enumeration endpoint. Use these values when constructing brand and campaign requests.
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  schemas:
    EnumPaginatedResponse:
      title: EnumPaginatedResponse
      type: object
      required:
      - page
      - totalRecords
      - records
      properties:
        page:
          type: integer
        totalRecords:
          type: integer
        records:
          type: array
          items:
            type: object
            additionalProperties: true
      example:
        page: 1
        totalRecords: 2
        records:
        - isin: US68243Q1067
          iso2: US
          symbol: FLWS
          exchange: NASDAQ
          displayName: 1-800 FLOWERS.COM, Inc.
        - isin: US88025U1097
          iso2: US
          symbol: TXG
          exchange: NASDAQ
          displayName: 10X GENOMICS INC CLASS A
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/billing-group_Error'
      type: object
    EnumObjecToObjecttResponse:
      title: EnumObjecToObjecttResponse
      type: object
      additionalProperties: true
      example:
        PROFESSIONAL:
          industryId: professional-services
          displayName: Professional Services
          description: Professional services.
        REAL_ESTATE:
          industryId: real-estate
          displayName: Real Estate
          description: Buying and Selling of residential and commercial properties.
    EnumStringListResponse:
      title: EnumStringListResponse
      type: array
      items:
        type: string
      example:
      - BASIC_ACCOUNT
      - SMALL_ACCOUNT
      - MEDIUM_ACCOUNT
      - LARGE_ACCOUNT
      - KEY_ACCOUNT
    billing-group_Error:
      type: object
      required:
      - code
      - title
      properties:
        code:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties: {}
          additionalProperties: true
    EnumObjectListResponse:
      title: EnumObjectListResponse
      type: array
      items:
        type: object
        additionalProperties: true
      example:
      - networkId: 10000
        displayName: string
        osrBitmaskIndex: 32
    EnumObjectToStringResponse:
      title: EnumObjectToStringResponse
      type: object
      additionalProperties: true
      example:
        AREIS: AREIS
        BANDW: Bandwidth
        SINCH: Sinch
    10dlc_Error:
      properties:
        code:
          type: string
        detail:
          type: string
        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
    10dlc_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/10dlc_Error'
          type: array
      type: object
    Errors_2:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    Error:
      required:
      - code
      - title
      properties:
        code:
          type: string
          x-format: int64
        title:
          type: string
        detail:
          type: string
          description: A human-readable explanation of the error.
        description:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              format: json-pointer
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          additionalProperties: true
      example:
        title: Invalid street address
        source:
          pointer: /street_address
        code: '20207'
        description: The street address provided is invalid.
      type: object
  responses:
    10dlc_GenericErrorResponse_ca4eb0ad6f:
      description: Generic response error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          example:
            errors:
            - code: string
              title: string
              detail: string
              source:
                pointer: string
                parameter: string
    10dlc_GenericErrorResponse:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/10dlc_Errors'
      description: Generic response error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt