> ## Documentation Index
> Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List standard call reasons

> Telnyx maintains a library of pre-vetted call-reason phrases (e.g. "Appointment reminders", "Billing inquiries") that carry through DIR vetting smoothly. You can use any string that fits your use case in `DirCreateRequest.call_reasons`, but matching one of these reduces the chance the vetting team flags the phrasing for clarification.



## OpenAPI

````yaml /openapi/source/external/branded-calling/branded-calling.json get /call_reasons
openapi: 3.0.0
info:
  x-latency-category: responsive
  version: 2.0.0
  title: Telnyx Branded Calling API
  description: >-
    The Telnyx Branded Calling API lets you register your business identity as
    Display Identity Records (DIRs) and associate phone numbers so your verified
    caller identity is shown on outbound calls. Flow: create an enterprise →
    activate Branded Calling → create a DIR → submit it for vetting → after
    approval, attach phone numbers and submit them in a batch for vetting.


    Several actions are billable (Branded Calling activation and phone-number
    registration). See https://telnyx.com/pricing/numbers for current pricing.
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
    description: Telnyx API v2 (production)
security:
  - bearerAuth: []
tags:
  - name: Enterprises
    description: Manage the legal-entity record that owns your DIRs and phone numbers.
  - name: Display Identity Records
    description: >-
      A Display Identity Record (DIR) is the verified calling identity (display
      name, logo, call reasons) shown to recipients on outbound calls.
  - name: DIR References
    description: >-
      Submit and manage the two business references and one financial reference
      that vouch for a DIR. References are contacted to confirm the business
      identity during vetting.
  - name: Email Verification
    description: >-
      Verify ownership of a DIR's authorizer email. A short code is emailed and
      confirmed; the email must be verified before references can be submitted.
  - name: Phone Numbers
    description: >-
      Associate phone numbers with a verified DIR so calls from those numbers
      carry the DIR's display identity.
  - name: Phone Number Batches
    description: >-
      Phone numbers are submitted to Telnyx for vetting in batches. Batches
      group all numbers added in a single request under the same Letter of
      Authorization.
  - name: Comments
    description: >-
      Read messages from the Telnyx vetting team and reply with clarifying
      information.
  - name: Infringement Claims
    description: >-
      Trademark or impersonation claims filed against your DIR. Customers may
      contest a claim with supporting evidence.
  - name: Reference Data
    description: >-
      Static reference values the API accepts: call reasons, document types,
      rejection types.
  - name: Terms of Service
    description: >-
      Accept and review the Branded Calling and Phone Number Reputation terms of
      service.
paths:
  /call_reasons:
    get:
      tags:
        - Reference Data
      summary: List standard call reasons
      description: >-
        Telnyx maintains a library of pre-vetted call-reason phrases (e.g.
        "Appointment reminders", "Billing inquiries") that carry through DIR
        vetting smoothly. You can use any string that fits your use case in
        `DirCreateRequest.call_reasons`, but matching one of these reduces the
        chance the vetting team flags the phrasing for clarification.
      operationId: listCallReasons
      parameters:
        - $ref: '#/components/parameters/BcPageNumber'
        - name: page[size]
          in: query
          required: false
          description: >-
            Items per page. Default `100` for this endpoint (the call-reason
            library is small and most callers want the whole list in one call).
            Maximum 250; values above are clamped to 250.
          schema:
            type: integer
            minimum: 1
            maximum: 250
            default: 100
            example: 100
      responses:
        '200':
          description: Paginated list of standard call reasons.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallReasonReferenceList'
              example:
                data:
                  - id: d29914a4-3c93-440c-af72-03778f442522
                    reason: Account Alert
                    description: Alert about account status or changes
                  - id: 4cabcae2-6c61-415b-ac5b-753469458a56
                    reason: Account Notification
                    description: General account notifications
                meta:
                  page_number: 1
                  page_size: 2
                  total_results: 45
                  total_pages: 23
        default:
          $ref: '#/components/responses/GenericErrorResponse'
        4XX:
          $ref: '#/components/responses/GenericErrorResponse'
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Telnyx from 'telnyx';


            const client = new Telnyx({
              apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
            });


            // Automatically fetches more pages as needed.

            for await (const callReasonListResponse of
            client.callReasons.list()) {
              console.log(callReasonListResponse.id);
            }
        - lang: Python
          source: |
            import os
            from telnyx import Telnyx

            client = Telnyx(
                api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
            )
            page = client.call_reasons.list()
            page = page.data[0]
            print(page.id)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/team-telnyx/telnyx-go\"\n\t\"github.com/team-telnyx/telnyx-go/option\"\n)\n\nfunc main() {\n\tclient := telnyx.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.CallReasons.List(context.TODO(), telnyx.CallReasonListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n"
        - lang: Java
          source: |-
            package com.telnyx.sdk.example;

            import com.telnyx.sdk.client.TelnyxClient;
            import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
            import com.telnyx.sdk.models.callreasons.CallReasonListPage;
            import com.telnyx.sdk.models.callreasons.CallReasonListParams;

            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    TelnyxClient client = TelnyxOkHttpClient.fromEnv();

                    CallReasonListPage page = client.callReasons().list();
                }
            }
        - lang: Ruby
          source: |-
            require "telnyx"

            telnyx = Telnyx::Client.new(api_key: "My API Key")

            page = telnyx.call_reasons.list

            puts(page)
        - lang: PHP
          source: >-
            <?php


            require_once dirname(__DIR__) . '/vendor/autoload.php';


            use Telnyx\Client;

            use Telnyx\Core\Exceptions\APIException;


            $client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API
            Key');


            try {
              $page = $client->callReasons->list(pageNumber: 1, pageSize: 100);

              var_dump($page);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: CLI
          source: |-
            telnyx call-reasons list \
              --api-key 'My API Key'
components:
  parameters:
    BcPageNumber:
      name: page[number]
      in: query
      description: >-
        1-based page number. Out-of-range values return an empty page with
        correct meta.
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
        example: 1
  schemas:
    CallReasonReferenceList:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CallReasonReference'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    CallReasonReference:
      type: object
      description: Pre-vetted call-reason library entry.
      properties:
        id:
          type: string
          format: uuid
          example: d29914a4-3c93-440c-af72-03778f442522
          readOnly: true
        reason:
          type: string
          example: Account Alert
        description:
          type: string
          example: Alert about account status or changes
    PaginationMeta:
      type: object
      required:
        - total_pages
        - total_results
        - page_number
        - page_size
      properties:
        total_pages:
          type: integer
          example: 3
          description: Total number of pages available given the current `page_size`.
        total_results:
          type: integer
          example: 42
          description: Total number of items across all pages (excludes soft-deleted rows).
        page_number:
          type: integer
          example: 1
          description: >-
            1-based index of this page. Echoes the `page[number]` query
            parameter (default `1`).
        page_size:
          type: integer
          example: 20
          description: Number of items returned in this page's `data` array. Capped at 250.
      description: >-
        JSON:API pagination metadata returned with every paginated list
        response. Page numbering is 1-based. `page_size` reports the number of
        items actually returned in `data` for this page; the requested size is
        taken from the `page[size]` query parameter.
    Errors:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: List of one or more error entries. Order is not significant.
      description: >-
        Canonical Telnyx error envelope. Returned on every 4xx and 5xx response
        from this service. `errors` is non-empty; multiple entries indicate
        multiple distinct problems with the same request (e.g. one entry per
        invalid phone number on a bulk operation).
    Error:
      type: object
      required:
        - code
        - title
        - detail
        - meta
      properties:
        code:
          type: string
          example: '10005'
          description: >-
            Stable numeric Telnyx error catalog id. See `meta.url` for the full
            catalog entry.
        title:
          type: string
          example: Invalid parameters
          description: >-
            Short human-readable category, e.g. `Bad Request`, `Duplicate
            resource`, `Not Found`, `Forbidden`. Treat as advisory only - the
            stable identifier is `code`.
        detail:
          type: string
          example: field required
          description: >-
            Context-specific message describing what went wrong on this
            particular request. May embed offending values; do not rely on it
            for programmatic matching - branch on `code`.
        meta:
          type: object
          required:
            - url
          properties:
            url:
              type: string
              format: uri
              example: https://developers.telnyx.com/docs/overview/errors/10005
            pending_check_ids:
              type: array
              items:
                type: string
                format: uuid
              description: >-
                Set on `422 vetting_checks_incomplete` responses from
                `/admin/dir/{id}/approve` and
                `/admin/phone-number-batches/approve`. Lists the still-pending
                vetting check ids.
            pending_check_codes:
              type: array
              items:
                type: string
              description: >-
                Codes of the pending vetting checks (e.g.
                `loa_signature_valid`).
            pending_check_labels:
              type: array
              items:
                type: string
              description: Human-readable labels of the pending vetting checks.
          description: >-
            Carries `url` linking to the Telnyx error catalog entry for this
            `code`. Useful for forwarding the user to documentation.
        source:
          type: object
          description: Optional pointer at the offending field of the request.
          properties:
            pointer:
              type: string
              example: /body/legal_name
            parameter:
              type: string
              example: page[size]
      description: >-
        A single entry in the canonical Telnyx error envelope. `code` is the
        stable Telnyx error catalog id; the human-readable explanation lives at
        `meta.url`. `detail` is a context-specific message; `source.pointer`
        (when present) names the offending field of the request.
  responses:
    GenericErrorResponse:
      description: >-
        An error occurred. The response carries the standard Telnyx error
        envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Errors'
          examples:
            validation_error:
              summary: 422 - request body failed validation
              value:
                errors:
                  - code: '10005'
                    title: Invalid parameters
                    detail: field required
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10005
                    source:
                      pointer: /body/legal_name
            bad_request:
              summary: 400 - request rejected by a state guard
              description: >-
                Returned when the request itself is well-formed but the resource
                is in a state that disallows this action (e.g. updating a DIR
                while it is being vetted, or deleting an enterprise that still
                has DIRs in vetting).
              value:
                errors:
                  - code: '10015'
                    title: Bad Request
                    detail: Cannot update DIR in 'verified' status
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10015
            not_found:
              summary: 404 - resource does not exist or is not yours
              value:
                errors:
                  - code: '10009'
                    title: Resource not found
                    detail: Enterprise not found.
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10009
            conflict:
              summary: 409 - request conflicts with current resource state
              value:
                errors:
                  - code: '10021'
                    title: Resource in use
                    detail: >-
                      DIR has 1 active infringement claim(s). Resolve the claim
                      before making this change.
                    meta:
                      url: https://developers.telnyx.com/docs/overview/errors/10021
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Telnyx API key. Generate one at
        https://portal.telnyx.com/#/app/api-keys.

````