Telnyx Customer Service Record API

openapi: 3.2.0
info:
  title: Telnyx Customer Service Record 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 Customer Service Record 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: Customer Service Record
  description: Customer Service Record operations
paths:
  /customer_service_records:
    get:
      tags:
      - Customer Service Record
      summary: List customer service records
      description: Returns a paginated list of your customer service record (CSR) requests, with support for filtering and sorting.
      operationId: ListCustomerServiceRecords
      parameters:
      - $ref: '#/components/parameters/customer_service_record_PageConsolidated'
      - $ref: '#/components/parameters/customer_service_record_FilterConsolidated'
      - name: sort
        in: query
        style: deepObject
        explode: true
        description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]'
        schema:
          type: object
          properties:
            value:
              type: string
              enum:
              - created_at
              - -created_at
              example: created_at
              description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomerServiceRecord'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          $ref: '#/components/responses/customer_service_record_UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/customer_service_record_ForbiddenErrorResponse'
        '422':
          $ref: '#/components/responses/customer_service_record_UnprocessableEntityErrorResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
    post:
      tags:
      - Customer Service Record
      summary: Create a customer service record
      description: Create a new customer service record for the provided phone number.
      operationId: CreateCustomerServiceRecord
      requestBody:
        $ref: '#/components/requestBodies/CreateCustomerServiceRecord'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomerServiceRecord'
                example:
                  data:
                    id: db7cebdb-21a8-4e89-8f51-e03ba6b799bb
                    phone_number: '+2003271000'
                    status: pending
                    error_message: null
                    result: null
                    webhook_url: https://example.com/webhook
                    created_at: '2023-01-01T00:00:00Z'
                    updated_at: '2023-01-01T00:00:00Z'
        '401':
          $ref: '#/components/responses/customer_service_record_UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/customer_service_record_ForbiddenErrorResponse'
        '422':
          $ref: '#/components/responses/customer_service_record_UnprocessableEntityErrorResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /customer_service_records/phone_number_coverages:
    post:
      tags:
      - Customer Service Record
      summary: Verify CSR phone number coverage
      description: Verify the coverage for a list of phone numbers.
      operationId: VerifyPhoneNumberCoverage
      requestBody:
        $ref: '#/components/requestBodies/VerifyCustomerServiceRecordPhoneNumberCoverage'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomerServiceRecordPhoneNumberCoverage'
        '401':
          $ref: '#/components/responses/customer_service_record_UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/customer_service_record_ForbiddenErrorResponse'
        '422':
          $ref: '#/components/responses/customer_service_record_UnprocessableEntityErrorResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /customer_service_records/{customer_service_record_id}:
    get:
      tags:
      - Customer Service Record
      summary: Get a customer service record
      description: Returns the details of a single customer service record (CSR) request, including its status and any retrieved record data.
      operationId: GetCustomerServiceRecord
      parameters:
      - $ref: '#/components/parameters/PathCustomerServiceRecordId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomerServiceRecord'
        '401':
          $ref: '#/components/responses/customer_service_record_UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/customer_service_record_ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundErrorResponse'
        '500':
          $ref: '#/components/responses/UnexpectedErrorResponse'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  schemas:
    customer_service_record_UnprocessableEntityError:
      allOf:
      - $ref: '#/components/schemas/GenericError'
      - properties:
          code:
            example: '10002'
            type: string
          title:
            example: Invalid phone number
            type: string
          detail:
            example: The phone number is invalid.
            type: string
          source:
            type: object
            properties:
              pointer:
                type: string
                example: /phone_numbers
          meta:
            type: object
            properties:
              url:
                type: string
                example: https://developers.telnyx.com/docs/overview/errors/10002
        type: object
    customer_service_record_ResourceNotFoundError:
      allOf:
      - $ref: '#/components/schemas/GenericError'
      - properties:
          code:
            example: '10005'
            type: string
          title:
            example: Resource not found
            type: string
          detail:
            example: The requested resource or URL could not be found.
            type: string
          meta:
            type: object
            properties:
              url:
                type: string
                example: https://developers.telnyx.com/docs/overview/errors/10005
        type: object
    PaginationMeta:
      type: object
      properties:
        total_pages:
          type: integer
          example: 3
        total_results:
          type: integer
          example: 55
        page_number:
          type: integer
          example: 2
        page_size:
          type: integer
          example: 25
    UnauthorizedError:
      allOf:
      - $ref: '#/components/schemas/GenericError'
      - properties:
          code:
            example: '10009'
            type: string
          title:
            example: Authentication failed
            type: string
          detail:
            example: The required authentication headers were either invalid or not included in the request.
            type: string
          meta:
            type: object
            properties:
              url:
                type: string
                example: https://developers.telnyx.com/docs/overview/errors/10009
        type: object
    ForbiddenError:
      allOf:
      - $ref: '#/components/schemas/GenericError'
      - properties:
          code:
            example: '10010'
            type: string
          title:
            example: Authorization failed
            type: string
          detail:
            example: You do not have permission to perform the requested action on the specified resource or resources.
            type: string
          meta:
            type: object
            properties:
              url:
                type: string
                example: https://developers.telnyx.com/docs/overview/errors/10010
        type: object
    CustomerServiceRecordPhoneNumberCoverage:
      type: object
      properties:
        phone_number:
          type: string
          description: The phone number that is being verified.
          example: '+12223334444'
        has_csr_coverage:
          type: boolean
          description: Indicates whether the phone number is covered or not.
          example: true
        reason:
          type: string
          description: The reason why the phone number is not covered. Only returned if `has_csr_coverage` is false.
          example: The phone number '+19999999999' is invalid.
        additional_data_required:
          type: array
          description: Additional data required to perform CSR for the phone number. Only returned if `has_csr_coverage` is true.
          items:
            type: string
            enum:
            - name
            - authorized_person_name
            - account_number
            - customer_code
            - pin
            - address_line_1
            - city
            - state
            - zip_code
            - billing_phone_number
            example: name
        record_type:
          type: string
          description: Identifies the type of the resource.
          example: customer_service_record_phone_number_coverage
    UnexpectedError:
      allOf:
      - $ref: '#/components/schemas/GenericError'
      - properties:
          code:
            example: '10007'
            type: string
          title:
            example: Unexpected error
            type: string
          detail:
            example: An unexpected error occurred.
            type: string
          meta:
            type: object
            properties:
              url:
                type: string
                example: https://developers.telnyx.com/docs/overview/errors/10007
        type: object
    CustomerServiceRecordAdditionalData:
      type: object
      properties:
        name:
          description: The name of the administrator of CSR.
          type: string
          example: Entity Inc.
        authorized_person_name:
          description: The name of the authorized person.
          type: string
          example: John Doe
        pin:
          description: The PIN of the customer service record.
          type: string
          example: '1234'
        account_number:
          description: The account number of the customer service record.
          type: string
          example: '123456789'
        customer_code:
          description: The customer code of the customer service record.
          type: string
          example: '123456789'
        address_line_1:
          description: The first line of the address of the customer service record.
          type: string
          example: 123 Main St
        city:
          description: The city of the customer service record.
          type: string
          example: New York
        state:
          description: The state of the customer service record.
          type: string
          example: NY
          maxLength: 2
          pattern: ^[A-Z]{2}$
        zip_code:
          description: The zip code of the customer service record.
          type: string
          example: '10001'
          maxLength: 5
          pattern: ^\d{5}$
        billing_phone_number:
          description: The billing phone number of the customer service record.
          type: string
          example: '+12065551212'
          pattern: ^\+1\d{10}$
    CustomerServiceRecord:
      type: object
      properties:
        id:
          description: Uniquely identifies this customer service record
          type: string
          format: uuid
          example: f1486bae-f067-460c-ad43-73a92848f902
          readOnly: true
        phone_number:
          description: The phone number of the customer service record.
          type: string
          example: '+12065551212'
        status:
          description: The status of the customer service record
          type: string
          enum:
          - pending
          - completed
          - failed
          example: completed
        error_message:
          description: The error message in case status is `failed`. This field would be null in case of `pending` or `completed` status.
          type:
          - string
          - 'null'
          example: CSR information not available.
        result:
          description: The result of the CSR request. This field would be null in case of `pending` or `failed` status.
          type:
          - object
          - 'null'
          properties:
            carrier_name:
              description: The name of the carrier that the customer service record is for.
              type: string
              example: ABC CARRIER, INC.
            associated_phone_numbers:
              description: The associated phone numbers of the customer service record.
              type: array
              items:
                type: string
                example: '+12065551212'
            admin:
              description: The admin of the customer service record.
              type: object
              properties:
                name:
                  description: The name of the customer service record.
                  type: string
                  example: John Doe
                billing_phone_number:
                  description: The billing phone number of the customer service record.
                  type: string
                  example: '+12065551212'
                account_number:
                  description: The account number of the customer service record.
                  type: string
                  example: '1234567890'
                authorized_person_name:
                  description: The authorized person name of the customer service record.
                  type: string
                  example: John Doe
            address:
              description: The address of the customer service record
              type: object
              properties:
                administrative_area:
                  description: The state of the address
                  type: string
                  example: NY
                locality:
                  description: The city of the address
                  type: string
                  example: New York
                postal_code:
                  description: The zip code of the address
                  type: string
                  example: '10001'
                street_address:
                  description: The street address
                  type: string
                  example: 123 Main St
                full_address:
                  description: The full address
                  type: string
                  example: 123 Main St; New York; NY; 10001
        webhook_url:
          type: string
          description: Callback URL to receive webhook notifications.
          example: https://example.com/webhook
        record_type:
          type: string
          example: customer_service_record
          description: Identifies the type of the resource.
          readOnly: true
        created_at:
          type: string
          format: date-time
          description: ISO 8601 formatted date indicating when the resource was created.
          example: '2021-03-19T10:07:15.527Z'
          readOnly: true
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 formatted date indicating when the resource was created.
          example: '2021-03-19T10:07:15.527Z'
          readOnly: true
    GenericError:
      properties:
        code:
          type: string
        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
          additionalProperties: true
      type: object
  requestBodies:
    CreateCustomerServiceRecord:
      required: true
      content:
        application/json:
          schema:
            type: object
            required:
            - phone_number
            properties:
              phone_number:
                type: string
                description: A valid US phone number in E164 format.
                example: '+13035553000'
                pattern: ^\+1\d{10}$
              webhook_url:
                type: string
                description: Callback URL to receive webhook notifications.
                example: https://example.com/webhook
              additional_data:
                $ref: '#/components/schemas/CustomerServiceRecordAdditionalData'
    VerifyCustomerServiceRecordPhoneNumberCoverage:
      required: true
      content:
        application/json:
          schema:
            type: object
            required:
            - phone_numbers
            properties:
              phone_numbers:
                type: array
                description: The phone numbers list to be verified.
                items:
                  type: string
                  description: A valid US phone number in E164 format.
                  example: '+13035553000'
                  pattern: ^\+1\d{10}$
  parameters:
    customer_service_record_FilterConsolidated:
      name: filter
      in: query
      style: deepObject
      explode: true
      description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number][eq], filter[phone_number][in][], filter[status][eq], filter[status][in][], filter[created_at][lt], filter[created_at][gt]'
      schema:
        type: object
        properties:
          phone_number:
            type: object
            properties:
              eq:
                type: string
                example: '+12441239999'
                description: Filters records to those with a specified number.
              in:
                type: array
                items:
                  type: string
                  example: '+12441239999'
                description: Filters records to those with at least one number in the list.
          status:
            type: object
            properties:
              eq:
                type: string
                enum:
                - pending
                - completed
                - failed
                example: pending
                description: Filters records to those with a specific status.
              in:
                type: array
                items:
                  type: string
                  enum:
                  - pending
                  - completed
                  - failed
                  example: pending
                description: Filters records to those with a least one status in the list.
          created_at:
            type: object
            properties:
              lt:
                type: string
                format: date-time
                example: '2020-01-01T00:00:00Z'
                description: Filters records to those created before a specific date.
              gt:
                type: string
                format: date-time
                example: '2020-01-01T00:00:00Z'
                description: Filters records to those created after a specific date.
    PathCustomerServiceRecordId:
      name: customer_service_record_id
      in: path
      description: The ID of the customer service record
      required: true
      schema:
        type: string
    customer_service_record_PageConsolidated:
      name: page
      in: query
      style: deepObject
      explode: true
      description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
      schema:
        type: object
        properties:
          size:
            type: integer
            minimum: 1
            maximum: 250
            default: 20
            description: The size of the page
          number:
            type: integer
            minimum: 1
            default: 1
            description: The page number to load
  responses:
    customer_service_record_UnprocessableEntityErrorResponse:
      description: Unprocessable entity. Check the 'detail' field in response for details.
      content:
        application/json:
          schema:
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/customer_service_record_UnprocessableEntityError'
    customer_service_record_UnauthorizedErrorResponse:
      description: The required authentication headers were either invalid or not included in the request.
      content:
        application/json:
          schema:
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/UnauthorizedError'
    ResourceNotFoundErrorResponse:
      description: Resource not found
      content:
        application/json:
          schema:
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/customer_service_record_ResourceNotFoundError'
    customer_service_record_ForbiddenErrorResponse:
      description: You do not have permission to perform the requested action on the specified resource or resources.
      content:
        application/json:
          schema:
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/ForbiddenError'
    UnexpectedErrorResponse:
      description: An unexpected error occurred.
      content:
        application/json:
          schema:
            properties:
              errors:
                type: array
                items:
                  $ref: '#/components/schemas/UnexpectedError'
    ShowCustomerServiceRecord:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: '#/components/schemas/CustomerServiceRecord'
            type: object
      description: Successful Response
    ListCustomerServiceRecordPhoneNumberCoverage:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/CustomerServiceRecordPhoneNumberCoverage'
                type: array
            type: object
      description: Successful Response
    ListCustomerServiceRecords:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: '#/components/schemas/CustomerServiceRecord'
                type: array
              meta:
                $ref: '#/components/schemas/PaginationMeta'
            type: object
      description: Successful Response
    CreateCustomerServiceRecord:
      content:
        application/json:
          schema:
            example:
              data:
                created_at: '2023-01-01T00:00:00Z'
                error_message: null
                id: db7cebdb-21a8-4e89-8f51-e03ba6b799bb
                phone_number: '+2003271000'
                result: null
                status: pending
                updated_at: '2023-01-01T00:00:00Z'
                webhook_url: https://example.com/webhook
            properties:
              data:
                $ref: '#/components/schemas/CustomerServiceRecord'
            type: object
      description: Successful Response
  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