openapi: 3.0.0
servers:
  - description: Version 2.0.0 of the Telnyx API
    url: https://api.telnyx.com/v2
info:
  contact:
    email: support@telnyx.com
  description: SIP trunking, SMS, MMS, Call Control and Telephony Data Services.
  license:
    name: MIT
  title: Telnyx API
  version: 2.0.0
  x-apisguru-categories:
    - telecom
  x-endpoint-cost: light
  x-origin:
    - format: openapi
      url: https://raw.githubusercontent.com/team-telnyx/openapi/master/openapi/spec3.yml
      version: "3.0"
  x-providerName: telnyx.com
security:
  - BearerAuth: []
tags:
  - description: Access Tokens creation
    name: Access Tokens
  - description: Address operations
    name: Addresses
  - description: Authentication Provider operations
    name: Authentication Providers
  - description: Billing operations
    name: Billing
  - description: Billing groups operations
    name: Billing Groups
  - description: Bulk operations over Credentials
    name: Bulk Credentials
  - description: Call Control command operations
    name: Call Commands
  - description: Call Control applications operations
    name: Call Control Applications
  - description: Call information
    name: Call Information
  - description: Conference command operations
    name: Conference Commands
  - description: Connections operations
    name: Connections
  - description: Credential connection operations
    name: Credential Connections
  - description: Credentials operations
    name: Credentials
  - description: Call Control debugging
    name: Debugging
  - description: Detail Records operations
    name: Detail Records
  - description: Documents
    name: Documents
  - description: FQDN connection operations
    name: FQDN Connections
  - description: FQDN operations
    name: FQDNs
  - description: IP connection operations
    name: IP Connections
  - description: IP operations
    name: IPs
  - description: Inbound channels operations
    name: Inbound Channels
  - description: Inventory Level
    name: Inventory Level
  - description: Search messaging detail records
    name: MDR Search (Beta)
  - description: Managed Accounts operations
    name: Managed Accounts
  - description: Media Storage operations
    name: Media Storage API
  - description: Messages
    name: Messages
  - description: Manage your messaging hosted numbers
    name: Messaging Hosted Number
  - description: Messaging profiles
    name: Messaging Profiles
  - description: Messaging URL Domains
    name: Messaging URL Domains
  - description: Mobile operator networks operations
    name: Mobile Operator Networks
  - description: Notification settings operations
    name: Notifications
  - description: Background jobs performed over a batch of phone numbers
    name: Number Background Jobs
  - description: Background jobs performed over a phone-numbers block's phone numbers
    name: Number Blocks Background Jobs
  - description: Configure your phone numbers
    name: Number Configurations
  - description: Look up phone number data
    name: Number Lookup
  - description: Number order documents
    name: Number Order Documents
  - description: Number orders
    name: Number Orders
  - description: Number portout operations
    name: Number Portout
  - description: Number reservations
    name: Number Reservations
  - description: Number search
    name: Number Search
  - description: OTA updates operations
    name: OTA updates
  - description: Outbound voice profiles operations
    name: Outbound Voice Profiles
  - description: Determining portability of phone numbers
    name: Phone Number Porting
  - description: Porting Order operation
    name: Porting Order
  - description: Private Wireless Gateways operations
    name: Private Wireless Gateways
  - description: Fax Applications operations
    name: Programmable Fax Applications
  - description: Programmable fax command operations
    name: Programmable Fax Commands
  - description: Queue commands operations
    name: Queue Commands
  - description: Recordings commands operations
    name: Recordings Commands
  - description: Wireless reporting operations
    name: Reporting
  - description: Types of requirements for international numbers and porting orders
    name: Requirement Types
  - description: Requirements for international numbers and porting orders
    name: Requirements
  - description: Rooms Participants operations.
    name: Room Participants
  - description: Rooms Sessions operations.
    name: Room Sessions
  - description: Rooms operations.
    name: Rooms
  - description: Rooms Client Tokens operations.
    name: Rooms Client Tokens
  - description: SIM Card Group actions operations
    name: SIM Card Group Actions
  - description: SIM Card Groups operations
    name: SIM Card Groups
  - description: SIM Card Orders operations
    name: SIM Card Orders
  - description: SIM Cards operations
    name: SIM Cards
  - description: Short codes
    name: Short Codes
  - description: TeXML Applications operations
    name: TeXML Applications
  - description: Two factor authentication API
    name: Verify
  - description: Webhooks operations
    name: Webhooks
  - description: WhatsApp contacts
    name: WhatsApp Contacts
  - description: WhatsApp media files
    name: WhatsApp Media
  - description: WhatsApp messages
    name: WhatsApp Messages
  - description: WhatsApp user info
    name: WhatsApp Users
  - description: Wireless operations
    name: Wireless
paths:
  /actions/bulk/telephony_credentials:
    delete:
      description: Delete several credentials in bulk.
      operationId: DeleteBulkTelephonyCredential
      parameters:
        - $ref: "#/components/parameters/RequiredTag"
      responses:
        "201":
          $ref: "#/components/responses/BulkCredentialResponse"
        "422":
          description: Bad request
      summary: Delete several credentials
      tags:
        - Bulk Credentials
      x-latency-category: responsive
    patch:
      description: Update several credentials in bulk.
      operationId: UpdateBulkTelephonyCredential
      parameters:
        - $ref: "#/components/parameters/RequiredTag"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BulkCredentialRequest"
        description: Parameters to update credentials on bulk
        required: true
      responses:
        "201":
          $ref: "#/components/responses/BulkCredentialResponse"
        "422":
          description: Bad request
      summary: Update several credentials
      tags:
        - Bulk Credentials
      x-latency-category: responsive
    post:
      description: Creates several credentials in bulk.
      operationId: CreateBulkTelephonyCredential
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BulkCredentialRequest"
        description: Requested parameters to create credentials on bulk
        required: true
      responses:
        "201":
          $ref: "#/components/responses/BulkCredentialResponse"
        "422":
          description: Bad request
      summary: Creates several credentials
      tags:
        - Bulk Credentials
      x-latency-category: responsive
  /actions/network_preferences/sim_cards:
    put:
      description: |
        This API allows dispatching the same operation described for the PUT sim_cards/:sim_card_id/network_preferences API for multiple SIM cards at once.<br/><br/>
        Although, a SIM card network preference may fail individually under any validation triggered as a consequence of its state. For example, a SIM can't have an in-progress OTA update for applying a Network Preference, so they'll fail when requested in this API. In that scenario, the specific error will be present in the response along with the successful definitions in the "errors" response node.
      operationId: BulkSIMCardNetworkPreferences
      requestBody:
        content:
          application/json:
            schema:
              properties:
                mobile_operator_networks_preferences:
                  $ref: "#/components/schemas/MobileOperatorNetworksPreferencesRequest"
                sim_card_ids:
                  example:
                    - 6b14e151-8493-4fa1-8664-1cc4e6d14158
                    - 6b14e151-8493-4fa1-8664-1cc4e6d14158
                  items:
                    format: uuid
                    type: string
                  type: array
              type: object
      responses:
        "202":
          $ref: "#/components/responses/BulkSIMCardNetworkPreferenceResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
      summary: Bulk Network Preferences for SIM cards
      tags:
        - SIM Cards
      x-latency-category: background
  /actions/register/sim_cards:
    post:
      description: |
        Register the SIM cards associated with the provided registration codes to the current user's account.<br/><br/>
        If <code>sim_card_group_id</code> is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.<br/><br/>
      operationId: SimCardRegister
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SIMCardRegistration"
        required: true
      responses:
        "202":
          $ref: "#/components/responses/RegisterSimCardsResponse"
      summary: Register SIM cards
      tags:
        - SIM Cards
      x-latency-category: background
  "/actions/{action}/telephony_credentials":
    post:
      description: Perform activate or deactivate action on all credentials filtered by the provided tag. Activate action will change the status to active, making it possible to connect calls with the credential. Deactivate action will change the status to inactive, making it impossible to connect calls with the credential.
      operationId: BulkCredentialAction
      parameters:
        - description: Identifies the action to be taken. Activate will change the status to active. Deactivate will change the status to inactive.
          in: path
          name: action
          required: true
          schema:
            enum:
              - activate
              - deactivate
            type: string
        - $ref: "#/components/parameters/RequiredTag"
      responses:
        "200":
          $ref: "#/components/responses/BulkCredentialResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Perform activate or deactivate action on all credentials filtered by the provided tag.
      tags:
        - Bulk Credentials
      x-latency-category: responsive
  /addresses:
    get:
      description: Returns a list of your addresses.
      operationId: findAddresss
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterCustomerReferenceEquals"
        - $ref: "#/components/parameters/FilterCustomerReferenceContains"
        - $ref: "#/components/parameters/FilterUsedAsEmergency"
        - $ref: "#/components/parameters/FilterStreetAddress"
        - $ref: "#/components/parameters/FilterAddressBook"
        - $ref: "#/components/parameters/SortAddress"
      responses:
        "200":
          $ref: "#/components/responses/GetAllAddressResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List all addresses
      tags:
        - Addresses
      x-endpoint-cost: medium
      x-latency-category: responsive
    post:
      description: Creates an address.
      operationId: CreateAddress
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddressCreate"
        description: Parameters that can be defined during address creation
        required: true
      responses:
        "200":
          $ref: "#/components/responses/AddressResponse"
        "422":
          description: Bad request
      summary: Creates an address
      tags:
        - Addresses
      x-endpoint-cost: medium
      x-latency-category: responsive
  /addresses/actions/validate:
    post:
      description: Validates an address for emergency services.
      operationId: validateAddress
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ValidateAddressRequest"
        description: Parameters that can be defined during address validation
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ValidateAddressResponse"
        "422":
          description: Bad request
      summary: Validate an address
      tags:
        - Addresses
      x-latency-category: responsive
  "/addresses/{id}":
    delete:
      description: Deletes an existing address.
      operationId: DeleteAddress
      parameters:
        - description: address ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/AddressResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Deletes an address
      tags:
        - Addresses
      x-latency-category: responsive
    get:
      description: Retrieves the details of an existing address.
      operationId: getAddress
      parameters:
        - description: address ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/AddressResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve an address
      tags:
        - Addresses
      x-latency-category: responsive
  /authentication_providers:
    get:
      description: Returns a list of your SSO authentication providers.
      operationId: findAuthenticationProviders
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/SortAuthenticationProvider"
      responses:
        "200":
          $ref: "#/components/responses/GetAllAuthenticationProviderResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List all SSO authentication providers
      tags:
        - Authentication Providers
      x-latency-category: responsive
    post:
      description: Creates an authentication provider.
      operationId: CreateAuthenticationProvider
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AuthenticationProviderCreate"
        description: Parameters that can be defined during authentication provider creation
        required: true
      responses:
        "200":
          $ref: "#/components/responses/AuthenticationProviderResponse"
        "422":
          description: Bad request
      summary: Creates an authentication provider
      tags:
        - Authentication Providers
      x-latency-category: responsive
  "/authentication_providers/{id}":
    delete:
      description: Deletes an existing authentication provider.
      operationId: DeleteAuthenticationProvider
      parameters:
        - description: authentication provider ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/AuthenticationProviderResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Deletes an authentication provider
      tags:
        - Authentication Providers
      x-latency-category: responsive
    get:
      description: Retrieves the details of an existing authentication provider.
      operationId: getAuthenticationProvider
      parameters:
        - description: authentication provider ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/AuthenticationProviderResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve an authentication provider
      tags:
        - Authentication Providers
      x-latency-category: responsive
    patch:
      description: Updates settings of an existing authentication provider.
      operationId: updateAuthenticationProvider
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateAuthenticationProviderRequest"
        description: Parameters that can be updated in a authentication provider
        required: true
      responses:
        "200":
          $ref: "#/components/responses/AuthenticationProviderResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Update a authentication provider
      tags:
        - Authentication Providers
      x-latency-category: responsive
  /available_phone_number_blocks:
    get:
      operationId: listAvailablePhoneNumberBlocks
      parameters:
        - description: Filter number blocks that start with a pattern (meant to be used after `national_destination_code` filter has been set).
          in: query
          name: filter[phone_number][starts_with]
          schema:
            example: "201"
            type: string
        - description: Filter numbers ending with a pattern.
          in: query
          name: filter[phone_number][ends_with]
          schema:
            example: "8000"
            type: string
        - description: Filter numbers containing a pattern.
          in: query
          name: filter[phone_number][contains]
          schema:
            example: "456"
            type: string
        - description: Filter phone numbers by city.
          examples:
            AU:
              value: Canberra
            CA:
              value: Toronto
            US:
              value: Chicago
          in: query
          name: filter[locality]
          schema:
            type: string
        - description: Filter phone numbers by US state/CA province.
          in: query
          name: filter[administrative_area]
          schema:
            example: IL
            type: string
        - description: Filter phone numbers by ISO alpha-2 country code.
          in: query
          name: filter[country_code]
          schema:
            example: US
            type: string
        - description: Filter by the national destination code of the number. This filter is only applicable to North American numbers.
          examples:
            AU:
              value: "0251"
            CA:
              value: "437"
            US:
              value: "312"
          in: query
          name: filter[national_destination_code]
          schema:
            type: string
        - description: Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers.
          in: query
          name: filter[rate_center]
          schema:
            example: CHICAGO HEIGHTS
            type: string
        - description: Filter phone numbers by number type.
          in: query
          name: filter[number_type]
          schema:
            enum:
              - toll-free
            example: toll-free
            type: string
        - description: Filter if the phone number should be used for voice, fax, mms, sms, emergency.
          in: query
          name: filter[features]
          schema:
            example: voice,sms
            items:
              enum:
                - sms
                - mms
                - voice
                - fax
                - emergency
              type: string
            type: array
        - description: Filter number blocks by minimum blocks size
          in: query
          name: filter[minimum_block_size]
          schema:
            example: 100
            type: integer
        - description: Limits the number of results.
          in: query
          name: filter[limit]
          schema:
            example: 100
            type: integer
      responses:
        "200":
          $ref: "#/components/responses/ListAvailablePhoneNumbersBlockResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List available phone number blocks
      tags:
        - Number Search
      x-latency-category: responsive
  /available_phone_numbers:
    get:
      operationId: listAvailablePhoneNumbers
      parameters:
        - description: Filter numbers starting with a pattern (meant to be used after `national_destination_code` filter has been set).
          examples:
            generic:
              summary: Find numbers starting with the prefix 'FREE'
              value: FOO
          in: query
          name: filter[phone_number][starts_with]
          schema:
            type: string
        - description: Filter numbers ending with a pattern.
          examples:
            generic:
              summary: Find numbers ending with the suffix 'CALL'
              value: CALL
          in: query
          name: filter[phone_number][ends_with]
          schema:
            type: string
        - description: Filter numbers containing a pattern.
          examples:
            generic:
              summary: Find numbers that contain the word 'TELNYX' in any position
              value: TELNYX
          in: query
          name: filter[phone_number][contains]
          schema:
            type: string
        - description: Filter phone numbers by city.
          examples:
            AU:
              value: Canberra
            CA:
              value: Toronto
            US:
              value: Chicago
          in: query
          name: filter[locality]
          schema:
            type: string
        - description: Filter phone numbers by US state/CA province.
          in: query
          name: filter[administrative_area]
          schema:
            example: IL
            type: string
        - description: Filter phone numbers by ISO alpha-2 country code.
          in: query
          name: filter[country_code]
          schema:
            example: US
            type: string
        - description: Filter by the national destination code of the number. This filter is only applicable to North American numbers.
          examples:
            AU:
              value: "0251"
            CA:
              value: "437"
            US:
              value: "312"
          in: query
          name: filter[national_destination_code]
          schema:
            type: string
        - description: Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers.
          in: query
          name: filter[rate_center]
          schema:
            example: CHICAGO HEIGHTS
            type: string
        - description: Filter phone numbers by number type.
          in: query
          name: filter[number_type]
          schema:
            enum:
              - toll-free
              - national
              - mobile
              - local
            example: local
            type: string
        - description: Filter if the phone number should be used for voice, fax, mms, sms, emergency.
          in: query
          name: filter[features]
          schema:
            example: voice,sms
            items:
              enum:
                - sms
                - mms
                - voice
                - fax
                - emergency
              type: string
            type: array
        - description: Limits the number of results.
          in: query
          name: filter[limit]
          schema:
            example: 100
            type: integer
        - description: Filter to determine if best effort results should be included.
          in: query
          name: filter[best_effort]
          schema:
            example: false
            type: boolean
        - description: Filter to exclude phone numbers that need additional time after to purchase to receive phone calls.
          in: query
          name: filter[quickship]
          schema:
            example: true
            type: boolean
        - description: Filter to exclude phone numbers that cannot be reserved before purchase.
          in: query
          name: filter[reservable]
          schema:
            example: true
            type: boolean
        - description: Filter to exclude phone numbers that are currently on hold for your account.
          in: query
          name: filter[exclude_held_numbers]
          schema:
            example: false
            type: boolean
      responses:
        "200":
          $ref: "#/components/responses/ListAvailablePhoneNumbersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List available phone numbers
      tags:
        - Number Search
      x-endpoint-cost: heavy
      x-group-parameters: "true"
      x-latency-category: responsive
  /balance:
    get:
      operationId: getUserBalance
      responses:
        "200":
          $ref: "#/components/responses/UserBalanceResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve user balance details
      tags:
        - Billing
      x-latency-category: responsive
  /billing_groups:
    get:
      operationId: listBillingGroups
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListBillingGroupsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all billing groups
      tags:
        - Billing Groups
      x-latency-category: responsive
    post:
      operationId: createBillingGroup
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NewBillingGroup"
        description: New billing group object
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CreateBillingGroupResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a billing group
      tags:
        - Billing Groups
      x-latency-category: responsive
  "/billing_groups/{id}":
    delete:
      operationId: deleteBillingGroup
      parameters:
        - $ref: "#/components/parameters/BillingGroupId"
      responses:
        "200":
          $ref: "#/components/responses/DeleteBillingGroupResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a billing group
      tags:
        - Billing Groups
      x-latency-category: responsive
    get:
      operationId: retrieveBillingGroup
      parameters:
        - $ref: "#/components/parameters/BillingGroupId"
      responses:
        "200":
          $ref: "#/components/responses/RetrieveBillingGroupResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a billing group
      tags:
        - Billing Groups
      x-latency-category: responsive
    patch:
      operationId: updateBillingGroup
      parameters:
        - $ref: "#/components/parameters/BillingGroupId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateBillingGroup"
        description: Update billing group object
        required: true
      responses:
        "200":
          $ref: "#/components/responses/UpdateBillingGroupResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a billing group
      tags:
        - Billing Groups
      x-latency-category: responsive
  /call_control_applications:
    get:
      description: Return a list of call control applications.
      operationId: listCallControlApplications
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterApplicationName"
        - $ref: "#/components/parameters/FilterOutboundVoiceProfileId"
        - $ref: "#/components/parameters/SortConnection"
      responses:
        "200":
          $ref: "#/components/responses/ListCallControlApplicationsResponse"
        "400":
          description: Bad request
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          description: Resource not found
      summary: List call control applications
      tags:
        - Call Control Applications
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: interactive
    post:
      description: Create a call control application.
      operationId: createCallControlApplication
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateCallControlApplicationRequest"
        description: Create call control application request.
        required: true
      responses:
        "201":
          $ref: "#/components/responses/CallControlApplicationResponse"
        "422":
          description: Bad Request
      summary: Create a call control application
      tags:
        - Call Control Applications
      x-endpoint-cost: medium
      x-latency-category: interactive
  "/call_control_applications/{id}":
    delete:
      description: Deletes a call control application.
      operationId: deleteCallControlApplication
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            example: "1293384261075731499"
            format: int64
            type: string
      responses:
        "200":
          $ref: "#/components/responses/CallControlApplicationResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Delete a call control application
      tags:
        - Call Control Applications
      x-latency-category: interactive
    get:
      description: Retrieves the details of an existing call control application.
      operationId: retrieveCallControlApplication
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            example: "1293384261075731499"
            format: int64
            type: string
      responses:
        "200":
          $ref: "#/components/responses/CallControlApplicationResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve a call control application
      tags:
        - Call Control Applications
      x-latency-category: interactive
    patch:
      description: Updates settings of an existing call control application.
      operationId: updateCallControlApplication
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            example: "1293384261075731499"
            format: int64
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateCallControlApplicationRequest"
        description: Update call control application request.
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlApplicationResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Update a call control application
      tags:
        - Call Control Applications
      x-latency-category: interactive
  /call_events:
    get:
      description: |
        Filters call events by given filter parameters. Events are ordered by `event_timestamp`. If filter for `call_leg_id` or `call_session_id` is not present, it only filters events from the last 24 hours.

        **Note**: Only one `filter[event_timestamp]` can be passed.
      operationId: listCallEvents
      parameters:
        - $ref: "#/components/parameters/FilterCallLegId"
        - $ref: "#/components/parameters/FilterCallSessionId"
        - $ref: "#/components/parameters/FilterCallEventStatus"
        - $ref: "#/components/parameters/FilterCallEventType"
        - $ref: "#/components/parameters/FilterCallEventTimestampGreaterThan"
        - $ref: "#/components/parameters/FilterCallEventTimestampGreaterThanOrEqualTo"
        - $ref: "#/components/parameters/FilterCallEventTimestampLessThan"
        - $ref: "#/components/parameters/FilterCallEventTimestampLessThanOrEqualTo"
        - $ref: "#/components/parameters/FilterCallEventTimestampEqualTo"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListCallEventsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List call events
      tags:
        - Debugging
      x-group-parameters: "true"
      x-latency-category: responsive
  /calls:
    post:
      callbacks:
        callAnswered:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallAnsweredEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callHangup:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallHangupEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callInitiated:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallInitiatedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callMachineDetectionEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallMachineDetectionEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callMachineGreetingEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallMachineGreetingEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |-
        Dial a number or SIP URI from a given connection. A successful response will include a `call_leg_id` which can be used to correlate the command with subsequent webhooks.

        **Expected Webhooks:**

        - `call.initiated`
        - `call.answered` or `call.hangup`
        - `call.machine.detection.ended` if `answering_machine_detection` was requested
        - `call.machine.greeting.ended` if `answering_machine_detection` was set to `detect_beep`, `greeting_end` or `detect_words`
      operationId: callDial
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CallRequest"
        description: Call request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/RetrieveCallStatusResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Dial
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}":
    get:
      description: Returns the status of a call (data is available 10 minutes after call ended).
      operationId: retrieveCallStatus
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      responses:
        "200":
          $ref: "#/components/responses/RetrieveCallStatusResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a call status
      tags:
        - Call Information
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/answer":
    post:
      callbacks:
        callAnswered:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallAnsweredEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Answer an incoming call. You must issue this command before executing subsequent commands on an incoming call.

        **Expected Webhooks:**

        - `call.answered`
      operationId: callAnswer
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AnswerRequest"
        description: Answer call request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Answer call
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/bridge":
    post:
      callbacks:
        callBridged:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallBridgedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Bridge two call control calls.

        **Expected Webhooks:**

        - `call.bridged` for Leg A
        - `call.bridged` for Leg B
      operationId: callBridge
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BridgeRequest"
        description: Bridge call request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Bridge calls
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/enqueue":
    post:
      callbacks:
        callEnqueued:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallEnqueuedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callLeftQueue:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallLeftQueueEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: Put the call in a queue.
      operationId: callEnqueue
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EnqueueRequest"
        description: Enqueue call request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Enqueue call
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/fork_start":
    post:
      callbacks:
        callForkStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallForkStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callForkStopped:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallForkStoppedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Call forking allows you to stream the media from a call to a specific target in realtime. 
        This stream can be used to enable realtime audio analysis to support a 
        variety of use cases, including fraud detection, or the creation of AI-generated audio responses. 
        Requests must specify either the `target` attribute or the `rx` and `tx` attributes.

        **Expected Webhooks:**

        - `call.fork.started`
        - `call.fork.stopped`

        **Simple Telnyx RTP Encapsulation Protocol (STREP)**

        *Note: This header/encapsulation is not used when the `rx` and `tx`
        parameters have been specified; it only applies when media is forked
        using the `target` attribute.*

        If the destination for forked media is specified using the "target"
        attribute, the RTP will be encapsulated in an extra Telnyx protocol,
        which adds a 24 byte header to the RTP payload in each packet. The STREP
        header includes the Call Control `call_leg_id` for stream
        identification, along with bits that represent the direction (inbound or
        outbound) of the media. This 24-byte header sits between the UDP header
        and the RTP header.

        The STREP header makes it possible to fork RTP for multiple calls (or
        two RTP streams for the same call) to the same IP:port, where the
        streams can be demultiplexed by your application using the information
        in the header. Of course, it's still possible to ignore this header
        completely, for example, if sending forked media for different calls to
        different ports or IP addresses. In this case, simply strip 24 bytes
        (or use the second byte to find the header length) from the received UDP
        payload to get the RTP (RTP header and payload).

        ```
        STREP Specification

          0                   1                   2                   3
          0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         |1 1|Version|L|D|    HeaderLen  |  reserved (2 bytes)           |
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         |       reserved (4 bytes, for UDP ports or anything else)      |
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
         |               The call_leg_id                                 |
         |                   from Call Control                           |
         |                       (128 bits / 16 bytes)                   |
         |                           (this is binary data)               |
         +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

         11
           Static bits 11, always set to 11 to easily distinguish forked media
           from RTP (10) and T.38 media (usually 00) and SIP (which begins
           with a capital letter, so begins with bits 01). This is a magic number.

         Version
           Four bits to indicate the version number of the protocol, starting at 0001.

         L
           One bit to represent the leg of the call (A or B).
           0 represents the A (first) leg of the call.
           1 represents the B (second) leg of the call.

         D
           One bit to represent the direction of this RTP stream.
           0 represents media received by Telnyx.
           1 represents media transmitted by Telnyx.

         HeaderLen (1 byte)
           The length of the header in bytes.
           Note that this value does not include the length of the payload. The total
           size of the RTP can be calculated by subtracting the HeaderLen from the UDP
           length (minus 8 for the UDP header).
           In version 1, this value will always be 24.

         Reserved (6 bytes)
           Reserved for future use and to make sure that the header is a multiple of 32 bits

         Call Leg ID
           A 128-bit identifier for the call leg.
           This is the call_leg_id from Call Control.
        ```
      operationId: callForkStart
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StartForkingRequest"
        description: Fork media request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Forking start
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/fork_stop":
    post:
      callbacks:
        callForkStopped:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallForkStoppedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Stop forking a call.

        **Expected Webhooks:**

        - `call.fork.stopped`
      operationId: callForkStop
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StopForkingRequest"
        description: Stop forking media request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Forking stop
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/gather_stop":
    post:
      callbacks:
        callGatherEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallGatherEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Stop current gather.

        **Expected Webhooks:**

        - `call.gather.ended`
      operationId: callGatherStop
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StopGatherRequest"
        description: Stop current gather
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Gather stop
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/gather_using_audio":
    post:
      callbacks:
        callDtmfReceived:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallDtmfReceivedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callGatherEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallGatherEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callPlaybackEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallPlaybackEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callPlaybackStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallPlaybackStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Play an audio file on the call until the required DTMF signals are gathered to build interactive menus.

        You can pass a list of valid digits along with an 'invalid_audio_url', which will be played back at the beginning of each prompt. Playback will be interrupted when a DTMF signal is received. The [Answer](/docs/api/v2/call-control/Call-Commands#CallControlAnswer) command must be issued before the `gather_using_audio` command.

        **Expected Webhooks:**

        - `call.playback.started`
        - `call.playback.ended`
        - `call.dtmf.received` (you may receive many of these webhooks)
        - `call.gather.ended`
      operationId: callGatherUsingAudio
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GatherUsingAudioRequest"
        description: Gather using audio request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Gather using audio
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/gather_using_speak":
    post:
      callbacks:
        callDtmfReceived:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallDtmfReceivedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callGatherEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallGatherEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Convert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus.

        You can pass a list of valid digits along with an 'invalid_payload', which will be played back at the beginning of each prompt. Speech will be interrupted when a DTMF signal is received. The [Answer](/docs/api/v2/call-control/Call-Commands#CallControlAnswer) command must be issued before the `gather_using_speak` command.

        **Expected Webhooks:**

        - `call.dtmf.received` (you may receive many of these webhooks)
        - `call.gather.ended`
      operationId: callGatherUsingSpeak
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GatherUsingSpeakRequest"
        description: Gather using speak request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Gather using speak
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/hangup":
    post:
      callbacks:
        callHangup:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallHangupEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callRecordingSaved:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallRecordingSavedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Hang up the call.

        **Expected Webhooks:**

        - `call.hangup`
        - `call.recording.saved`
      operationId: callHangup
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/HangupRequest"
        description: Hangup request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Hangup call
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/leave_queue":
    post:
      callbacks:
        callLeftQueue:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallLeftQueueEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: Removes the call from a queue.
      operationId: leaveQueue
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LeaveQueueRequest"
        description: Removes the call from the queue, the call currently is enqueued in.
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Remove call from a queue
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/playback_start":
    post:
      callbacks:
        callPlaybackEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallPlaybackEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callPlaybackStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallPlaybackStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Play an audio file on the call. If multiple play audio commands are issued consecutively,
        the audio files will be placed in a queue awaiting playback.

        *Notes:*

        - When `overlay` is enabled, `target_legs` is limited to `self`.
        - A customer cannot Play Audio with `overlay=true` unless there is a Play Audio with `overlay=false` actively playing.

        **Expected Webhooks:**

        - `call.playback.started`
        - `call.playback.ended`
      operationId: callPlaybackStart
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PlayAudioUrlRequest"
        description: Play audio URL request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Play audio URL
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/playback_stop":
    post:
      callbacks:
        callPlaybackEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallPlaybackEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callSpeakEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallSpeakEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Stop audio being played on the call.

        **Expected Webhooks:**

        - `call.playback.ended` or `call.speak.ended`
      operationId: callPlaybackStop
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PlaybackStopRequest"
        description: Stop audio playback request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Stop audio playback
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/record_pause":
    post:
      description: |
        Pause recording the call. Recording can be resumed via Resume recording command.

        **Expected Webhooks:**

        There are no webhooks associated with this command.
      operationId: callRecordPause
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PauseRecordingRequest"
        description: Pause recording call request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Record pause
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/record_resume":
    post:
      description: |
        Resume recording the call.

        **Expected Webhooks:**

        There are no webhooks associated with this command.
      operationId: callRecordResume
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ResumeRecordingRequest"
        description: Resume recording call request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Record resume
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/record_start":
    post:
      description: |
        Start recording the call. Recording will stop on call hang-up, or can be initiated via the Stop Recording command.

        **Expected Webhooks:**

        - `call.recording.saved`
      operationId: callRecordStart
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StartRecordingRequest"
        description: Start recording audio request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Recording start
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/record_stop":
    post:
      callbacks:
        callRecordingSaved:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallRecordingSavedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Stop recording the call.

        **Expected Webhooks:**

        - `call.recording.saved`
      operationId: callRecordStop
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StopRecordingRequest"
        description: Stop recording call request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Recording stop
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/refer":
    post:
      callbacks:
        callReferCompleted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallReferCompletedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callReferFailed:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallReferFailedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callReferStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallReferStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Initiate a SIP Refer on a Call Control call. You can initiate a SIP Refer at any point in the duration of a call.

        **Expected Webhooks:**

        - `call.refer.started`
        - `call.refer.completed`
        - `call.refer.failed`
      operationId: callRefer
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ReferRequest"
        description: Refer request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: SIP Refer a call
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/reject":
    post:
      callbacks:
        callHangup:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallHangupEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Reject an incoming call.

        **Expected Webhooks:**

        - `call.hangup`
      operationId: callReject
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RejectRequest"
        description: Reject request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Reject a call
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/send_dtmf":
    post:
      description: |
        Sends DTMF tones from this leg. DTMF tones will be heard by the other end of the call.

        **Expected Webhooks:**

        There are no webhooks associated with this command.
      operationId: callSendDTMF
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SendDTMFRequest"
        description: Send DTMF request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Send DTMF
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/speak":
    post:
      callbacks:
        callSpeakEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallSpeakEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callSpeakStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallSpeakStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Convert text to speech and play it back on the call. If multiple speak text commands are issued consecutively, the audio files will be placed in a queue awaiting playback.

        **Expected Webhooks:**

        - `call.speak.started`
        - `call.speak.ended`
      operationId: callSpeak
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SpeakRequest"
        description: Speak request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Speak text
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/transcription_start":
    post:
      callbacks:
        transcription:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/TranscriptionEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command.
      operationId: callTranscriptionStart
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TranscriptionStartRequest"
        description: Transcription start request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Transcription start
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/transcription_stop":
    post:
      description: Stop real-time transcription.
      operationId: callTranscriptionStop
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TranscriptionStopRequest"
        description: Transcription stop request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Transcription stop
      tags:
        - Call Commands
      x-latency-category: interactive
  "/calls/{call_control_id}/actions/transfer":
    post:
      callbacks:
        callAnswered:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallAnsweredEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callBridged:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallBridgedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callHangup:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallHangupEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callInitiated:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallInitiatedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |-
        Transfer a call to a new destination. If the transfer is unsuccessful, a `call.hangup` webhook for the other call (Leg B) will be sent indicating that the transfer could not be completed. The original call will remain active and may be issued additional commands, potentially transfering the call to an alternate destination.

        **Expected Webhooks:**

        - `call.initiated`
        - `call.bridged` to Leg B
        - `call.answered` or `call.hangup`
        - `call.machine.detection.ended` if `answering_machine_detection` was requested
        - `call.machine.greeting.ended` if `answering_machine_detection` was set to `detect_beep`, `greeting_end` or `detect_words`
      operationId: callTransfer
      parameters:
        - $ref: "#/components/parameters/CallControlId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TransferCallRequest"
        description: Transfer call request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CallControlCommandResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Transfer call
      tags:
        - Call Commands
      x-latency-category: interactive
  /comments:
    get:
      operationId: listComments
      parameters:
        - description: Record type that the comment relates to i.e number_order, sub_number_order or number_order_phone_number
          in: query
          name: filter[comment_record_type]
          required: true
          schema:
            example: sub_number_order
            type: string
        - description: ID of the record the comments relate to
          in: query
          name: filter[comment_record_id]
          required: true
          schema:
            example: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
            type: string
      responses:
        "200":
          $ref: "#/components/responses/listCommentsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve all comments
      tags:
        - Number Orders
      x-latency-category: responsive
    post:
      operationId: createComment
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Comment"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CommentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a comment
      tags:
        - Number Orders
      x-latency-category: responsive
  "/comments/{id}":
    get:
      operationId: retrieveComment
      responses:
        "200":
          $ref: "#/components/responses/CommentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a comment
      tags:
        - Number Orders
      x-latency-category: responsive
    parameters:
      - description: The comment ID.
        in: path
        name: id
        required: true
        schema:
          type: string
  "/comments/{id}/read":
    parameters:
      - description: The comment ID.
        in: path
        name: id
        required: true
        schema:
          type: string
    patch:
      operationId: markCommentRead
      responses:
        "200":
          $ref: "#/components/responses/ReadCommentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Mark a comment as read
      tags:
        - Number Orders
      x-latency-category: responsive
  /conferences:
    get:
      description: Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by `expires_at`.
      operationId: listConferences
      parameters:
        - $ref: "#/components/parameters/FilterConferenceName"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListConferencesResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: List conferences
      tags:
        - Conference Commands
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      callbacks:
        conferenceCreated:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceCreatedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceFloorChanged:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceFloorChangedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceParticipantJoined:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantJoinedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceParticipantLeft:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantLeftEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Create a conference from an existing call leg using a `call_control_id` and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.

        **Expected Webhooks:**

        - `conference.created`
        - `conference.participant.joined`
        - `conference.participant.left`
        - `conference.ended`
        - `conference.recording.saved`
        - `conference.floor.changed`
      operationId: createConference
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateConferenceRequest"
        description: Create a conference
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Create conference
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{conference_id}/participants":
    get:
      description: Lists conference participants
      operationId: listConferenceParticipants
      parameters:
        - description: Uniquely identifies the conference by id
          in: path
          name: conference_id
          required: true
          schema:
            type: string
        - description: If present, participants will be filtered to those who are/are not muted
          in: query
          name: filter[muted]
          schema:
            type: boolean
        - description: If present, participants will be filtered to those who are/are not put on hold
          in: query
          name: filter[on_hold]
          schema:
            type: boolean
        - description: If present, participants will be filtered to those who are whispering or are not
          in: query
          name: filter[whispering]
          schema:
            type: boolean
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListParticipantsResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: List conference participants
      tags:
        - Conference Commands
      x-group-parameters: "true"
      x-latency-category: interactive
  "/conferences/{id}":
    get:
      description: Retrieve an existing conference
      operationId: retrieveConference
      parameters:
        - description: Uniquely identifies the conference by id
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ConferenceResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
      summary: Retrieve a conference
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/dial_participant":
    post:
      callbacks:
        callAnswered:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallAnsweredEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        callHangup:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/CallHangupEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceParticipantJoined:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantJoinedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceParticipantLeft:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantLeftEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Dials a phone number and, when the call is answered, automatically joins them into the specified conference.

        **Expected Webhooks:**

        - `call.hangup`
        - `call.answered`
        - `conference.participant.joined`
        - `conference.participant.left`
      operationId: conferenceDialParticipantIn
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConferenceCallRequest"
        description: Dial Into Conference request object
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Dial a new participant into a conference
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/hold":
    post:
      description: Hold a list of participants in a conference call
      operationId: conferenceHoldParticipants
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConferenceHoldRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Hold conference participants
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/join":
    post:
      callbacks:
        conferenceParticipantJoined:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantJoinedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceParticipantLeft:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantLeftEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the `call_control_id` of the leg you wish to join to the conference as an attribute.

        **Expected Webhooks:**

        - `conference.participant.joined`
        - `conference.participant.left`
      operationId: conferenceJoin
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/JoinConferenceRequest"
        description: Join Conference request object
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Join a conference
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/leave":
    post:
      callbacks:
        conferenceParticipantLeft:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantLeftEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Removes a call leg from a conference and moves it back to parked state. **Expected Webhooks:**

        - `conference.participant.left`
      operationId: conferenceLeave
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LeaveConferenceRequest"
        description: Leave Conference request object
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Leave a conference
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/mute":
    post:
      description: Mute a list of participants in a conference call
      operationId: conferenceMuteParticipants
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConferenceMuteRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Mute conference participants
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/play":
    post:
      callbacks:
        conferenceParticipantPlaybackEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantPlaybackEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceParticipantPlaybackStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantPlaybackStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferencePlaybackEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferencePlaybackEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferencePlaybackStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferencePlaybackStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: Play audio to all or some participants on a conference call.
      operationId: conferencePlayAudio
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConferencePlayRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Play audio to conference participants
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/record_start":
    post:
      description: |-
        Start recording the conference. Recording will stop on conference end, or via the Stop Recording command.

        **Expected Webhooks:**

        - `conference.recording.saved`
      operationId: conferenceStartRecording
      parameters:
        - description: Specifies the conference to record by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StartRecordingRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Conference recording start
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/record_stop":
    post:
      callbacks:
        conferenceRecordingSaved:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceRecordingSavedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Stop recording the conference.

        **Expected Webhooks:**

        - `conference.recording.saved`
      operationId: conferenceStopRecording
      parameters:
        - description: Specifies the conference to stop the recording for by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StopRecordingRequest"
        description: Stop recording conference request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Conference recording stop
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/speak":
    post:
      callbacks:
        conferenceParticipantSpeakEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantSpeakEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceParticipantSpeakStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantSpeakStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceSpeakEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceSpeakEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        conferenceSpeakStarted:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceSpeakStartedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: Convert text to speech and play it to all or some participants.
      operationId: conferenceSpeakText
      parameters:
        - description: Specifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConferenceSpeakRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Speak text to conference participants
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/stop":
    post:
      callbacks:
        conferenceParticipantPlaybackEnded:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ConferenceParticipantPlaybackEndedEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: Stop audio being played to all or some participants on a conference call.
      operationId: conferenceStopAudio
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConferenceStopRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Stop audio being played on the conference
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/unhold":
    post:
      description: Unhold a list of participants in a conference call
      operationId: conferenceUnholdParticipants
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConferenceUnholdRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Unhold conference participants
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/unmute":
    post:
      description: Unmute a list of participants in a conference call
      operationId: conferenceUnmuteParticipants
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ConferenceUnmuteRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Unmute conference participants
      tags:
        - Conference Commands
      x-latency-category: interactive
  "/conferences/{id}/actions/update":
    post:
      description: Update conference participant supervisor_role
      operationId: conferenceUpdate
      parameters:
        - description: Uniquely identifies the conference by id or name
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateConferenceRequest"
        description: Update Conference request object
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ConferenceCommandResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: Update conference participant
      tags:
        - Conference Commands
      x-latency-category: interactive
  /connections:
    get:
      description: Returns a list of your connections irrespective of type.
      operationId: listConnections
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterConnectionName"
        - $ref: "#/components/parameters/FilterOutboundVoiceProfileId"
        - $ref: "#/components/parameters/SortConnection"
      responses:
        "200":
          $ref: "#/components/responses/ListConnectionsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List connections
      tags:
        - Connections
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
  "/connections/{id}":
    get:
      description: Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.
      operationId: retrieveConnection
      parameters:
        - description: IP Connection ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve a connection
      tags:
        - Connections
      x-latency-category: responsive
  /credential_connections:
    get:
      description: Returns a list of your credential connections.
      operationId: listCredentialConnections
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterConnectionName"
        - $ref: "#/components/parameters/FilterInnerOutboundVoiceProfileId"
        - $ref: "#/components/parameters/SortConnection"
      responses:
        "200":
          $ref: "#/components/responses/ListCredentialConnectionsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List credential connections
      tags:
        - Credential Connections
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Creates a credential connection.
      operationId: createCredentialConnection
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateCredentialConnectionRequest"
        description: Parameters that can be defined during credential connection creation
        required: true
      responses:
        "201":
          $ref: "#/components/responses/CredentialConnectionResponse"
        "422":
          description: Bad request
      summary: Create a credential connection
      tags:
        - Credential Connections
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/credential_connections/{id}":
    delete:
      description: Deletes an existing credential connection.
      operationId: deleteCredentialConnection
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/CredentialConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Delete a credential connection
      tags:
        - Credential Connections
      x-latency-category: responsive
    get:
      description: Retrieves the details of an existing credential connection.
      operationId: retrieveCredentialConnection
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/CredentialConnectionResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: Retrieve a credential connection
      tags:
        - Credential Connections
      x-latency-category: responsive
    patch:
      description: Updates settings of an existing credential connection.
      operationId: updateCredentialConnection
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateCredentialConnectionRequest"
        description: Parameters that can be updated in a credential connection
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CredentialConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Update a credential connection
      tags:
        - Credential Connections
      x-latency-category: responsive
  /detail_records:
    get:
      description: Search for any detail record across the Telnyx Platform
      operationId: DetailRecordsSearch
      parameters:
        - description: Filter by the given record type
          examples:
            "filter[record_type]=messaging":
              summary: Searches for messaging detail records
              value: messaging
          in: query
          name: filter[record_type]
          required: true
          schema:
            type: string
        - description: Filter by the given user-friendly date range
          examples:
            "filter[date_range]=last_3_days":
              summary: Searches for records with timestamp starting at `00:00:00` since 3 days ago
              value: last_3_days
            "filter[date_range]=today":
              summary: Searches for records with timestamp starting at `00:00:00` of the current day
              value: today
          in: query
          name: filter[date_range]
          required: false
          schema:
            type: string
        - description: Filter records
          examples:
            "filter[cld][contains]=456":
              summary: Searches for records which have the property `cld` containing the pattern `456`
              value: "456"
            "filter[cld][ends_with]=789":
              summary: Searches for records which have the property `cld` ending with the suffix `789`
              value: "789"
            "filter[cld][starts_with]=123":
              summary: Searches for records which have the property `cld` starting with the prefix `123`
              value: "123"
            "filter[created_at][gte]=2021-06-22":
              summary: Searches for records with `created_at` starting at `2021-06-22`
              value: 2021-06-22
            "filter[created_at][lt]=2021-06-23":
              summary: Searches for records with `created_at` ending at `2021-06-22`
              value: 2021-06-23
            "filter[direction]=inbound":
              summary: Searches for records which have the property `direction` equal to `inbound`
              value: inbound
          in: query
          name: filter
          required: false
          schema:
            additionalProperties: true
            type: object
        - description: Page number
          in: query
          name: page[number]
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Page size
          in: query
          name: page[size]
          schema:
            default: 20
            format: int32
            maximum: 50
            minimum: 1
            type: integer
        - description: Specifies the sort order for results
          examples:
            sort=-created_at:
              summary: Sorts search results using the `created_at` date-time in descending order
              value: created_at
            sort=created_at:
              summary: Sorts search results using the `created_at` date-time in ascending order
              value: created_at
          in: query
          name: sort
          schema:
            items:
              type: string
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DetailRecordsSearchResponse"
          description: Successful
      security:
        - bearerAuth: []
      summary: Search detail records
      tags:
        - Detail Records
      x-latency-category: interactive
  /document_links:
    get:
      description: List all documents links ordered by created_at descending.
      operationId: listDocumentLinks
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/DocServiceDocumentIdFilter"
        - $ref: "#/components/parameters/LinkedRecordTypeFilter"
        - $ref: "#/components/parameters/LinkedResourceIdFilter"
      responses:
        "200":
          $ref: "#/components/responses/ListDocServiceDocumentLinksResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all document links
      tags:
        - Documents
      x-latency-category: responsive
  /documents:
    get:
      description: List all documents ordered by created_at descending.
      operationId: listDocuments
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListDocServiceDocumentsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all documents
      tags:
        - Documents
      x-latency-category: responsive
    post:
      description: Upload a document.<br /><br />Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.
      operationId: createDocument
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateDocServiceDocumentRequest"
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/CreateMultiPartDocServiceDocumentRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/DocServiceDocumentResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Upload a document
      tags:
        - Documents
      x-latency-category: responsive
  "/documents/{id}":
    delete:
      description: Delete a document.<br /><br />A document can only be deleted if it's not linked to a service. If it is linked to a service, it must be unlinked prior to deleting.
      operationId: deleteDocument
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          $ref: "#/components/responses/DocServiceDocumentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a document
      tags:
        - Documents
      x-latency-category: responsive
    get:
      description: Retrieve a document.
      operationId: retrieveDocument
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          $ref: "#/components/responses/DocServiceDocumentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a document
      tags:
        - Documents
      x-latency-category: responsive
    patch:
      description: Update a document.
      operationId: updateDocument
      parameters:
        - $ref: "#/components/parameters/Id"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DocServiceDocument"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/DocServiceDocumentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a document
      tags:
        - Documents
      x-latency-category: responsive
  "/documents/{id}/download":
    get:
      description: Download a document.
      operationId: downloadDocServiceDocument
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          $ref: "#/components/responses/DownloadDocServiceDocumentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Download a document
      tags:
        - Documents
      x-latency-category: responsive
  /fax_applications:
    get:
      description: This endpoint returns a list of your Fax Applications inside the 'data' attribute of the response. You can adjust which applications are listed by using filters. Fax Applications are used to configure how you send and receive faxes using the Programmable Fax API with Telnyx.
      operationId: listFaxApplications
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterApplicationName"
        - $ref: "#/components/parameters/FilterOutboundVoiceProfileId"
        - $ref: "#/components/parameters/SortConnection"
      responses:
        "200":
          $ref: "#/components/responses/GetAllFaxApplicationsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List all Fax Applications
      tags:
        - Programmable Fax Applications
      x-endpoint-cost: medium
      x-latency-category: responsive
    post:
      description: Creates a new Fax Application based on the parameters sent in the request. The application name and webhook URL are required. Once created, you can assign phone numbers to your application using the `/phone_numbers` endpoint.
      operationId: CreateFaxApplication
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateFaxApplicationRequest"
        description: Parameters that can be set when creating a Fax Application
        required: true
      responses:
        "201":
          $ref: "#/components/responses/FaxApplicationResponse"
        "422":
          description: Bad request
      summary: Creates a Fax Application
      tags:
        - Programmable Fax Applications
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/fax_applications/{id}":
    delete:
      description: Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers.
      operationId: DeleteFaxApplication
      parameters:
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          $ref: "#/components/responses/FaxApplicationResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Deletes a Fax Application
      tags:
        - Programmable Fax Applications
      x-latency-category: responsive
    get:
      description: Return the details of an existing Fax Application inside the 'data' attribute of the response.
      operationId: getFaxApplication
      parameters:
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          $ref: "#/components/responses/FaxApplicationResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve a Fax Application
      tags:
        - Programmable Fax Applications
      x-latency-category: responsive
    patch:
      description: Updates settings of an existing Fax Application based on the parameters of the request.
      operationId: UpdateFaxApplication
      parameters:
        - $ref: "#/components/parameters/id"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateFaxApplicationRequest"
        description: Parameters to be updated for the Fax Application
        required: true
      responses:
        "200":
          $ref: "#/components/responses/FaxApplicationResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Update a Fax Application
      tags:
        - Programmable Fax Applications
      x-latency-category: responsive
  /faxes:
    get:
      description: ""
      operationId: ListFaxes
      parameters:
        - description: ISO 8601 date time for filtering faxes created after or on that date
          in: query
          name: filter[created_at][gte]
          schema:
            example: 2020-02-02T22:25:27.521992Z
            format: date-time
            type: string
        - description: ISO 8601 date time for filtering faxes created after that date
          in: query
          name: filter[created_at][gt]
          schema:
            example: 2020-02-02T22:25:27.521992Z
            format: date-time
            type: string
        - description: ISO 8601 formatted date time for filtering faxes created on or before that date
          in: query
          name: filter[created_at][lte]
          schema:
            example: 2020-02-02T22:25:27.521992Z
            format: date-time
            type: string
        - description: ISO 8601 formatted date time for filtering faxes created before that date
          in: query
          name: filter[created_at][lt]
          schema:
            example: 2020-02-02T22:25:27.521992Z
            format: date-time
            type: string
        - description: The direction, inbound or outbound, for filtering faxes sent from this account
          in: query
          name: filter[direction][eq]
          schema:
            example: inbound
            type: string
        - description: The phone number, in E.164 format for filtering faxes sent from this number
          in: query
          name: filter[from][eq]
          schema:
            example: "+13127367276"
            type: string
        - description: Number of fax resourcxes for the single page returned
          in: query
          name: page[size]
          schema:
            example: 2
            type: integer
        - description: Number of the page to be retrieved
          in: query
          name: page[number]
          schema:
            example: 2
            type: integer
      responses:
        "200":
          $ref: "#/components/responses/ListFaxesResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: View a list of faxes
      tags:
        - Programmable Fax Commands
      x-latency-category: background
    post:
      callbacks:
        fax.delivered:
          "{$response.body#/data/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/FaxDelivered"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        fax.failed:
          "{$response.body#/data/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/FaxFailed"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        fax.media.processed:
          "{$response.body#/data/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/FaxMediaProcessed"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        fax.queued:
          "{$response.body#/data/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/FaxQueued"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        fax.sending.started:
          "{$response.body#/data/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/FaxSendingStarted"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: ""
      operationId: SendFax
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SendFaxRequest"
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/SendFaxMultipartRequest"
        description: Send fax request
        required: true
      responses:
        "202":
          $ref: "#/components/responses/SendFaxResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Send a fax
      tags:
        - Programmable Fax Commands
      x-latency-category: responsive
  "/faxes/{id}":
    delete:
      operationId: DeleteFax
      parameters:
        - description: The unique identifier of a fax.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "204":
          description: The resource was deleted successfully.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a fax
      tags:
        - Programmable Fax Commands
      x-latency-category: responsive
    get:
      operationId: ViewFax
      parameters:
        - description: The unique identifier of a fax.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          $ref: "#/components/responses/GetFaxResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: View a fax
      tags:
        - Programmable Fax Commands
      x-latency-category: responsive
  "/faxes/{id}/actions/refresh":
    post:
      description: Refreshes the inbound fax's media_url when it has expired
      operationId: RefreshFax
      parameters:
        - description: The unique identifier of a fax.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          $ref: "#/components/responses/RefreshFaxResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Refresh a fax
      tags:
        - Programmable Fax Commands
      x-latency-category: responsive
  /fqdn_connections:
    get:
      description: Returns a list of your FQDN connections.
      operationId: listFqdnConnections
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterConnectionName"
        - $ref: "#/components/parameters/SortConnection"
      responses:
        "200":
          $ref: "#/components/responses/ListFqdnConnectionsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List FQDN connections
      tags:
        - FQDN Connections
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Creates a FQDN connection.
      operationId: createFqdnConnection
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateFqdnConnectionRequest"
        description: Parameters that can be defined during FQDN connection creation
        required: true
      responses:
        "201":
          $ref: "#/components/responses/FqdnConnectionResponse"
        "422":
          description: Bad request
      summary: Create an FQDN connection
      tags:
        - FQDN Connections
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/fqdn_connections/{id}":
    delete:
      description: Deletes an FQDN connection.
      operationId: deleteFqdnConnection
      parameters:
        - description: FQDN Connection ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/FqdnConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Delete an FQDN connection
      tags:
        - FQDN Connections
      x-latency-category: responsive
    get:
      description: Retrieves the details of an existing FQDN connection.
      operationId: retrieveFqdnConnection
      parameters:
        - description: FQDN Connection ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/FqdnConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve an FQDN connection
      tags:
        - FQDN Connections
      x-latency-category: responsive
    patch:
      description: Updates settings of an existing FQDN connection.
      operationId: updateFqdnConnection
      parameters:
        - description: FQDN Connection ID
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateFqdnConnectionRequest"
        description: Parameters that can be updated in a FQDN connection
        required: true
      responses:
        "200":
          $ref: "#/components/responses/FqdnConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Update an FQDN connection
      tags:
        - FQDN Connections
      x-latency-category: responsive
  /fqdns:
    get:
      description: Get all FQDNs belonging to the user that match the given filters.
      operationId: listFqdns
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: ID of the FQDN connection to which the FQDN belongs.
          in: query
          name: filter[connection_id]
          schema:
            type: string
        - description: FQDN represented by the resource.
          in: query
          name: filter[fqdn]
          schema:
            example: example.com
            type: string
        - description: Port to use when connecting to the FQDN.
          in: query
          name: filter[port]
          schema:
            example: 5060
            type: integer
        - description: DNS record type used by the FQDN.
          in: query
          name: filter[dns_record_type]
          schema:
            example: a
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ListFqdnsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: List FQDNs
      tags:
        - FQDNs
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Create a new FQDN object.
      operationId: createFqdn
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateFqdnRequest"
      responses:
        "201":
          $ref: "#/components/responses/FqdnResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: Create an FQDN
      tags:
        - FQDNs
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/fqdns/{id}":
    delete:
      description: Delete an FQDN.
      operationId: deleteFqdn
      parameters:
        - $ref: "#/components/parameters/FqdnId"
      responses:
        "200":
          $ref: "#/components/responses/FqdnResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: Delete an FQDN
      tags:
        - FQDNs
      x-latency-category: responsive
    get:
      description: Return the details regarding a specific FQDN.
      operationId: retrieveFqdn
      parameters:
        - $ref: "#/components/parameters/FqdnId"
      responses:
        "200":
          $ref: "#/components/responses/FqdnResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: Retrieve an FQDN
      tags:
        - FQDNs
      x-latency-category: responsive
    patch:
      description: Update the details of a specific FQDN.
      operationId: updateFqdn
      parameters:
        - $ref: "#/components/parameters/FqdnId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateFqdnRequest"
      responses:
        "200":
          $ref: "#/components/responses/FqdnResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: Update an FQDN
      tags:
        - FQDNs
      x-latency-category: responsive
  /inventory_coverage:
    get:
      description: Creates an inventory coverage request. If locality, npa or national_destination_code is used in groupBy, and no region or locality filters are used, the whole paginated set is returned.
      operationId: createInventoryCoverageRequest
      parameters:
        - example: 318
          in: query
          name: filter[npa]
          schema:
            description: Filter by npa
            type: integer
        - example: 202
          in: query
          name: filter[nxx]
          schema:
            description: Filter by nxx
            type: integer
        - example: LA
          in: query
          name: filter[administrative_area]
          schema:
            description: Filter by administrative area
            type: string
        - example: did
          in: query
          name: filter[number_type]
          schema:
            description: Filter by number type
            enum:
              - did
              - toll-free
            type: string
        - example: local
          in: query
          name: filter[phone_number_type]
          schema:
            description: Filter by phone number type
            enum:
              - local
              - toll_free
              - national
              - mobile
              - landline
              - shared_cost
            type: string
        - example: US
          in: query
          name: filter[country_code]
          schema:
            description: Filter by country. Defaults to US
            enum:
              - US
              - CA
              - GB
            type: string
        - example: "true"
          in: query
          name: filter[count]
          schema:
            description: Include count in the result
            type: boolean
        - example: nxx
          in: query
          name: filter[groupBy]
          required: true
          schema:
            description: Filter to group results
            enum:
              - rate_center
              - locality
              - npa
              - national_destination_code
              - nxx
            type: string
      responses:
        "200":
          $ref: "#/components/responses/InventoryCoverageResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create an inventory coverage request
      tags:
        - Inventory Level
      x-latency-category: responsive
  /ip_connections:
    get:
      description: Returns a list of your IP connections.
      operationId: listIpConnections
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterConnectionName"
        - $ref: "#/components/parameters/FilterInnerOutboundVoiceProfileId"
        - $ref: "#/components/parameters/SortConnection"
      responses:
        "200":
          $ref: "#/components/responses/ListIpConnectionsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List Ip connections
      tags:
        - IP Connections
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Creates an IP connection.
      operationId: createIpConnection
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateIpConnectionRequest"
        description: Parameters that can be defined during IP connection creation
        required: true
      responses:
        "201":
          $ref: "#/components/responses/IpConnectionResponse"
        "422":
          description: Bad request
      summary: Create an Ip connection
      tags:
        - IP Connections
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/ip_connections/{id}":
    delete:
      description: Deletes an existing IP connection.
      operationId: deleteIpConnection
      parameters:
        - description: Identifies the type of resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/IpConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Delete an Ip connection
      tags:
        - IP Connections
      x-latency-category: responsive
    get:
      description: Retrieves the details of an existing ip connection.
      operationId: retrieveIpConnection
      parameters:
        - description: IP Connection ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/IpConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve an Ip connection
      tags:
        - IP Connections
      x-latency-category: responsive
    patch:
      description: Updates settings of an existing IP connection.
      operationId: updateIpConnection
      parameters:
        - description: Identifies the type of resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateIpConnectionRequest"
        description: Parameters that can be updated in a IP connection
        required: true
      responses:
        "200":
          $ref: "#/components/responses/IpConnectionResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Update an Ip connection
      tags:
        - IP Connections
      x-latency-category: responsive
  /ips:
    get:
      description: Get all IPs belonging to the user that match the given filters.
      operationId: listIps
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: ID of the IP Connection to which this IP should be attached.
          in: query
          name: filter[connection_id]
          schema:
            type: string
        - description: IP adddress represented by this resource.
          in: query
          name: filter[ip_address]
          schema:
            example: 192.168.0.0
            type: string
        - description: Port to use when connecting to this IP.
          in: query
          name: filter[port]
          schema:
            example: 5060
            type: integer
      responses:
        "200":
          $ref: "#/components/responses/ListIpsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: List Ips
      tags:
        - IPs
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Create a new IP object.
      operationId: createIp
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateIpRequest"
      responses:
        "201":
          $ref: "#/components/responses/IpResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: Create an Ip
      tags:
        - IPs
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/ips/{id}":
    delete:
      description: Delete an IP.
      operationId: deleteIp
      parameters:
        - $ref: "#/components/parameters/IpId"
      responses:
        "200":
          $ref: "#/components/responses/IpResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: Delete an Ip
      tags:
        - IPs
      x-latency-category: responsive
    get:
      description: Return the details regarding a specific IP.
      operationId: retrieveIp
      parameters:
        - $ref: "#/components/parameters/IpId"
      responses:
        "200":
          $ref: "#/components/responses/IpResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: Retrieve an Ip
      tags:
        - IPs
      x-latency-category: responsive
    patch:
      description: Update the details of a specific IP.
      operationId: updateIp
      parameters:
        - $ref: "#/components/parameters/IpId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateIpRequest"
      responses:
        "200":
          $ref: "#/components/responses/IpResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
      summary: Update an Ip
      tags:
        - IPs
      x-latency-category: responsive
  /ledger_billing_group_reports:
    post:
      operationId: createLedgerBillingGroupReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NewLedgerBillingGroupReport"
        description: New ledger billing group report parameters
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CreateLedgerBillingGroupReportResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a ledger billing group report
      tags:
        - Reports
      x-latency-category: background
  "/ledger_billing_group_reports/{id}":
    get:
      operationId: retrieveLedgerBillingGroupReport
      parameters:
        - $ref: "#/components/parameters/LedgerBillingGroupReportId"
      responses:
        "200":
          $ref: "#/components/responses/RetrieveLedgerBillingGroupReportResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a ledger billing group report
      tags:
        - Reports
      x-latency-category: background
  /managed_accounts:
    get:
      description: Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.
      operationId: listManagedAccounts
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterEmailContains"
        - $ref: "#/components/parameters/FilterEmailEq"
        - $ref: "#/components/parameters/Sort"
      responses:
        "200":
          $ref: "#/components/responses/ListManagedAccountsResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
      summary: Lists accounts managed by the current user.
      tags:
        - Managed Accounts
      x-endpoint-cost: medium
      x-latency-category: responsive
    post:
      description: Create a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account.
      operationId: createManagedAccount
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateManagedAccountRequest"
        description: Parameters that define the managed account to be created
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ManagedAccountResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "422":
          $ref: "#/components/responses/UnprocessableManagedAccountEntity"
      summary: Create a new managed account.
      tags:
        - Managed Accounts
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/managed_accounts/{id}":
    get:
      description: Retrieves the details of a single managed account.
      operationId: retrieveManagedAccount
      parameters:
        - description: Managed Account User ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ManagedAccountResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          description: Resource not found
      summary: Retrieve a managed account
      tags:
        - Managed Accounts
      x-latency-category: responsive
  "/managed_accounts/{id}/actions/disable":
    post:
      description: Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be affected. The managed account and its sub-users will still be able to log in via the mission control portal.
      operationId: disableManagedAccount
      parameters:
        - description: Managed Account User ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ManagedAccountResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          description: Resource not found
        "422":
          $ref: "#/components/responses/UnprocessableManagedAccountEntity"
      summary: Disables a managed account
      tags:
        - Managed Accounts
      x-latency-category: responsive
  "/managed_accounts/{id}/actions/enable":
    post:
      description: Enables a managed account and its sub-users to use Telnyx services.
      operationId: enableManagedAccount
      parameters:
        - description: Managed Account User ID
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ManagedAccountResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          description: Resource not found
        "422":
          $ref: "#/components/responses/UnprocessableManagedAccountEntity"
      summary: Enables a managed account
      tags:
        - Managed Accounts
      x-latency-category: responsive
  /media:
    get:
      description: Returns a list of stored media files.
      operationId: listMedia
      responses:
        "200":
          $ref: "#/components/responses/ListMediaResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List uploaded media
      tags:
        - Media Storage API
      x-latency-category: interactive
    post:
      description: Upload media file to Telnyx so it can be used with other Telnyx services
      operationId: createMedia
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UploadMediaRequest"
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/UploadMediaMultipartRequest"
        description: Upload media request
        required: true
      responses:
        "201":
          $ref: "#/components/responses/MediaResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Upload media
      tags:
        - Media Storage API
      x-latency-category: interactive
  "/media/{media_name}":
    delete:
      description: Deletes a stored media file.
      operationId: deleteMedia
      parameters:
        - $ref: "#/components/parameters/MediaName"
      responses:
        "204":
          description: The media was deleted successfully.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Deletes stored media
      tags:
        - Media Storage API
      x-latency-category: interactive
    get:
      description: Returns the information about a stored media file.
      operationId: getMedia
      parameters:
        - $ref: "#/components/parameters/MediaName"
      responses:
        "200":
          $ref: "#/components/responses/MediaResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve stored media
      tags:
        - Media Storage API
      x-latency-category: interactive
    put:
      description: Updates a stored media file.
      operationId: updateMedia
      parameters:
        - $ref: "#/components/parameters/MediaName"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateMediaRequest"
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/UpdateMediaMultipartRequest"
        description: Update media request
        required: true
      responses:
        "200":
          $ref: "#/components/responses/MediaResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update stored media
      tags:
        - Media Storage API
      x-latency-category: interactive
  "/media/{media_name}/download":
    get:
      description: Downloads a stored media file.
      operationId: downloadMedia
      parameters:
        - $ref: "#/components/parameters/MediaName"
      responses:
        "200":
          $ref: "#/components/responses/MediaDownloadResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Download stored media
      tags:
        - Media Storage API
      x-latency-category: interactive
  /message_detail_records:
    get:
      description: "Fetch all Mdr records "
      operationId: getPaginatedMdrs
      parameters:
        - description: Start date
          in: query
          name: start_date
          required: true
          schema:
            example: 2020-07-01T00:00:00-06:00
            format: date-time
            type: string
        - description: End date
          in: query
          name: end_date
          required: true
          schema:
            example: 2020-07-01T00:00:00-06:00
            format: date-time
            type: string
        - in: query
          name: id
          schema:
            description: Message uuid
            example: e093fbe0-5bde-11eb-ae93-0242ac130002
            type: string
        - in: query
          name: direction
          schema:
            $ref: "#/components/schemas/Direction"
        - in: query
          name: outbound_profile_id
          schema:
            description: Configured profile id. New profiles can be created and configured on Telnyx portal
            example: 30ef55db-c4a2-4c4a-9804-a68077973d07
            type: string
        - in: query
          name: cld
          schema:
            description: Destination number
            example: "+15551237654"
            type: string
        - in: query
          name: cli
          schema:
            description: Origination number
            example: "+15551237654"
            type: string
        - in: query
          name: status
          schema:
            $ref: "#/components/schemas/MessageStatus"
        - in: query
          name: message_type
          schema:
            $ref: "#/components/schemas/MessageType"
        - in: query
          name: country_iso
          schema:
            description: Destination number ISO country code
            example: US
            type: string
        - in: query
          name: error
          schema:
            description: Reported error code
            example: "40001"
            type: string
        - in: query
          name: normalized_carrier
          schema:
            description: Carrier
            example: Verizon
            type: string
        - in: query
          name: tag
          schema:
            description: Specified tag
            example: Tag1
            type: string
        - in: query
          name: mcc
          schema:
            description: Mobile country code
            example: "204"
            type: string
        - in: query
          name: mnc
          schema:
            description: Mobile network code
            example: "01"
            type: string
        - in: query
          name: product
          schema:
            $ref: "#/components/schemas/Product"
        - description: Page number
          in: query
          name: page[number]
          schema:
            default: 1
            format: int32
            minimum: 1
            type: integer
        - description: Size of the page
          in: query
          name: page[size]
          schema:
            default: 20
            format: int32
            maximum: 50
            minimum: 1
            type: integer
        - in: query
          name: sort
          schema:
            default: created_at
            description: Field used to order the data. If no field is specified, default value is 'created_at'
            example: created_at
            items:
              type: string
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrGetDetailResponse"
          description: Successful
      security:
        - bearerAuth: []
      summary: Fetch messaging detail records.
      tags:
        - MDR Search (Beta)
      x-latency-category: interactive
  "/message_detail_records/{id}/message_body":
    get:
      description: "Fetch Mdr message body "
      operationId: getMdrMessageBody
      parameters:
        - description: Message unique identifier
          in: path
          name: id
          required: true
          schema:
            example: ee5d9b20-15db-4b86-a5d7-9c32bfa7b47e
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrMessageBodyResponse"
          description: Successful
      summary: Fetch message body by id.
      tags:
        - MDR Search (Beta)
      x-latency-category: interactive
  /messages:
    post:
      callbacks:
        deliveryUpdate:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/OutboundMessageEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      description: |
        Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.

        This endpoint allows you to send a message with any messaging resource.
        Current messaging resources include: long-code, short-code, number-pool, and
        alphanumeric-sender-id.
      operationId: createMessage
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateMessageRequest"
        description: Message payload
      responses:
        "200":
          $ref: "#/components/responses/MessageResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Send a message
      tags:
        - Messages
      x-latency-category: responsive
  /messages/long_code:
    post:
      callbacks:
        deliveryUpdate:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/OutboundMessageEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      operationId: createLongCodeMessage
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateLongCodeMessageRequest"
        description: Message payload
      responses:
        "200":
          $ref: "#/components/responses/MessageResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Send a long code message
      tags:
        - Messages
      x-latency-category: responsive
  /messages/number_pool:
    post:
      callbacks:
        deliveryUpdate:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/OutboundMessageEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      operationId: createNumberPoolMessage
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateNumberPoolMessageRequest"
        description: Message payload
      responses:
        "200":
          $ref: "#/components/responses/MessageResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Send a message using number pool
      tags:
        - Messages
      x-latency-category: responsive
  /messages/short_code:
    post:
      callbacks:
        deliveryUpdate:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/OutboundMessageEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      operationId: createShortCodeMessage
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateShortCodeMessageRequest"
        description: Message payload
      responses:
        "200":
          $ref: "#/components/responses/MessageResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Send a short code message
      tags:
        - Messages
      x-latency-category: responsive
  "/messages/{id}":
    get:
      description: "Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation. If you require messages older than this, please generate an [MDR report.](https://developers.telnyx.com/docs/api/v1/reports/MDR-Reports)"
      operationId: retrieveMessage
      parameters:
        - description: The id of the message
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          $ref: "#/components/responses/MessageResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a message
      tags:
        - Messages
      x-latency-category: responsive
  /messaging_hosted_number_orders:
    get:
      operationId: listMessagingHostedNumberOrder
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListMessagingHostedNumberOrdersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List messaging hosted number orders
      tags:
        - Messaging Hosted Number
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      operationId: createMessagingHostedNumberOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateMessagingHostedNumberOrderRequest"
        description: Message payload
      responses:
        "200":
          $ref: "#/components/responses/MessagingHostedNumberOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a messaging hosted number order
      tags:
        - Messaging Hosted Number
      x-latency-category: responsive
  "/messaging_hosted_number_orders/{id}":
    get:
      operationId: retrieveMessagingHostedNumberOrder
      parameters:
        - description: Identifies the type of resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/MessagingHostedNumberOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a messaging hosted number order
      tags:
        - Messaging Hosted Number
      x-latency-category: responsive
  "/messaging_hosted_number_orders/{id}/actions/file_upload":
    post:
      operationId: uploadFileMessagingHostedNumberOrder
      parameters:
        - description: Identifies the type of resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            encoding:
              bill:
                contentType: application/pdf
              loa:
                contentType: application/pdf
            schema:
              $ref: "#/components/schemas/UploadFileMessagingHostedNumberOrderRequest"
        description: Message payload
      responses:
        "200":
          $ref: "#/components/responses/MessagingHostedNumberOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Upload file required for a messaging hosted number order
      tags:
        - Messaging Hosted Number
      x-latency-category: responsive
  "/messaging_hosted_numbers/{id}":
    delete:
      operationId: deleteMessagingHostedNumber
      parameters:
        - description: Identifies the type of resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/MessagingHostedNumberResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a messaging hosted number
      tags:
        - Messaging Hosted Number
      x-latency-category: responsive
  /messaging_profile_metrics:
    get:
      operationId: listMessagingProfileMetrics
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/MessagingProfileMetric"
        - $ref: "#/components/parameters/MessagingProfileMetricTimeFrame"
      responses:
        "200":
          $ref: "#/components/responses/ListMessagingProfileMetrics"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List messaging profile metrics
      tags:
        - Messaging Profiles
      x-group-parameters: "true"
      x-latency-category: responsive
  /messaging_profiles:
    get:
      operationId: listMessagingProfiles
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListMessagingProfilesResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List messaging profiles
      tags:
        - Messaging Profiles
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      callbacks:
        deliveryUpdate:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/OutboundMessageEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        inboundMessage:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/InboundMessageEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
        replacedLinkClick:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/ReplacedLinkClickEvent"
                required: true
              responses:
                "200":
                  description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL.
      operationId: createMessagingProfile
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateMessagingProfileRequest"
        description: New Messaging Profile object
        required: true
      responses:
        "200":
          $ref: "#/components/responses/MessagingProfileResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a messaging profile
      tags:
        - Messaging Profiles
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/messaging_profiles/{id}":
    delete:
      operationId: deleteMessagingProfile
      parameters:
        - $ref: "#/components/parameters/MessagingProfileId"
      responses:
        "200":
          $ref: "#/components/responses/MessagingProfileResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a messaging profile
      tags:
        - Messaging Profiles
      x-latency-category: responsive
    get:
      operationId: retrieveMessagingProfile
      parameters:
        - $ref: "#/components/parameters/MessagingProfileId"
      responses:
        "200":
          $ref: "#/components/responses/MessagingProfileResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a messaging profile
      tags:
        - Messaging Profiles
      x-latency-category: responsive
    patch:
      operationId: updateMessagingProfile
      parameters:
        - $ref: "#/components/parameters/MessagingProfileId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateMessagingProfileRequest"
        description: New Messaging Profile object
        required: true
      responses:
        "200":
          $ref: "#/components/responses/MessagingProfileResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a messaging profile
      tags:
        - Messaging Profiles
      x-latency-category: responsive
  "/messaging_profiles/{id}/metrics":
    get:
      operationId: retrieveMessagingProfileDetailedMetrics
      parameters:
        - $ref: "#/components/parameters/MessagingProfileId"
        - $ref: "#/components/parameters/MessagingProfileMetricTimeFrame"
      responses:
        "200":
          $ref: "#/components/responses/RetrieveMessagingProfileMetrics"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve messaging profile metrics
      tags:
        - Messaging Profiles
      x-group-parameters: "true"
      x-latency-category: responsive
  "/messaging_profiles/{id}/phone_numbers":
    get:
      operationId: listMessagingProfilePhoneNumbers
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/MessagingProfileId"
      responses:
        "200":
          $ref: "#/components/responses/ListMessagingProfilePhoneNumbersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List phone numbers associated with a messaging profile
      tags:
        - Messaging Profiles
      x-group-parameters: "true"
      x-latency-category: responsive
  "/messaging_profiles/{id}/short_codes":
    get:
      operationId: listMessagingProfileShortCodes
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/MessagingProfileId"
      responses:
        "200":
          $ref: "#/components/responses/ListMessagingProfileShortCodesResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List short codes associated with a messaging profile
      tags:
        - Messaging Profiles
      x-group-parameters: "true"
      x-latency-category: responsive
  /messaging_url_domains:
    get:
      operationId: listMessagingUrlDomains
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListMessagingUrlDomains"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List messaging URL domains
      tags:
        - Messaging URL Domains
      x-group-parameters: "true"
      x-latency-category: responsive
  /mobile_operator_networks:
    get:
      description: Telnyx has a set of GSM mobile operators partners that are available through our mobile network roaming. This resource is entirely managed by Telnyx and may change over time. That means that this resource won't allow any write operations for it. Still, it's available so it can be used as a support resource that can be related to other resources or become a configuration option.
      operationId: MobileOperatorNetworksGet
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: Filter by name starting with.
          in: query
          name: filter[name][starts_with]
          required: false
          schema:
            example: AT
            type: string
        - description: Filter by name containing match.
          in: query
          name: filter[name][contains]
          required: false
          schema:
            example: T&T
            type: string
        - description: Filter by name ending with.
          in: query
          name: filter[name][ends_with]
          required: false
          schema:
            example: T
            type: string
        - description: Filter by exact country_code.
          in: query
          name: filter[country_code]
          required: false
          schema:
            example: US
            type: string
        - description: Filter by exact MCC.
          in: query
          name: filter[mcc]
          required: false
          schema:
            example: "310"
            type: string
        - description: Filter by exact MNC.
          in: query
          name: filter[mnc]
          required: false
          schema:
            example: "410"
            type: string
        - description: Filter by exact TADIG.
          in: query
          name: filter[tadig]
          required: false
          schema:
            example: USACG
            type: string
      responses:
        "200":
          $ref: "#/components/responses/SearchMobileOperatorNetworksResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List mobile operator networks
      tags:
        - Mobile Operator Networks
      x-latency-category: responsive
  /notification_channels:
    get:
      description: List notification channels.
      operationId: listNotificationChannels
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/ChannelTypeId"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: "#/components/schemas/NotificationChannel"
                    type: array
                  meta:
                    $ref: "#/components/schemas/PaginationMeta"
                type: object
          description: Returns a list of notification channels.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List notification channels
      tags:
        - Notifications
      x-latency-category: responsive
    post:
      description: Create a notification channel.
      operationId: createNotificationChannels
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NotificationChannel"
        description: Add a Notification Channel
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationChannel"
                type: object
          description: A Notification Channel response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a notification channel
      tags:
        - Notifications
      x-latency-category: responsive
  "/notification_channels/{id}":
    delete:
      description: Delete a notification channel.
      operationId: deleteNotificationChannel
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationChannel"
                type: object
          description: A Notification Channel response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a notification channel
      tags:
        - Notifications
      x-latency-category: responsive
    get:
      description: Retrieve a notification channel.
      operationId: retrieveNotificationChannel
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationChannel"
                type: object
          description: A Notification Channel response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a notification channel
      tags:
        - Notifications
      x-latency-category: responsive
    patch:
      description: Update a notification channel.
      operationId: updateNotificationChannel
      parameters:
        - $ref: "#/components/parameters/Id"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NotificationChannel"
        description: Update notification channel object
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationChannel"
                type: object
          description: A Notification Channel response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a notification channel
      tags:
        - Notifications
      x-latency-category: responsive
  /notification_event_conditions:
    get:
      description: Returns a list of your notifications events conditions.
      operationId: findNotificationsEventsConditions
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/AssociatedRecordType"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: "#/components/schemas/NotificationEventCondition"
                    type: array
                  meta:
                    $ref: "#/components/schemas/PaginationMeta"
                type: object
          description: Returns a list of notification event conditions available.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all Notifications Events Conditions
      tags:
        - Notifications
      x-latency-category: responsive
  /notification_events:
    get:
      description: Returns a list of your notifications events.
      operationId: findNotificationsEvents
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: "#/components/schemas/NotificationEvent"
                    type: array
                  meta:
                    $ref: "#/components/schemas/PaginationMeta"
                type: object
          description: Returns a list of notification events available.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all Notifications Events
      tags:
        - Notifications
      x-latency-category: responsive
  /notification_profiles:
    get:
      description: Returns a list of your notifications profiles.
      operationId: findNotificationsProfiles
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: "#/components/schemas/NotificationProfile"
                    type: array
                  meta:
                    $ref: "#/components/schemas/PaginationMeta"
                type: object
          description: Returns a list of notification profiles.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all Notifications Profiles
      tags:
        - Notifications
      x-latency-category: responsive
    post:
      description: Create a notification profile.
      operationId: createNotificationProfile
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NotificationProfile"
        description: Add a Notification Profile
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationProfile"
                type: object
          description: A Notification Profile response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a notification profile
      tags:
        - Notifications
      x-latency-category: responsive
  "/notification_profiles/{id}":
    delete:
      description: Delete a notification profile.
      operationId: deleteNotificationProfile
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationProfile"
                type: object
          description: A Notification Profile response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a notification profile
      tags:
        - Notifications
      x-latency-category: responsive
    get:
      description: Retrieve a notification profile.
      operationId: retrieveNotificationProfile
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationProfile"
                type: object
          description: A Notification Profile response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a notification profile
      tags:
        - Notifications
      x-latency-category: responsive
    patch:
      description: Update a notification profile.
      operationId: updateNotificationProfile
      parameters:
        - $ref: "#/components/parameters/Id"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NotificationProfile"
        description: Update notification profile object
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationProfile"
                type: object
          description: A Notification Profile response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a notification profile
      tags:
        - Notifications
      x-latency-category: responsive
  /notification_settings:
    get:
      description: List notification settings.
      operationId: listNotificationSettings
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/NotificationProfileId"
        - $ref: "#/components/parameters/NotificationChannelId"
        - $ref: "#/components/parameters/NotificationEventConditionId"
        - $ref: "#/components/parameters/AssociatedRecordType"
        - $ref: "#/components/parameters/Status"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: "#/components/schemas/NotificationSetting"
                    type: array
                  meta:
                    $ref: "#/components/schemas/PaginationMeta"
                type: object
          description: Returns a list of notification settings.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List notification settings
      tags:
        - Notifications
      x-latency-category: responsive
    post:
      description: Add a notification setting.
      operationId: createNotificationSetting
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NotificationSetting"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationSetting"
                type: object
          description: A Notification Setting response
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationSetting"
                type: object
          description: A Notification Setting response - async
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Add a Notification Setting
      tags:
        - Notifications
      x-latency-category: responsive
  "/notification_settings/{id}":
    delete:
      description: Delete a notification setting.
      operationId: deleteNotificationSetting
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationSetting"
                type: object
          description: A Notification Setting response
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationSetting"
                type: object
          description: A Notification Setting response - async
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a notification setting
      tags:
        - Notifications
      x-latency-category: responsive
    get:
      description: Retrieve a notification setting.
      operationId: retrieveNotificationSetting
      parameters:
        - $ref: "#/components/parameters/Id"
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/NotificationSetting"
                type: object
          description: A Notification Setting response
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a notification setting
      tags:
        - Notifications
      x-latency-category: responsive
  /number_block_orders:
    get:
      description: Get a paginated list of number block orders.
      operationId: listNumberBlockOrders
      parameters:
        - description: Filter number block orders by status.
          in: query
          name: filter[status]
          schema:
            example: pending
            type: string
        - description: Filter number block orders later than this value.
          in: query
          name: filter[created_at][gt]
          schema:
            example: 2018-01-01T00:00:00.000000Z
            type: string
        - description: Filter number block orders earlier than this value.
          in: query
          name: filter[created_at][lt]
          schema:
            example: 2018-01-01T00:00:00.000000Z
            type: string
        - description: Filter number block  orders having these phone numbers.
          in: query
          name: filter[phone_numbers.starting_number]
          schema:
            example: "+19705555000"
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListNumberBlockOrdersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List number block orders
      tags:
        - Number Block Orders
      x-latency-category: responsive
    post:
      callbacks:
        numberOrderStatusUpdate:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/NumberOrderBlockEvent"
                required: true
              responses:
                "200":
                  description: The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL.
      description: Creates a phone number block order.
      operationId: createNumberBlockOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateNumberBlockOrderRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/NumberBlockOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a number block order
      tags:
        - Number Block Orders
      x-latency-category: responsive
  "/number_block_orders/{number_block_order_id}":
    get:
      description: Get an existing phone number block order.
      operationId: retrieveNumberBlockOrder
      parameters:
        - description: The number block order ID.
          in: path
          name: number_block_order_id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/NumberBlockOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a number block order
      tags:
        - Number Block Orders
      x-latency-category: responsive
  "/number_lookup/{phone_number}":
    get:
      description: Returns information about the provided phone number.
      operationId: NumberLookup
      parameters:
        - $ref: "#/components/parameters/PhoneNumber"
        - $ref: "#/components/parameters/NumberLookupType"
      responses:
        "200":
          $ref: "#/components/responses/NumberLookupResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Lookup phone number data
      tags:
        - Number Lookup
      x-latency-category: responsive
  /number_order_documents:
    get:
      description: Gets a paginated list of number order documents.
      operationId: listNumberOrderDocuments
      parameters:
        - description: Filter number order documents by `requirement_id`.
          in: query
          name: filter[requirement_id]
          schema:
            type: string
        - description: Filter number order documents after this datetime.
          in: query
          name: filter[created_at][gt]
          schema:
            type: string
        - description: Filter number order documents from before this datetime.
          in: query
          name: filter[created_at][lt]
          schema:
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListNumberOrderDocumentsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List number order documents
      tags:
        - Number Order Documents
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Upload a phone number order document.
      operationId: createNumberOrderDocument
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateNumberOrderDocumentRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/NumberOrderDocumentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a number order document
      tags:
        - Number Order Documents
      x-latency-category: responsive
  "/number_order_documents/{number_order_document_id}":
    get:
      description: Gets a single number order document.
      operationId: retrieveNumberOrderDocument
      parameters:
        - description: The number order document ID.
          in: path
          name: number_order_document_id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/NumberOrderDocumentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a number order document
      tags:
        - Number Order Documents
      x-latency-category: responsive
    patch:
      description: Updates a number order document.
      operationId: updateNumberOrderDocument
      parameters:
        - description: The number order document ID.
          in: path
          name: number_order_document_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateNumberOrderDocumentRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/NumberOrderDocumentResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a number order document
      tags:
        - Number Order Documents
      x-latency-category: responsive
  /number_order_phone_numbers:
    get:
      description: Get a list of phone numbers associated to orders.
      operationId: retrieveNumberOrderPhoneNumbers
      responses:
        "200":
          $ref: "#/components/responses/ListNumberOrderPhoneNumbersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a list of phone numbers associated to orders
      tags:
        - Number Orders
      x-latency-category: responsive
  "/number_order_phone_numbers/{number_order_phone_number_id}":
    get:
      description: Get an existing number order phone number.
      operationId: retrieveNumberOrderPhoneNumber
      parameters:
        - description: The number order phone number ID.
          in: path
          name: number_order_phone_number_id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/NumberOrderPhoneNumberResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a number order phone number.
      tags:
        - Number Orders
      x-latency-category: responsive
    patch:
      description: Updates a number order phone number.
      operationId: updateNumberOrderPhoneNumber
      parameters:
        - description: The number order phone number ID.
          in: path
          name: number_order_phone_number_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateNumberOrderPhoneNumberRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/NumberOrderPhoneNumberResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a number order phone number.
      tags:
        - Number Orders
      x-latency-category: responsive
  /number_orders:
    get:
      description: Get a paginated list of number orders.
      operationId: listNumberOrders
      parameters:
        - description: Filter number orders by status.
          in: query
          name: filter[status]
          schema:
            type: string
        - description: Filter number orders later than this value.
          in: query
          name: filter[created_at][gt]
          schema:
            type: string
        - description: Filter number orders earlier than this value.
          in: query
          name: filter[created_at][lt]
          schema:
            type: string
        - description: Filter number order with this amount of numbers
          in: query
          name: filter[phone_numbers_count]
          schema:
            type: string
        - description: Filter number orders via the customer reference set.
          in: query
          name: filter[customer_reference]
          schema:
            type: string
        - description: Filter number orders by requirements met.
          in: query
          name: filter[requirements_met]
          schema:
            type: boolean
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListNumberOrdersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List number orders
      tags:
        - Number Orders
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      callbacks:
        numberOrderStatusUpdate:
          "{$request.body#/webhook_url}":
            post:
              requestBody:
                content:
                  application/json:
                    schema:
                      $ref: "#/components/schemas/NumberOrderedEvent"
                required: true
              responses:
                "200":
                  description: The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL.
      description: Creates a phone number order.
      operationId: createNumberOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateNumberOrderRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/NumberOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a number order
      tags:
        - Number Orders
      x-endpoint-cost: heavy
      x-latency-category: responsive
  "/number_orders/{number_order_id}":
    get:
      description: Get an existing phone number order.
      operationId: retrieveNumberOrder
      parameters:
        - description: The number order ID.
          in: path
          name: number_order_id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/NumberOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a number order
      tags:
        - Number Orders
      x-latency-category: responsive
    patch:
      description: Updates a phone number order.
      operationId: updateNumberOrder
      parameters:
        - description: The number order ID.
          in: path
          name: number_order_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateNumberOrderRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/NumberOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a number order
      tags:
        - Number Orders
      x-latency-category: responsive
  /number_reservations:
    get:
      description: Gets a paginated list of phone number reservations.
      operationId: listNumberReservations
      parameters:
        - description: Filter number reservations by status.
          in: query
          name: filter[status]
          schema:
            type: string
        - description: Filter number reservations later than this value.
          in: query
          name: filter[created_at][gt]
          schema:
            type: string
        - description: Filter number reservations earlier than this value.
          in: query
          name: filter[created_at][lt]
          schema:
            type: string
        - description: Filter number reservations having these phone numbers.
          in: query
          name: filter[phone_numbers.phone_number]
          schema:
            type: string
        - description: Filter number reservations via the customer reference set.
          in: query
          name: filter[customer_reference]
          schema:
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListNumberReservationsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List number reservations
      tags:
        - Number Reservations
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Creates a Phone Number Reservation for multiple numbers.
      operationId: createNumberReservation
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateNumberReservationRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/NumberReservationResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a number reservation
      tags:
        - Number Reservations
      x-latency-category: responsive
  "/number_reservations/{number_reservation_id}":
    get:
      description: Gets a single phone number reservation.
      operationId: retrieveNumberReservation
      parameters:
        - description: The number reservation ID.
          in: path
          name: number_reservation_id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/NumberReservationResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a number reservation
      tags:
        - Number Reservations
      x-latency-category: responsive
  "/number_reservations/{number_reservation_id}/actions/extend":
    post:
      description: Extends reservation expiry time on all phone numbers.
      operationId: extendNumberReservationExpiryTime
      parameters:
        - description: The number reservation ID.
          in: path
          name: number_reservation_id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/NumberReservationResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Extend a number reservation
      tags:
        - Number Reservations
      x-latency-category: responsive
  /ota_updates:
    get:
      operationId: OTAUpdatesList
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterBasicStatusLifecycle"
        - description: The SIM card identification UUID.
          in: query
          name: filter[sim_card_id]
          required: false
          schema:
            type: string
        - description: Filter by type.
          in: query
          name: filter[type]
          required: false
          schema:
            enum:
              - sim_card_network_preferences
            example: sim_card_network_preferences
            type: string
      responses:
        "200":
          $ref: "#/components/responses/SearchOTAUpdateResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List OTA updates
      tags:
        - OTA updates
      x-latency-category: responsive
  "/ota_updates/{id}":
    get:
      description: This API returns the details of an Over the Air (OTA) update.
      operationId: OTAUpdateGET
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/OTAUpdateResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get OTA update
      tags:
        - OTA updates
      x-latency-category: responsive
  /outbound_voice_profiles:
    get:
      description: Get all outbound voice profiles belonging to the user that match the given filters.
      operationId: listOutboundVoiceProfiles
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/NameFilter"
        - $ref: "#/components/parameters/SortOutboundVoiceProfile"
      responses:
        "200":
          $ref: "#/components/responses/ListOutboundVoiceProfilesResponse"
        "401":
          description: Unauthorized
        "422":
          description: Bad request
      summary: Get all outbound voice profiles
      tags:
        - Outbound Voice Profiles
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Create an outbound voice profile.
      operationId: createOutboundVoiceProfile
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateOutboundVoiceProfileRequest"
        description: Parameters that can be defined when creating an outbound voice profile
        required: true
      responses:
        "200":
          $ref: "#/components/responses/OutboundVoiceProfileResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Create an outbound voice profile
      tags:
        - Outbound Voice Profiles
      x-latency-category: responsive
  "/outbound_voice_profiles/{id}":
    delete:
      description: Deletes an existing outbound voice profile.
      operationId: deleteOutboundVoiceProfile
      parameters:
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          $ref: "#/components/responses/OutboundVoiceProfileResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Delete an outbound voice profile
      tags:
        - Outbound Voice Profiles
      x-latency-category: responsive
    get:
      description: Retrieves the details of an existing outbound voice profile.
      operationId: retrieveOutboundVoiceProfile
      parameters:
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          $ref: "#/components/responses/OutboundVoiceProfileResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve an outbound voice profile
      tags:
        - Outbound Voice Profiles
      x-latency-category: responsive
    patch:
      description: Updates an existing outbound voice profile.
      operationId: updateOutboundVoiceProfile
      parameters:
        - $ref: "#/components/parameters/id"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateOutboundVoiceProfileRequest"
        description: Parameters that can be updated on an outbound voice profile
        required: true
      responses:
        "200":
          $ref: "#/components/responses/OutboundVoiceProfileResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Updates an existing outbound voice profile.
      tags:
        - Outbound Voice Profiles
      x-latency-category: responsive
  /phone_number_blocks/jobs:
    get:
      operationId: listPhoneNumberBlocksJobs
      parameters:
        - description: Filter the phone number blocks jobs by type.
          in: query
          name: filter[type]
          schema:
            description: Identifies the type of the background job.
            enum:
              - delete_phone_number_block
            example: delete_phone_number_block
            type: string
        - description: Filter the phone number blocks jobs by status.
          in: query
          name: filter[status]
          schema:
            description: Identifies the status of the background job.
            enum:
              - pending
              - in_progress
              - completed
              - failed
            example: in_progress
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
          in: query
          name: sort
          required: false
          schema:
            enum:
              - created_at
            example: created_at
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ListPhoneNumberBlocksJobsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Lists the phone number blocks jobs
      tags:
        - Number Blocks Background Jobs
      x-group-parameters: "true"
      x-latency-category: responsive
  /phone_number_blocks/jobs/delete_phone_number_block:
    post:
      description: Creates a new background job to delete all the phone numbers associated with the given block. We will only consider the phone number block as deleted after all phone numbers associated with it are removed, so multiple executions of this job may be necessary in case some of the phone numbers present errors during the deletion process.
      operationId: createPhoneNumberBlocksJobDeletePhoneNumberBlock
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PhoneNumberBlocksJobDeletePhoneNumberBlockRequest"
        required: true
      responses:
        "202":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/PhoneNumberBlocksJob"
                title: Phone Number Blocks Job Delete Phone Number Block
                type: object
          description: Phone number blocks job delete phone numbers requested.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Deletes all numbers associated with a phone number block
      tags:
        - Number Blocks Background Jobs
      x-group-parameters: "true"
      x-latency-category: background
  "/phone_number_blocks/jobs/{id}":
    get:
      operationId: retrievePhoneNumberBlocksJob
      parameters:
        - description: Identifies the Phone Number Blocks Job.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/PhoneNumberBlocksJob"
                title: Phone Number Blocks Job
                type: object
          description: Phone number blocks job details.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieves a phone number blocks job
      tags:
        - Number Blocks Background Jobs
      x-group-parameters: "true"
      x-latency-category: responsive
  /phone_numbers:
    get:
      operationId: listPhoneNumbers
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: Filter by phone number tags.
          in: query
          name: filter[tag]
          required: false
          schema:
            type: string
        - description: |-
            Filter by phone number. Requires at least three digits.
                         Non-numerical characters will result in no values being returned.
          in: query
          name: filter[phone_number]
          required: false
          schema:
            type: string
        - description: Filter by phone number status.
          in: query
          name: filter[status]
          required: false
          schema:
            enum:
              - purchase_pending
              - purchase_failed
              - port_pending
              - active
              - deleted
              - port_failed
              - emergency_only
              - ported_out
              - port_out_pending
            example: active
            type: string
        - description: Filter contains connection name. Requires at least three characters.
          in: query
          name: filter[voice.connection_name][contains]
          required: false
          schema:
            example: test
            type: string
        - description: Filter starts with connection name. Requires at least three characters.
          in: query
          name: filter[voice.connection_name][starts_with]
          required: false
          schema:
            example: test
            type: string
        - description: Filter ends with connection name. Requires at least three characters.
          in: query
          name: filter[voice.connection_name][ends_with]
          required: false
          schema:
            example: test
            type: string
        - description: Filter by connection name.
          in: query
          name: filter[voice.connection_name][eq]
          required: false
          schema:
            example: test
            type: string
        - description: Filter by usage_payment_method.
          in: query
          name: filter[usage_payment_method]
          required: false
          schema:
            enum:
              - pay-per-minute
              - channel
            example: channel
            type: string
        - description: Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.
          in: query
          name: filter[billing_group_id]
          required: false
          schema:
            example: 62e4bf2e-c278-4282-b524-488d9c9c43b2
            type: string
        - description: Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.
          in: query
          name: filter[emergency_address_id]
          required: false
          schema:
            example: "9102160989215728032"
            format: int64
            type: string
        - description: Filter numbers via the customer_reference set.
          in: query
          name: filter[customer_reference]
          schema:
            type: string
        - description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
          in: query
          name: sort
          required: false
          schema:
            enum:
              - purchased_at
              - phone_number
              - connection_name
              - usage_payment_method
            example: connection_name
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ListPhoneNumbersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List phone numbers
      tags:
        - Number Configurations
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
  /phone_numbers/csv_downloads:
    get:
      operationId: listCsvDownloads
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListCsvDownloadsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List CSV downloads
      tags:
        - CSV Downloads
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      operationId: createCsvDownload
      responses:
        "200":
          $ref: "#/components/responses/CsvDownloadResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a CSV download
      tags:
        - CSV Downloads
      x-endpoint-cost: medium
      x-latency-category: background
  "/phone_numbers/csv_downloads/{id}":
    get:
      operationId: retrieveCsvDownload
      parameters:
        - description: Identifies the CSV download.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/CsvDownloadResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a CSV download
      tags:
        - CSV Downloads
      x-endpoint-cost: medium
      x-latency-category: background
  /phone_numbers/inbound_channels:
    get:
      description: Returns the inbound channels for your account. Inbound channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.
      operationId: listOutboundChannels
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      channels:
                        description: The current number of concurrent channels set for the account
                        example: 7
                        type: integer
                      record_type:
                        description: Identifies the type of the response
                        example: inbound_channels
                        type: string
                    type: object
                type: object
          description: Inbound Channels Response
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Retrieve your inbound channels
      tags:
        - Inbound Channels
      x-endpoint-cost: medium
      x-latency-category: responsive
    patch:
      description: Update the inbound channels for the account
      operationId: updateOutboundChannels
      requestBody:
        content:
          application/json:
            schema:
              properties:
                channels:
                  description: The new number of concurrent channels for the account
                  example: 7
                  type: integer
              required:
                - channels
              type: object
        description: Inbound channels update
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      channels:
                        description: The number of channels set for the account
                        example: 7
                        type: integer
                      record_type:
                        description: Identifies the type of the response
                        example: inbound_channels
                        type: string
                    type: object
                type: object
          description: Expected Update response
        default:
          content:
            application/json:
              schema:
                properties:
                  errors:
                    items:
                      properties:
                        code:
                          format: int
                          type: string
                        detail:
                          type: string
                        meta:
                          type: object
                        source:
                          properties:
                            parameter:
                              description: Indicates which query parameter caused the error.
                              type: string
                            pointer:
                              description: JSON pointer (RFC6901) to the offending entity.
                              format: json-pointer
                              type: string
                          type: object
                        title:
                          type: string
                      required:
                        - code
                        - title
                    type: array
          description: Unexpected error
      summary: Update inbound channels
      tags:
        - Inbound Channels
      x-endpoint-cost: medium
      x-latency-category: responsive
  /phone_numbers/jobs:
    get:
      operationId: listPhoneNumbersJobs
      parameters:
        - description: Filter the phone number jobs by type.
          in: query
          name: filter[type]
          schema:
            description: Identifies the type of the background job.
            enum:
              - update_emergency_settings
              - delete_phone_numbers
              - update_phone_numbers
            example: update_emergency_settings
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
          in: query
          name: sort
          required: false
          schema:
            enum:
              - created_at
            example: created_at
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ListPhoneNumbersJobsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Lists the phone numbers jobs
      tags:
        - Number Background Jobs
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
  /phone_numbers/jobs/delete_phone_numbers:
    post:
      description: Creates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call.
      operationId: createPhoneNumbersJobDeletePhoneNumbers
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PhoneNumbersJobDeletePhoneNumbersRequest"
        required: true
      responses:
        "202":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/PhoneNumbersJob"
                title: Phone Numbers Job Delete Phone Numbers
                type: object
          description: Phone numbers job delete phone numbers requested.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a batch of numbers
      tags:
        - Number Background Jobs
      x-group-parameters: "true"
      x-latency-category: background
  /phone_numbers/jobs/update_emergency_settings:
    post:
      description: Creates a background job to update the emergency settings of a collection of phone numbers. At most one thousand numbers can be updated per API call.
      operationId: createPhoneNumbersJobUpdateEmergencySettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PhoneNumbersJobUpdateEmergencySettingsRequest"
        required: true
      responses:
        "202":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/PhoneNumbersJob"
                title: Phone Numbers Enable Emergency
                type: object
          description: Phone numbers enable emergency requested.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update the emergency settings from a batch of numbers
      tags:
        - Number Background Jobs
      x-latency-category: background
  /phone_numbers/jobs/update_phone_numbers:
    post:
      description: Creates a new background job to update a batch of numbers. At most one thousand numbers can be updated per API call. At least one of the updateable fields must be submitted.
      operationId: createPhoneNumbersJobUpdatePhoneNumber
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PhoneNumbersJobUpdatePhoneNumbersRequest"
        required: true
      responses:
        "202":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/PhoneNumbersJob"
                title: Phone Numbers Job Update Phone Numbers
                type: object
          description: Phone numbers job update phone numbers requested.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a batch of numbers
      tags:
        - Number Background Jobs
      x-group-parameters: "true"
      x-latency-category: background
  "/phone_numbers/jobs/{id}":
    get:
      operationId: retrievePhoneNumbersJob
      parameters:
        - description: Identifies the Phone Numbers Job.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/PhoneNumbersJob"
                title: Phone Numbers Job
                type: object
          description: Phone numbers job details.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a phone numbers job
      tags:
        - Number Background Jobs
      x-group-parameters: "true"
      x-latency-category: responsive
  /phone_numbers/messaging:
    get:
      operationId: listPhoneNumbersWithMessagingSettings
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListPhoneNumbersWithMessagingSettingsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List phone numbers with messaging settings
      tags:
        - Number Configurations
      x-group-parameters: "true"
      x-latency-category: responsive
  /phone_numbers/voice:
    get:
      operationId: listPhoneNumbersWithVoiceSettings
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: |-
            Filter by phone number. Requires at least three digits.
                         Non-numerical characters will result in no values being returned.
          in: query
          name: filter[phone_number]
          required: false
          schema:
            type: string
        - description: Filter contains connection name. Requires at least three characters.
          in: query
          name: filter[connection_name][contains]
          required: false
          schema:
            example: test
            type: string
        - description: Filter numbers via the customer_reference set.
          in: query
          name: filter[customer_reference]
          schema:
            type: string
        - description: Filter by usage_payment_method.
          in: query
          name: filter[usage_payment_method]
          required: false
          schema:
            enum:
              - pay-per-minute
              - channel
            example: channel
            type: string
        - description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
          in: query
          name: sort
          required: false
          schema:
            enum:
              - purchased_at
              - phone_number
              - connection_name
              - usage_payment_method
            example: connection_name
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ListPhoneNumbersWithVoiceSettingsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List phone numbers with voice settings
      tags:
        - Number Configurations
      x-endpoint-cost: medium
      x-group-parameters: "true"
      x-latency-category: responsive
  "/phone_numbers/{id}":
    delete:
      operationId: deletePhoneNumber
      parameters:
        - $ref: "#/components/parameters/IntId"
      responses:
        "200":
          $ref: "#/components/responses/DeletePhoneNumberResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a phone number
      tags:
        - Number Configurations
      x-endpoint-cost: medium
      x-latency-category: responsive
    get:
      operationId: retrievePhoneNumber
      parameters:
        - $ref: "#/components/parameters/IntId"
      responses:
        "200":
          $ref: "#/components/responses/PhoneNumberResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a phone number
      tags:
        - Number Configurations
      x-endpoint-cost: medium
      x-latency-category: responsive
    patch:
      operationId: updatePhoneNumber
      parameters:
        - $ref: "#/components/parameters/IntId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdatePhoneNumberRequest"
        description: Updated settings for the phone number.
        required: true
      responses:
        "200":
          $ref: "#/components/responses/PhoneNumberResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a phone number
      tags:
        - Number Configurations
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/phone_numbers/{id}/actions/enable_emergency":
    post:
      operationId: enableEmergencyPhoneNumber
      parameters:
        - $ref: "#/components/parameters/IntId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PhoneNumberEnableEmergencyRequest"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/PhoneNumberWithVoiceSettings"
                title: Phone Number Enable Emergency
                type: object
          description: Phone number emergency enabled.
        "202":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/PhoneNumberWithVoiceSettings"
                title: Phone Number Enable Emergency
                type: object
          description: Phone number emergency requested.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Enable emergency for a phone number
      tags:
        - Number Configurations
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/phone_numbers/{id}/messaging":
    get:
      operationId: retrievePhoneNumberWithMessagingSettings
      parameters:
        - description: Identifies the type of resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/PhoneNumberWithMessagingSettingsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a phone number with messaging settings
      tags:
        - Number Configurations
      x-latency-category: responsive
    patch:
      operationId: updatePhoneNumberWithMessagingSettings
      parameters:
        - description: Identifies the type of resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdatePhoneNumberMessagingSettingsRequest"
        description: Updated messaging settings for the phone number
        required: true
      responses:
        "200":
          $ref: "#/components/responses/PhoneNumberWithMessagingSettingsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a phone number with messaging settings
      tags:
        - Number Configurations
      x-latency-category: responsive
  "/phone_numbers/{id}/voice":
    get:
      operationId: retrievePhoneNumberWithVoiceSettings
      parameters:
        - $ref: "#/components/parameters/IntId"
      responses:
        "200":
          $ref: "#/components/responses/PhoneNumberWithVoiceSettingsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a phone number with voice settings
      tags:
        - Number Configurations
      x-endpoint-cost: medium
      x-latency-category: responsive
    patch:
      operationId: updatePhoneNumberWithVoiceSettings
      parameters:
        - $ref: "#/components/parameters/IntId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdatePhoneNumberVoiceSettingsRequest"
        description: Updated voice settings for the phone number.
        required: true
      responses:
        "200":
          $ref: "#/components/responses/PhoneNumberWithVoiceSettingsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a phone number with voice settings
      tags:
        - Number Configurations
      x-endpoint-cost: medium
      x-latency-category: responsive
  /portability_checks:
    post:
      description: Runs a portability check, returning the results immediately.
      operationId: postPortabilityCheck
      requestBody:
        content:
          application/json:
            schema:
              properties:
                phone_numbers:
                  description: The list of +E.164 formatted phone numbers to check for portability
                  example:
                    - "+13035550000"
                    - "+13035550001"
                    - "+13035550002"
                  items:
                    type: string
                  type: array
              type: object
        required: true
      responses:
        "201":
          $ref: "#/components/responses/PortabilityCheckResponse"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Run a portability check
      tags:
        - Phone Number Porting
      x-latency-category: responsive
  /porting_orders:
    get:
      description: Returns a list of your porting order.
      operationId: listPortingOrders
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/QueryIncludePhoneNumbers"
        - $ref: "#/components/parameters/FilterByPortingOrderStatus"
        - description: Filter results by user reference
          example: 123abc
          in: query
          name: filter[customer_reference]
          schema:
            type: string
        - description: Filter results by country ISO 3166-1 alpha-2 code
          example: US
          in: query
          name: filter[phone_numbers][country_code]
          schema:
            type: string
        - description: Filter results by old service provider
          example: Telnyx
          in: query
          name: filter[phone_numbers][carrier_name]
          schema:
            type: string
        - description: Filter results by porting order type
          example: full
          in: query
          name: filter[misc][type]
          schema:
            $ref: "#/components/schemas/PortingOrderType"
        - description: Filter results by person or company name
          example: Porter McPortersen
          in: query
          name: filter[end_user][admin][entity_name]
          schema:
            type: string
        - description: Filter results by authorized person
          example: Admin McPortersen
          in: query
          name: filter[end_user][admin][auth_person_name]
          schema:
            type: string
        - description: Filter results by fast port eligible
          example: false
          in: query
          name: filter[activation_settings][fast_port_eligible]
          schema:
            type: boolean
        - description: Filter results by foc date later than this value
          example: 2021-03-25T10:00:00.000Z
          in: query
          name: filter[activation_settings][foc_datetime_requested][gt]
          schema:
            type: string
        - description: Filter results by foc date earlier than this value
          example: 2021-03-25T10:00:00.000Z
          in: query
          name: filter[activation_settings][foc_datetime_requested][lt]
          schema:
            type: string
        - description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
          in: query
          name: sort
          schema:
            enum:
              - created_at
              - -created_at
              - activation_settings.foc_datetime_requested
              - -activation_settings.foc_datetime_requested
            example: created_at
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ListPortingOrder"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: List all porting orders
      tags:
        - Porting Order
      x-latency-category: responsive
    post:
      description: Creates a new porting order object.
      operationId: createPortingOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreatePortingOrder"
        required: true
      responses:
        "201":
          $ref: "#/components/responses/ListPortingOrderWithoutPagination"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Create a porting order
      tags:
        - Porting Order
      x-latency-category: responsive
  /porting_orders/exception_types:
    get:
      description: Returns a list of all possible exception types for a porting order.
      operationId: listPortingOrdersExceptionTypes
      parameters: []
      responses:
        "200":
          $ref: "#/components/responses/ListPortingOrdersExceptionTypes"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: List all exception types
      tags:
        - Porting Order
      x-latency-category: responsive
  "/porting_orders/{id}":
    delete:
      description: Request the cancellation of a porting order.
      operationId: deletePortingOrder
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
      responses:
        "200":
          $ref: "#/components/responses/ShowPortingOrder"
        "401":
          description: Unauthorized
      summary: Request cancellation
      tags:
        - Porting Order
      x-latency-category: responsive
    get:
      description: Retrieves the details of an existing porting order.
      operationId: getPortingOrder
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
        - $ref: "#/components/parameters/QueryIncludePhoneNumbers"
      responses:
        "200":
          $ref: "#/components/responses/ShowPortingOrder"
        "401":
          description: Unauthorized
      summary: Retrieve a porting order
      tags:
        - Porting Order
      x-latency-category: responsive
    patch:
      description: |-
        Edits the details of an existing porting order.

        Any or all of a porting order’s attributes may be included in the resource object included in a PATCH request.

        If a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values. To explicitly set something to null, it must be included in the request with a null value.
      operationId: updatePortingOrder
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdatePortingOrder"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ShowPortingOrder"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Edit a porting order
      tags:
        - Porting Order
      x-latency-category: responsive
  "/porting_orders/{id}/actions/activate":
    post:
      description: Activate every numbers of a porting order asynchronously.
      operationId: activatePortingOrder
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
      responses:
        "202":
          $ref: "#/components/responses/ShowPortingOrdersActivationJob"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Activates every number on a porting order.
      tags:
        - Porting Order
      x-latency-category: responsive
  "/porting_orders/{id}/actions/cancel":
    post:
      description: Cancel this porting order
      operationId: cancelPortingOrder
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
      responses:
        "200":
          $ref: "#/components/responses/ShowPortingOrder"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Cancel this porting order
      tags:
        - Porting Order
      x-latency-category: responsive
  "/porting_orders/{id}/actions/confirm":
    post:
      description: Confirm your porting order.
      operationId: confirmPortingOrder
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
      responses:
        "200":
          $ref: "#/components/responses/ShowPortingOrder"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Confirms the porting order is ready to be actioned.
      tags:
        - Porting Order
      x-latency-category: responsive
  "/porting_orders/{id}/activation_jobs":
    get:
      description: Returns a list of your porting activation jobs.
      operationId: listPortingOrdersActivationJobs
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListPortingOrdersActivationJobs"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: List all porting activation jobs
      tags:
        - Porting Order
      x-latency-category: responsive
  "/porting_orders/{id}/activation_jobs/{activationJobId}":
    get:
      description: Returns a porting activation job.
      operationId: getPortingOrdersActivationJob
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
        - $ref: "#/components/parameters/PathPortingOrdersActivationJobID"
      responses:
        "200":
          $ref: "#/components/responses/ShowPortingOrdersActivationJob"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Retrieve a porting activation job
      tags:
        - Porting Order
      x-latency-category: responsive
  "/porting_orders/{id}/comments":
    get:
      description: Returns a list of all comments of a porting order.
      operationId: listPortingOrdersComments
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListPortingOrdersComments"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: List all comments of a porting order
      tags:
        - Porting Order
      x-latency-category: responsive
    post:
      description: Creates a new comment for a porting order.
      operationId: createPortingOrderComment
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreatePortingOrderComment"
        required: true
      responses:
        "201":
          $ref: "#/components/responses/ShowPortingOrdersComment"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Create a comment for a porting order
      tags:
        - Porting Order
      x-latency-category: responsive
  "/porting_orders/{id}/loa_template":
    get:
      description: Download a porting order loa template
      operationId: getPortingOrderLOATemplate
      parameters:
        - $ref: "#/components/parameters/PathPortingOrderID"
      responses:
        "200":
          $ref: "#/components/responses/DownloadLOATemplate"
        "401":
          description: Unauthorized
      summary: Download a porting order loa template
      tags:
        - Porting Order
      x-latency-category: responsive
  /porting_phone_numbers:
    get:
      description: Returns a list of your porting phone numbers.
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterByPortingOrderID"
        - $ref: "#/components/parameters/FilterByPhoneNumber"
        - $ref: "#/components/parameters/FilterByActivationStatus"
        - $ref: "#/components/parameters/FilterByPortabilityStatus"
      responses:
        "200":
          $ref: "#/components/responses/ListPhoneNumbers"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: List all porting phone numbers
      tags:
        - Porting Order
      x-latency-category: responsive
  /portouts:
    get:
      description: Returns the portout requests according to filters
      operationId: listPortoutRequest
      parameters:
        - description: Filter by new carrier name.
          in: query
          name: filter[carrier_name]
          required: false
          schema:
            type: string
        - description: Filter by new carrier spid.
          in: query
          name: filter[spid]
          required: false
          schema:
            type: string
        - description: Filter by portout status.
          in: query
          name: filter[status]
          required: false
          schema:
            enum:
              - pending
              - authorized
              - ported
              - rejected
              - rejected-pending
              - canceled
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListPortoutResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Retrieve a list of portout requests
      tags:
        - Number Portout
      x-latency-category: responsive
  "/portouts/{id}":
    get:
      description: Returns the portout request based on the ID provided
      operationId: findPortoutRequest
      parameters:
        - description: Portout id
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          $ref: "#/components/responses/PortoutResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Retrieve a portout request
      tags:
        - Number Portout
      x-latency-category: responsive
  "/portouts/{id}/comments":
    get:
      description: Returns a list of comments for a portout request.
      operationId: findPortoutComments
      parameters:
        - description: Portout id
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ListPortoutComments"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: List all comments for a portout request
      tags:
        - Number Portout
      x-latency-category: responsive
    post:
      description: Creates a comment on a portout request.
      operationId: postPortRequestComment
      parameters:
        - description: Portout id
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                body:
                  description: Comment to post on this portout request
                  type: string
              type: object
        required: true
      responses:
        "201":
          $ref: "#/components/responses/PortoutCommentResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Create a comment on a portout request
      tags:
        - Number Portout
      x-latency-category: responsive
  "/portouts/{id}/{status}":
    patch:
      description: Authorize or reject portout request
      operationId: updatePortoutRequest
      parameters:
        - description: Portout id
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - description: Updated portout status
          in: path
          name: status
          required: true
          schema:
            enum:
              - authorized
              - rejected
            type: string
      responses:
        "200":
          $ref: "#/components/responses/PortoutResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Unprocessable entity. Check message field in response for details.
      summary: Update Status
      tags:
        - Number Portout
      x-latency-category: responsive
  /private_wireless_gateways:
    get:
      description: Get all Private Wireless Gateways belonging to the user.
      operationId: getPrivateWirelessGateways
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: The name of the Private Wireless Gateway.
          example: my private gateway
          in: query
          name: filter[name]
          required: false
          schema:
            type: string
        - description: The IP address range of the Private Wireless Gateway.
          example: 192.168.0.0/24
          in: query
          name: filter[ip_range]
          required: false
          schema:
            type: string
        - description: The name of the region where the Private Wireless Gateway is deployed.
          example: ashburn-va
          in: query
          name: filter[region_code]
          required: false
          schema:
            type: string
        - description: Private Wireless Gateway resource creation date.
          example: 2018-02-02T22:25:27.521Z
          in: query
          name: filter[created_at]
          required: false
          schema:
            type: string
        - description: When the Private Wireless Gateway was last updated.
          example: 2018-02-02T22:25:27.521Z
          in: query
          name: filter[updated_at]
          required: false
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/GetAllPrivateWirelessGatewaysResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get all Private Wireless Gateways
      tags:
        - Private Wireless Gateways
      x-latency-category: background
    post:
      description: Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network.
      operationId: createPrivateWirelessGateway
      requestBody:
        content:
          application/json:
            schema:
              properties:
                name:
                  description: The private wireless gateway name.
                  example: My private wireless gateway
                  type: string
                network_id:
                  description: The identification of the related network resource.
                  example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
                  format: uuid
                  type: string
              required:
                - network_id
                - name
              type: object
        required: true
      responses:
        "202":
          $ref: "#/components/responses/CreatePrivateWirelessGatewayResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a Private Wireless Gateway
      tags:
        - Private Wireless Gateways
      x-latency-category: background
  "/private_wireless_gateways/{id}":
    delete:
      description: Deletes the Private Wireless Gateway.
      operationId: deletePrivateWirelessGateway
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/DeletePrivateWirelessGatewayResponse"
        "404":
          $ref: "#/components/responses/ResourceNotFound"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a Private Wireless Gateway
      tags:
        - Private Wireless Gateways
      x-latency-category: responsive
    get:
      description: Retrieve information about a Private Wireless Gateway.
      operationId: getPrivateWirelessGateway
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/GetPrivateWirelessGatewayResponse"
        "404":
          $ref: "#/components/responses/ResourceNotFound"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get a Private Wireless Gateway
      tags:
        - Private Wireless Gateways
      x-latency-category: responsive
  "/queues/{queue_name}":
    get:
      description: Retrieve an existing call queue
      operationId: retrieveCallQueue
      parameters:
        - description: Uniquely identifies the queue by name
          in: path
          name: queue_name
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/QueueResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
      summary: Retrieve a call queue
      tags:
        - Queue Commands
      x-latency-category: interactive
  "/queues/{queue_name}/calls":
    get:
      description: Retrieve the list of calls in an existing queue
      operationId: listQueueCalls
      parameters:
        - description: Uniquely identifies the queue by name
          in: path
          name: queue_name
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListQueueCallsResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
      summary: Retrieve calls from a queue
      tags:
        - Queue Commands
      x-latency-category: interactive
  "/queues/{queue_name}/calls/{call_control_id}":
    get:
      description: Retrieve an existing call from an existing queue
      operationId: retrieveCallFromQueue
      parameters:
        - description: Uniquely identifies the queue by name
          in: path
          name: queue_name
          required: true
          schema:
            type: string
        - $ref: "#/components/parameters/CallControlId"
      responses:
        "200":
          $ref: "#/components/responses/QueueCallResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
      summary: Retrieve a call from a queue
      tags:
        - Queue Commands
      x-latency-category: interactive
  /recordings:
    get:
      description: Lists recordings for the authenticated user
      operationId: listRecordings
      parameters:
        - description: Return only recordings associated with a given conference
          in: query
          name: filter[conference_id]
          required: false
          schema:
            example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
            type: string
        - description: Return only recordings created later than or at given ISO 8601 datetime
          in: query
          name: filter[created_at][gte]
          required: false
          schema:
            example: 2019-03-29T11:10:00Z
            type: string
        - description: Return only recordings created earlier than or at given ISO 8601 datetime
          in: query
          name: filter[created_at][lte]
          required: false
          schema:
            example: 2019-03-29T11:10:00Z
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListRecordingsResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntityResponse"
      summary: List recordings
      tags:
        - Recordings Commands
      x-group-parameters: "true"
      x-latency-category: interactive
  "/recordings/{id}":
    get:
      description: Retrieve a recording from the authenticated user's recordings
      operationId: retrieveRecording
      parameters:
        - description: Uniquely identifies the recording
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/RecordingResponse"
        "401":
          $ref: "#/components/responses/UnauthorizedResponse"
        "404":
          $ref: "#/components/responses/NotFoundResponse"
      summary: Retrieve a recording
      tags:
        - Recordings Commands
      x-latency-category: interactive
  /reports/batch_mdr_reports:
    get:
      description: "Fetch all previous requests for messaging detail reports. Messaging detail reports are reports for pulling all messaging records. "
      operationId: getCdrRequests
      parameters:
        - description: Page number
          in: query
          name: page[number]
          schema:
            default: 1
            format: int32
            type: integer
        - description: Size of the page
          in: query
          name: page[size]
          schema:
            default: 20
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrGetDetailReportResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Detail Reports
      x-latency-category: interactive
    post:
      description: Submit a request for new messaging detail report. Messaging detail report pulls all raw messaging data according to defined filters.
      operationId: submitMdrRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MdrPostDetailReportRequest"
        description: Mdr detail request data
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrPostDetailReportResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Detail Reports
      x-latency-category: background
  "/reports/batch_mdr_reports/{id}":
    delete:
      description: Delete generated messaging detail report by id
      operationId: deleteMdrRequest
      parameters:
        - content:
            "*/*":
              schema:
                format: uuid
                type: string
          in: path
          name: id
          required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrDeleteDetailReportResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Detail Reports
      x-latency-category: interactive
    get:
      description: Fetch single messaging detail report by id.
      operationId: getMdrRequest
      parameters:
        - content:
            "*/*":
              schema:
                format: uuid
                type: string
          in: path
          name: id
          required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrGetDetailReportByIdResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Detail Reports
      x-latency-category: interactive
  /reports/cdr_usage_reports/sync:
    get:
      description: "Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes. "
      operationId: getUsageReportSync
      parameters:
        - in: query
          name: start_date
          schema:
            example: 2020-07-01T00:00:00-06:00
            format: date-time
            type: string
        - in: query
          name: end_date
          schema:
            example: 2020-07-01T00:00:00-06:00
            format: date-time
            type: string
        - in: query
          name: aggregation_type
          required: true
          schema:
            enum:
              - NO_AGGREGATION
              - CONNECTION
              - TAG
              - BILLING_GROUP
            example: no_aggregation
            type: string
        - in: query
          name: product_breakdown
          required: true
          schema:
            enum:
              - NO_BREAKDOWN
              - DID_VS_TOLL_FREE
              - COUNTRY
              - DID_VS_TOLL_FREE_PER_COUNTRY
            example: no_breakdown
            type: string
        - in: query
          name: connections
          schema:
            example: 1234567890123
            items:
              example: 1234567890123
              type: number
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CdrGetSyncUsageReportResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - CDR Usage Reports
      x-latency-category: background
  /reports/mdr_usage_reports:
    get:
      description: Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown
      operationId: getUsageReports
      parameters:
        - description: Page number
          in: query
          name: page[number]
          schema:
            default: 1
            format: int32
            type: integer
        - description: Size of the page
          in: query
          name: page[size]
          schema:
            default: 20
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrGetUsageReportsResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Usage Reports
      x-latency-category: interactive
    post:
      description: "Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period. "
      operationId: submitUsageReport
      requestBody:
        content:
          "*/*":
            schema:
              $ref: "#/components/schemas/MdrPostUsageReportRequest"
        description: Mdr usage report data
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrPostUsageReportsResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Usage Reports
      x-latency-category: background
  /reports/mdr_usage_reports/sync:
    get:
      description: "Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes. "
      operationId: getUsageReportSync_1
      parameters:
        - in: query
          name: start_date
          schema:
            example: 2020-07-01T00:00:00-06:00
            format: date-time
            type: string
        - in: query
          name: end_date
          schema:
            example: 2020-07-01T00:00:00-06:00
            format: date-time
            type: string
        - in: query
          name: aggregation_type
          required: true
          schema:
            enum:
              - NO_AGGREGATION
              - PROFILE
              - TAGS
            example: profile
            type: string
        - in: query
          name: profiles
          schema:
            example: My profile
            items:
              example: My profile
              type: string
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrGetSyncUsageReportResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Usage Reports
      x-latency-category: background
  "/reports/mdr_usage_reports/{id}":
    delete:
      description: Delete messaging usage report by id
      operationId: deleteUsageReport
      parameters:
        - content:
            "*/*":
              schema:
                format: uuid
                type: string
          in: path
          name: id
          required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrDeleteUsageReportsResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Usage Reports
      x-latency-category: interactive
    get:
      description: Fetch a single messaging usage report by id
      operationId: getUsageReport
      parameters:
        - content:
            "*/*":
              schema:
                format: uuid
                type: string
          in: path
          name: id
          required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrGetUsageReportsByIdResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Usage Reports
      x-latency-category: interactive
  /reports/mdrs:
    get:
      description: "Fetch all Mdr records "
      parameters:
        - description: Pagination start date
          in: query
          name: start_date
          schema:
            type: string
        - description: Pagination end date
          in: query
          name: end_date
          schema:
            type: string
        - in: query
          name: id
          schema:
            description: Message uuid
            example: e093fbe0-5bde-11eb-ae93-0242ac130002
            type: string
        - in: query
          name: direction
          schema:
            description: Direction (inbound or outbound)
            enum:
              - INBOUND
              - OUTBOUND
            example: INBOUND
            type: string
        - in: query
          name: profile
          schema:
            description: Name of the profile
            example: My profile
            type: string
        - in: query
          name: cld
          schema:
            description: Destination number
            example: "+15551237654"
            type: string
        - in: query
          name: cli
          schema:
            description: Origination number
            example: "+15551237654"
            type: string
        - in: query
          name: status
          schema:
            description: Message status
            enum:
              - GW_TIMEOUT
              - DELIVERED
              - DLR_UNCONFIRMED
              - DLR_TIMEOUT
              - RECEIVED
              - GW_REJECT
              - FAILED
            example: DELIVERED
            type: string
        - in: query
          name: message_type
          schema:
            description: Type of message
            enum:
              - SMS
              - MMS
            example: SMS
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/MdrGetDetailResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - MDR Detail Reports
      x-latency-category: interactive
  /reports/wdrs:
    get:
      description: "Fetch all Wdr records "
      operationId: getPaginatedWdrs
      parameters:
        - description: Start date
          in: query
          name: start_date
          schema:
            example: 2021-05-01T00:00:00Z
            type: string
        - description: End date
          in: query
          name: end_date
          schema:
            example: 2021-06-01T00:00:00Z
            type: string
        - in: query
          name: id
          schema:
            description: WDR uuid
            example: e093fbe0-5bde-11eb-ae93-0242ac130002
            type: string
        - in: query
          name: mcc
          schema:
            description: Mobile country code
            example: "204"
            type: string
        - in: query
          name: mnc
          schema:
            description: Mobile network code
            example: "01"
            type: string
        - in: query
          name: imsi
          schema:
            description: International mobile subscriber identity
            example: "123456"
            type: string
        - in: query
          name: sim_group_name
          schema:
            description: Sim group name
            example: sim name
            type: string
        - in: query
          name: sim_group_id
          schema:
            description: Sim group unique identifier
            example: f05a189f-7c46-4531-ac56-1460dc465a42
            type: string
        - in: query
          name: sim_card_id
          schema:
            description: Sim card unique identifier
            example: 877f80a6-e5b2-4687-9a04-88076265720f
            type: string
        - in: query
          name: phone_number
          schema:
            description: Phone number
            example: "+12345678910"
            type: string
        - description: Page number
          in: query
          name: page[number]
          schema:
            default: 1
            format: int32
            type: integer
        - description: Size of the page
          in: query
          name: page[size]
          schema:
            default: 20
            format: int32
            type: integer
        - in: query
          name: sort
          schema:
            default: created_at
            description: Field used to order the data. If no field is specified, default value is 'created_at'
            example: created_at
            items:
              type: string
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ExternalWdrGetDetailResponse"
          description: Successful
      tags:
        - WDR Detail Reports
      x-latency-category: interactive
  /requirement_types:
    get:
      description: List all requirement types ordered by created_at descending
      operationId: docReqsListRequirementTypes
      parameters:
        - $ref: "#/components/parameters/DocReqsRequirementTypeNameFilter"
        - $ref: "#/components/parameters/DocReqsRequirementTypesSort"
      responses:
        "200":
          $ref: "#/components/responses/DocReqsListRequirementTypesResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all requirement types
      tags:
        - Requirement Types
      x-latency-category: responsive
  "/requirement_types/{id}":
    get:
      description: Retrieve a requirement type by id
      operationId: docReqsRetrieveRequirementType
      parameters:
        - $ref: "#/components/parameters/DocReqsRequirementTypeId"
      responses:
        "200":
          $ref: "#/components/responses/DocReqsRequirementTypeResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a requirement types
      tags:
        - Requirement Types
      x-latency-category: responsive
  /requirements:
    get:
      description: List all requirements with filtering, sorting, and pagination
      operationId: listRequirements
      parameters:
        - $ref: "#/components/parameters/DocReqsCountryFilter"
        - $ref: "#/components/parameters/DocReqsPhoneNumberTypeFilter"
        - $ref: "#/components/parameters/DocReqsActionFilter"
        - $ref: "#/components/parameters/DocReqsRequirementsSort"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListRequirementsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all requirements
      tags:
        - Requirements
      x-latency-category: responsive
  "/requirements/{id}":
    get:
      description: Retrieve a document requirement record
      operationId: docReqsRetrieveDocumentRequirements
      parameters:
        - $ref: "#/components/parameters/DocReqsRequirementId"
      responses:
        "200":
          $ref: "#/components/responses/DocReqsRequirementResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a document requirement
      tags:
        - Requirements
      x-latency-category: responsive
  /room_participants:
    get:
      description: ""
      operationId: ListRoomParticipants
      parameters:
        - description: ISO 8601 date for filtering room participants that joined on that date.
          in: query
          name: filter[date_joined_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that joined after that date.
          in: query
          name: filter[date_joined_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that joined before that date.
          in: query
          name: filter[date_joined_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants updated on that date.
          in: query
          name: filter[date_updated_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants updated after that date.
          in: query
          name: filter[date_updated_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants updated before that date.
          in: query
          name: filter[date_updated_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that left on that date.
          in: query
          name: filter[date_left_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that left after that date.
          in: query
          name: filter[date_left_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that left before that date.
          in: query
          name: filter[date_left_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: Filter room participants based on the context.
          in: query
          name: filter[context]
          schema:
            example: Alice
            type: string
        - description: Session_id for filtering room participants.
          in: query
          name: filter[session_id]
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            type: string
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListRoomParticipantsResponse"
      summary: View a list of room participants.
      tags:
        - Room Participants
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/room_participants/{room_participant_id}":
    get:
      operationId: ViewRoomParticipant
      parameters:
        - description: The unique identifier of a room participant.
          in: path
          name: room_participant_id
          required: true
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            format: uuid
            type: string
      responses:
        "200":
          $ref: "#/components/responses/GetRoomParticipantResponse"
        "404":
          $ref: "#/components/responses/ResourceNotFound"
      summary: View a room participant.
      tags:
        - Room Participants
      x-endpoint-cost: light
      x-latency-category: responsive
  /room_sessions:
    get:
      description: ""
      operationId: ListRoomSessions
      parameters:
        - description: ISO 8601 date for filtering room sessions created on that date.
          in: query
          name: filter[date_created_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions created after that date.
          in: query
          name: filter[date_created_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions created before that date.
          in: query
          name: filter[date_created_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions updated on that date.
          in: query
          name: filter[date_updated_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions updated after that date.
          in: query
          name: filter[date_updated_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions updated before that date.
          in: query
          name: filter[date_updated_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions ended on that date.
          in: query
          name: filter[date_ended_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions ended after that date.
          in: query
          name: filter[date_ended_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions ended before that date.
          in: query
          name: filter[date_ended_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: Room_id for filtering room sessions.
          in: query
          name: filter[room_id]
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            type: string
        - description: Filter active or inactive room sessions.
          in: query
          name: filter[active]
          schema:
            example: true
            type: boolean
        - description: To decide if room participants should be included in the response.
          in: query
          name: include_participants
          schema:
            example: true
            type: boolean
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListRoomSessionsResponse"
      summary: View a list of room sessions.
      tags:
        - Room Sessions
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/room_sessions/{room_session_id}":
    get:
      operationId: ViewRoomSession
      parameters:
        - description: The unique identifier of a room session.
          in: path
          name: room_session_id
          required: true
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            format: uuid
            type: string
        - description: To decide if room participants should be included in the response.
          in: query
          name: include_participants
          schema:
            example: true
            type: boolean
      responses:
        "200":
          $ref: "#/components/responses/GetRoomSessionResponse"
        "404":
          $ref: "#/components/responses/ResourceNotFound"
      summary: View a room session.
      tags:
        - Room Sessions
      x-endpoint-cost: light
      x-latency-category: responsive
  "/room_sessions/{room_session_id}/participants":
    get:
      description: ""
      operationId: NestedListRoomParticipants
      parameters:
        - description: The unique identifier of a room session.
          in: path
          name: room_session_id
          required: true
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            format: uuid
            type: string
        - description: ISO 8601 date for filtering room participants that joined on that date.
          in: query
          name: filter[date_joined_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that joined after that date.
          in: query
          name: filter[date_joined_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that joined before that date.
          in: query
          name: filter[date_joined_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants updated on that date.
          in: query
          name: filter[date_updated_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants updated after that date.
          in: query
          name: filter[date_updated_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants updated before that date.
          in: query
          name: filter[date_updated_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that left on that date.
          in: query
          name: filter[date_left_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that left after that date.
          in: query
          name: filter[date_left_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room participants that left before that date.
          in: query
          name: filter[date_left_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: Filter room participants based on the context.
          in: query
          name: filter[context]
          schema:
            example: Alice
            type: string
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListRoomParticipantsResponse"
      summary: View a list of room participants.
      tags:
        - Room Sessions
      x-endpoint-cost: medium
      x-latency-category: responsive
  /rooms:
    get:
      description: ""
      operationId: ListRooms
      parameters:
        - description: ISO 8601 date for filtering rooms created on that date.
          in: query
          name: filter[date_created_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering rooms created after that date.
          in: query
          name: filter[date_created_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering rooms created before that date.
          in: query
          name: filter[date_created_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering rooms updated on that date.
          in: query
          name: filter[date_updated_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering rooms updated after that date.
          in: query
          name: filter[date_updated_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering rooms updated before that date.
          in: query
          name: filter[date_updated_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: Unique_name for filtering rooms.
          in: query
          name: filter[unique_name]
          schema:
            example: my_video_room
            type: string
        - description: To decide if room sessions should be included in the response.
          in: query
          name: include_sessions
          schema:
            example: true
            type: boolean
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListRoomsResponse"
      summary: View a list of rooms.
      tags:
        - Rooms
      x-endpoint-cost: medium
      x-latency-category: responsive
    post:
      description: Synchronously create a Room.
      operationId: CreateRoom
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateRoomRequest"
        description: Parameters that can be defined during room creation.
        required: true
      responses:
        "201":
          $ref: "#/components/responses/CreateRoomResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
      summary: Create a room.
      tags:
        - Rooms
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/rooms/{room_id}":
    delete:
      description: Synchronously delete a Room. Participants from that room will be kicked out, they won't be able to join that room anymore, and you won't be charged anymore for that room.
      operationId: DeleteRoom
      parameters:
        - description: The unique identifier of a room.
          in: path
          name: room_id
          required: true
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            format: uuid
            type: string
      responses:
        "204":
          description: The resource was deleted successfully.
        "404":
          $ref: "#/components/responses/ResourceNotFound"
      summary: Delete a room.
      tags:
        - Rooms
      x-endpoint-cost: medium
      x-latency-category: responsive
    get:
      operationId: ViewRoom
      parameters:
        - description: The unique identifier of a room.
          in: path
          name: room_id
          required: true
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            format: uuid
            type: string
        - description: To decide if room sessions should be included in the response.
          in: query
          name: include_sessions
          schema:
            example: true
            type: boolean
      responses:
        "200":
          $ref: "#/components/responses/GetRoomResponse"
        "404":
          $ref: "#/components/responses/ResourceNotFound"
      summary: View a room.
      tags:
        - Rooms
      x-endpoint-cost: light
      x-latency-category: responsive
  "/rooms/{room_id}/actions/generate_join_client_token":
    post:
      description: Synchronously create an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after `token_ttl_secs`, a Refresh Token is also provided to refresh a Client Token, the Refresh Token expires after `refresh_token_ttl_secs`.
      operationId: CreateRoomClientToken
      parameters:
        - description: The unique identifier of a room.
          in: path
          name: room_id
          required: true
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateRoomClientTokenRequest"
        description: Parameters that can be defined during Room Client Token creation.
        required: true
      responses:
        "201":
          $ref: "#/components/responses/CreateRoomClientTokenResponse"
        "403":
          $ref: "#/components/responses/Forbidden"
      summary: Create Client Token to join a room.
      tags:
        - Rooms Client Tokens
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/rooms/{room_id}/actions/refresh_client_token":
    post:
      description: Synchronously refresh an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after `token_ttl_secs`.
      operationId: RefreshRoomClientToken
      parameters:
        - description: The unique identifier of a room.
          in: path
          name: room_id
          required: true
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/RefreshRoomClientTokenRequest"
        description: Parameters that can be defined during Room Client Token refresh.
        required: true
      responses:
        "201":
          $ref: "#/components/responses/RefreshRoomClientTokenResponse"
        "403":
          $ref: "#/components/responses/Forbidden"
      security: []
      summary: Refresh Client Token to join a room.
      tags:
        - Rooms Client Tokens
      x-endpoint-cost: light
      x-latency-category: responsive
  "/rooms/{room_id}/sessions":
    get:
      description: ""
      operationId: NestedListRoomSessions
      parameters:
        - description: The unique identifier of a room.
          in: path
          name: room_id
          required: true
          schema:
            example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
            format: uuid
            type: string
        - description: ISO 8601 date for filtering room sessions created on that date.
          in: query
          name: filter[date_created_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions created after that date.
          in: query
          name: filter[date_created_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions created before that date.
          in: query
          name: filter[date_created_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions updated on that date.
          in: query
          name: filter[date_updated_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions updated after that date.
          in: query
          name: filter[date_updated_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions updated before that date.
          in: query
          name: filter[date_updated_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions ended on that date.
          in: query
          name: filter[date_ended_at][eq]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions ended after that date.
          in: query
          name: filter[date_ended_at][gte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: ISO 8601 date for filtering room sessions ended before that date.
          in: query
          name: filter[date_ended_at][lte]
          schema:
            example: 2021-04-25
            format: date
            type: string
        - description: Filter active or inactive room sessions.
          in: query
          name: filter[active]
          schema:
            example: true
            type: boolean
        - description: To decide if room participants should be included in the response.
          in: query
          name: include_participants
          schema:
            example: true
            type: boolean
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListRoomSessionsResponse"
      summary: View a list of room sessions.
      tags:
        - Rooms
      x-endpoint-cost: medium
      x-latency-category: responsive
  /short_codes:
    get:
      operationId: listShortCodes
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: Filter by Messaging Profile ID. Use the string `null` for phone numbers without assigned profiles. A synonym for the `/messaging_profiles/{id}/short_codes` endpoint when querying about an extant profile.
          in: query
          name: filter[messaging_profile_id]
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/ListShortCodesResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List short codes
      tags:
        - Short Codes
      x-group-parameters: "true"
      x-latency-category: responsive
  "/short_codes/{id}":
    get:
      operationId: retrieveShortCode
      parameters:
        - $ref: "#/components/parameters/ShortCodeId"
      responses:
        "200":
          $ref: "#/components/responses/ShortCodeResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a short code
      tags:
        - Short Codes
      x-latency-category: responsive
    patch:
      description: Update the settings for a specific short code. To unbind a short code from a profile, set the `messaging_profile_id` to `null` or an empty string.
      operationId: updateShortCode
      parameters:
        - $ref: "#/components/parameters/ShortCodeId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateShortCodeRequest"
        description: Short code update
        required: true
      responses:
        "200":
          $ref: "#/components/responses/ShortCodeResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update short code
      tags:
        - Short Codes
      x-latency-category: responsive
  /sim_card_group_actions:
    get:
      description: This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.
      operationId: SimCardGroupActionsGet
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/FilterSIMCardGroupId"
        - $ref: "#/components/parameters/FilterBasicStatusLifecycle"
        - description: Filter by action type.
          in: query
          name: filter[type]
          required: false
          schema:
            enum:
              - set_private_wireless_gateway
              - remove_private_wireless_gateway
            example: set_private_wireless_gateway
            type: string
      responses:
        "200":
          $ref: "#/components/responses/SimCardGroupActionCollectionResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List SIM card group actions
      tags:
        - SIM Card Group Actions
      x-latency-category: responsive
  "/sim_card_group_actions/{id}":
    get:
      description: This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.
      operationId: SimCardGroupActionGet
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/SIMCardGroupActionResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get SIM card group action details
      tags:
        - SIM Card Group Actions
      x-latency-category: responsive
  /sim_card_groups:
    get:
      description: Get all SIM card groups belonging to the user that match the given filters.
      operationId: SimCardGroupsGetAll
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: A valid SIM card group name.
          in: query
          name: filter[name]
          schema:
            example: My Test Group
            format: uuid
            type: string
      responses:
        "200":
          $ref: "#/components/responses/GetAllSimCardGroupsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get all SIM card groups
      tags:
        - SIM Card Groups
      x-latency-category: responsive
    post:
      description: Creates a new SIM card group object
      operationId: SimCardGroupsPost
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SIMCardGroupCreate"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CreateSimCardGroupResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a SIM card group
      tags:
        - SIM Card Groups
      x-latency-category: responsive
  "/sim_card_groups/{id}":
    delete:
      description: Permanently deletes a SIM card group
      operationId: SimCardGroupDelete
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/DeleteSimCardGroupResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a SIM card group
      tags:
        - SIM Card Groups
      x-latency-category: responsive
    get:
      description: Returns the details regarding a specific SIM card group
      operationId: SimCardGroupsGet
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/GetSimCardGroupResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get SIM card group
      tags:
        - SIM Card Groups
      x-latency-category: responsive
    patch:
      description: Updates a SIM card group
      operationId: SimCardGroupUpdate
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SIMCardGroupPatch"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/UpdateSimCardGroupResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a SIM card group
      tags:
        - SIM Card Groups
      x-latency-category: responsive
  "/sim_card_groups/{id}/actions/remove_private_wireless_gateway":
    post:
      description: This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic handled by Telnyx's default mobile network configuration.
      operationId: RemoveSIMCardGroupPrivateWirelessGateway
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "202":
          $ref: "#/components/responses/SIMCardGroupActionResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Request Private Wireless Gateway removal from SIM card group
      tags:
        - SIM Card Groups
      x-latency-category: background
  "/sim_card_groups/{id}/actions/set_private_wireless_gateway":
    post:
      description: This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic controlled by the associated Private Wireless Gateway. This operation will also imply that new SIM cards assigned to a group will inherit its network definitions. If it's moved to a different group that doesn't have a Private Wireless Gateway, it'll use Telnyx's default mobile network configuration.
      operationId: SetSIMCardGroupPrivateWirelessGateway
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      requestBody:
        content:
          application/json:
            schema:
              properties:
                private_wireless_gateway_id:
                  description: The identification of the related Private Wireless Gateway resource.
                  example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
                  format: uuid
                  type: string
              required:
                - private_wireless_gateway_id
              type: object
        required: true
      responses:
        "202":
          $ref: "#/components/responses/SIMCardGroupActionResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Request Private Wireless Gateway assignment for SIM card group
      tags:
        - SIM Card Groups
      x-latency-category: background
  /sim_card_order_preview:
    post:
      description: Preview SIM card order purchases.
      operationId: SimCardOrdersPreview
      requestBody:
        content:
          application/json:
            schema:
              properties:
                address_id:
                  description: Uniquely identifies the address for the order.
                  example: "1293384261075731499"
                  format: int64
                  type: string
                quantity:
                  description: The amount of SIM cards that the user would like to purchase in the SIM card order.
                  example: 21
                  minimum: 1
                  type: integer
              required:
                - quantity
                - address_id
              type: object
      responses:
        "202":
          $ref: "#/components/responses/SIMCardOrdersPreviewResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
      summary: Preview SIM card orders
      tags:
        - SIM Card Orders
      x-latency-category: responsive
  /sim_card_orders:
    get:
      description: Get all SIM card orders according to filters.
      operationId: SimCardOrdersGet
      parameters:
        - $ref: "#/components/parameters/FilterCreatedAt"
        - $ref: "#/components/parameters/FilterUpdatedAt"
        - $ref: "#/components/parameters/FilterQuantity"
        - $ref: "#/components/parameters/FilterCostByAmount"
        - $ref: "#/components/parameters/FilterCostByCurrency"
        - $ref: "#/components/parameters/FilterAddressById"
        - $ref: "#/components/parameters/FilterAddressByStreetAddress"
        - $ref: "#/components/parameters/FilterAddressByExtendedAddress"
        - $ref: "#/components/parameters/FilterAddressByLocality"
        - $ref: "#/components/parameters/FilterAddressByAdministrativeArea"
        - $ref: "#/components/parameters/FilterAddressByCountryCode"
        - $ref: "#/components/parameters/FilterAddressByPostalCode"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/GetAllSimCardOrdersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get all SIM card orders
      tags:
        - SIM Card Orders
      x-latency-category: responsive
    post:
      description: Creates a new order for SIM cards.
      operationId: SimCardOrdersPost
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SimCardOrderCreate"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CreateSimCardOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a SIM card order
      tags:
        - SIM Card Orders
      x-latency-category: responsive
  "/sim_card_orders/{id}":
    get:
      description: Get a single SIM card order by its ID.
      operationId: SimCardOrderGet
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/GetSimCardOrderResponse"
        "404":
          $ref: "#/components/responses/ResourceNotFound"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get a single SIM card order
      tags:
        - SIM Card Orders
      x-latency-category: responsive
  /sim_cards:
    get:
      description: Get all SIM cards belonging to the user that match the given filters.
      operationId: SimCardsGet
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/IncludeSIMCardGroup"
        - $ref: "#/components/parameters/FilterSIMCardGroupId"
        - description: |
            A list of SIM card tags to filter on.<br/><br/>
            If the SIM card contains <b><i>all</i></b> of the given <code>tags</code> they will be found.<br/><br/>
            For example, if the SIM cards have the following tags: <ul>
              <li><code>['customers', 'staff', 'test']</code>
              <li><code>['test']</code></li>
              <li><code>['customers']</code></li>
            </ul>
            Searching for <code>['customers', 'test']</code> returns only the first because it's the only one with both tags.<br/> Searching for <code>test</code> returns the first two SIMs, because both of them have such tag.<br/> Searching for <code>customers</code> returns the first and last SIMs.<br/>
          in: query
          name: filter[tags]
          required: false
          schema:
            example:
              - personal
              - customers
              - active-customers
            items:
              type: string
            type: array
        - description: A search string to partially match for the SIM card's ICCID.
          in: query
          name: filter[iccid]
          required: false
          schema:
            example: "89310410106543789301"
            type: string
      responses:
        "200":
          $ref: "#/components/responses/SearchSimCardsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get all SIM cards
      tags:
        - SIM Cards
      x-latency-category: responsive
  /sim_cards/actions/validate_registration_codes:
    post:
      description: It validates whether SIM card registration codes are valid or not.
      operationId: postValidateRegistrationCodes
      requestBody:
        content:
          application/json:
            schema:
              description: The object containing the Array of SIM card registration codes.
              example:
                registration_codes:
                  - "123456780"
                  - "1231231230"
              properties:
                registration_codes:
                  items:
                    type: string
                  type: array
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SIMCardRegistrationCodeValidations"
          description: Successful
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Validate SIM cards registration codes
      tags:
        - SIM Cards
      x-latency-category: responsive
  "/sim_cards/{id}":
    delete:
      description: |-
        The SIM card will be decommissioned, removed from your account and you will stop being charged.<br />The SIM card won't be able to connect to the network after the deletion is completed, thus making it impossible to consume data.<br/>
        Transitioning to the disabled state may take a period of time.</br>
        Until the transition is completed, the SIM card status will be disabling <code>disabling</code>.<br />In order to re-enable the SIM card, you will need to re-register it.
      operationId: SimCardDelete
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/DeleteSimCardResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Deletes a SIM card
      tags:
        - SIM Cards
      x-latency-category: responsive
    get:
      description: Returns the details regarding a specific SIM card.
      operationId: SimCardGet
      parameters:
        - $ref: "#/components/parameters/ResourceId"
        - $ref: "#/components/parameters/IncludeSIMCardGroup"
      responses:
        "200":
          $ref: "#/components/responses/GetSimCardResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get SIM card
      tags:
        - SIM Cards
      x-latency-category: responsive
    patch:
      description: Updates a SIM card's group and tags
      operationId: SimCardUpdate
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SIMCard"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/UpdateSimCardResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a SIM card
      tags:
        - SIM Cards
      x-latency-category: responsive
  "/sim_cards/{id}/actions/disable":
    post:
      description: |
        The SIM card won't be able to connect to the network after the disabling is completed, thus making it impossible to consume data.<br/>
        Transitioning to the disabled state may take a period of time.</br>
        Until the transition is completed, the SIM card status will be <code>disabling</code>.
      operationId: SimCardDisable
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "202":
          $ref: "#/components/responses/SimpleSimCardResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Request a SIM card disable
      tags:
        - SIM Cards
      x-latency-category: background
  "/sim_cards/{id}/actions/enable":
    post:
      description: |
        The SIM card will be able to connect to the network once the enabling is complete, thus making it possible to consume data.<br/>
        To enable a SIM card, it must be associated with SIM card group.<br/>
        Transitioning to the enabled state may take a period of time. Until the transition is completed, the SIM card status will be <code>enabling</code>.
      operationId: SimCardEnable
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "202":
          $ref: "#/components/responses/SimpleSimCardResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Request a SIM card enable
      tags:
        - SIM Cards
      x-latency-category: background
  "/sim_cards/{id}/actions/set_standby":
    post:
      description: |
        The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data.<br/>
        To set a SIM card to standby, it must be associated with SIM card group.<br/>
        Transitioning to the standby state may take a period of time. Until the transition is completed, the SIM card status will be <code>setting_standby</code>.
      operationId: SimCardSetStandby
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "202":
          $ref: "#/components/responses/SimpleSimCardResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Request setting a SIM card to standby
      tags:
        - SIM Cards
      x-latency-category: background
  "/sim_cards/{sim_card_id}/network_preferences":
    delete:
      description: |
        This API asynchronously removes the custom-defined network preferences settings. After this operation is done the Telnyx default settings, the same applied for an unaltered SIM card, will be in place.
      operationId: SIMCardNetworkPreferencesDelete
      parameters:
        - $ref: "#/components/parameters/SIMCardId"
      responses:
        "202":
          $ref: "#/components/responses/DELETESIMCardNetworkPreferenceResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: DELETE network preferences
      tags:
        - SIM Cards
      x-latency-category: responsive
    get:
      description: |
        It returns the network preferences currently applied in the SIM card.
      operationId: SIMCardNetworkPreferencesGet
      parameters:
        - $ref: "#/components/parameters/SIMCardId"
        - $ref: "#/components/parameters/IncludeOTAUpdates"
      responses:
        "200":
          $ref: "#/components/responses/SIMCardNetworkPreferenceWithOTAUpdatesResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get network preferences
      tags:
        - SIM Cards
      x-latency-category: responsive
    put:
      description: |
        This API allows setting or updating a SIM card network preference. <br/><br/>
        Every SIM card has default network preferences defined on Telnyx. These preferences will determine how a SIMCard will connect to the network by considering a list of preferable operators.<br/><br/>
        There can be multiple scenarios where an operator can be preferred over another, for example, when a specific mobile operator can provide better network latency or better pricing.
      operationId: SIMCardNetworkPreferencesPut
      parameters:
        - $ref: "#/components/parameters/SIMCardId"
      requestBody:
        content:
          application/json:
            schema:
              properties:
                mobile_operator_networks_preferences:
                  description: A list of mobile operator networks and the priority that should be applied when the SIM is connecting to the network.
                  items:
                    $ref: "#/components/schemas/MobileOperatorNetworkPreferencesRequest"
                  type: array
              type: object
      responses:
        "202":
          $ref: "#/components/responses/PUTSIMCardNetworkPreferenceResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Set network preferences
      tags:
        - SIM Cards
      x-latency-category: responsive
  "/sim_cards/{sim_card_id}/public_ip":
    delete:
      description: |
        This API asynchronously removes an existing public IP from a SIM card.
      operationId: SIMCardPublicIPDelete
      parameters:
        - $ref: "#/components/parameters/SIMCardId"
      responses:
        "200":
          $ref: "#/components/responses/DecommissionedSIMCardPublicIPResponse"
        "202":
          $ref: "#/components/responses/ReceivedSIMCardPublicIPResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete SIM card public IP
      tags:
        - SIM Cards
      x-latency-category: responsive
    get:
      description: |
        It returns the public IP requested for a SIM card.
      operationId: SIMCardPublicIPGet
      parameters:
        - $ref: "#/components/parameters/SIMCardId"
      responses:
        "200":
          $ref: "#/components/responses/SIMCardPublicIPResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get SIM card public IP definition
      tags:
        - SIM Cards
      x-latency-category: responsive
    post:
      description: |-
        This API will asynchronously map a random public IP to a SIM card, making it reachable on the public internet. <br/><br/>
         The request will return the resource as "provisioning" right away, and it'll eventually get "provisioned", meaning it completed the setup. <br/><br/>
         Setting up a public IP will generate charges, and we won't be able to provide the IP if the account doesn't have a balance. In that case, this operation will succeed, but its status will change to failed eventually, and the resource will be updated with the associated status. The IP resource will need to be deleted and re-created with our DELETE and POST APIs in this scenario.
      operationId: SIMCardPublicIPPost
      parameters:
        - $ref: "#/components/parameters/SIMCardId"
      responses:
        "202":
          $ref: "#/components/responses/ReceivedSIMCardPublicIPResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Set SIM card public IP
      tags:
        - SIM Cards
      x-latency-category: responsive
  "/sim_cards/{sim_card_id}/wireless_connectivity_logs":
    get:
      description: This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.
      operationId: WirelessConnectivityLogsGet
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/SIMCardId"
      responses:
        "200":
          $ref: "#/components/responses/WirelessConnectivityLogCollectionResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List wireless connectivity logs
      tags:
        - SIM Cards
      x-latency-category: responsive
  /sub_number_orders:
    get:
      description: Get a paginated list of sub number orders.
      operationId: listSubNumberOrders
      parameters:
        - description: User ID of the user who owns the sub number order
          in: query
          name: filter[user_id]
          schema:
            example: d70873cd-7c98-401a-81b6-b1ae08246995
            format: uuid
            type: string
        - description: ID of the number order the sub number order belongs to
          in: query
          name: filter[order_request_id]
          schema:
            example: 12ade33a-21c0-473b-b055-b3c836e1c293
            format: uuid
            type: string
        - description: ISO alpha-2 country code.
          in: query
          name: filter[country_code]
          schema:
            example: US
            type: string
        - description: Phone Number Type
          in: query
          name: filter[phone_number_type]
          schema:
            example: local
            type: string
        - description: Amount of numbers in the sub number order
          in: query
          name: filter[phone_numbers_count]
          schema:
            example: 1
            type: integer
      responses:
        "200":
          $ref: "#/components/responses/ListSubNumberOrdersResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List sub number orders
      tags:
        - Number Orders
      x-group-parameters: "true"
      x-latency-category: responsive
  "/sub_number_orders/{sub_number_order_id}":
    get:
      description: Get an existing sub number order.
      operationId: retrieveSubNumberOrder
      parameters:
        - description: The sub number order ID.
          in: path
          name: sub_number_order_id
          required: true
          schema:
            type: string
        - description: Include the first 50 phone number objects in the results
          in: query
          name: filter[include_phone_numbers]
          required: false
          schema:
            default: false
            type: boolean
      responses:
        "200":
          $ref: "#/components/responses/SubNumberOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a sub number order
      tags:
        - Number Orders
      x-latency-category: responsive
    patch:
      description: Updates a sub number order.
      operationId: updateSubNumberOrder
      parameters:
        - description: The sub number order ID.
          in: path
          name: sub_number_order_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateSubNumberOrderRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/SubNumberOrderResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a sub number order
      tags:
        - Number Orders
      x-latency-category: responsive
  /telephony_credentials:
    get:
      description: List all On-demand Credentials.
      operationId: findTelephonyCredentials
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/OptionalTag"
        - $ref: "#/components/parameters/FilterName"
        - $ref: "#/components/parameters/FilterStatus"
        - $ref: "#/components/parameters/FilterResourceId"
        - $ref: "#/components/parameters/FilterSipUsername"
      responses:
        "200":
          $ref: "#/components/responses/GetAllTelephonyCredentialResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List all credentials
      tags:
        - Credentials
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Create a credential.
      operationId: CreateTelephonyCredential
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TelephonyCredentialCreateRequest"
        description: Parameters that can be defined during credential creation
        required: true
      responses:
        "201":
          $ref: "#/components/responses/TelephonyCredentialResponse"
        "422":
          description: Bad request
      summary: Create a credential
      tags:
        - Credentials
      x-latency-category: responsive
  /telephony_credentials/tags:
    get:
      description: Returns a list of tags used on Credentials
      operationId: listTags
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListTagsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List all tags
      tags:
        - Credentials
      x-latency-category: responsive
  "/telephony_credentials/{id}":
    delete:
      description: Delete an existing credential.
      operationId: DeleteTelephonyCredential
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/TelephonyCredentialResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Delete a credential
      tags:
        - Credentials
      x-latency-category: responsive
    get:
      description: Get the details of an existing On-demand Credential.
      operationId: getTelephonyCredential
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          $ref: "#/components/responses/TelephonyCredentialResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: Get a credential
      tags:
        - Credentials
      x-latency-category: responsive
    patch:
      description: Update an existing credential.
      operationId: UpdateTelephonyCredential
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TelephonyCredentialUpdateRequest"
        description: Parameters that can be updated in a credential
        required: true
      responses:
        "200":
          $ref: "#/components/responses/TelephonyCredentialResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Update a credential
      tags:
        - Credentials
      x-latency-category: responsive
  "/telephony_credentials/{id}/actions/{action}":
    post:
      description: Perform activate or deactivate action on provided Credential. Activate action will change the status to active, making it possible to connect calls with the credential. Deactivate action will change the status to inactive, making it impossible to connect calls with the credential.
      operationId: telephonyCredentialAction
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: Identifies the action to be taken.
          in: path
          name: action
          required: true
          schema:
            enum:
              - activate
              - deactivate
            type: string
      responses:
        "200":
          $ref: "#/components/responses/TelephonyCredentialResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: Perform activate or deactivate action on provided Credential
      tags:
        - Credentials
      x-latency-category: responsive
  "/telephony_credentials/{id}/token":
    post:
      description: Create an Access Token (JWT) for the credential.
      operationId: CreateTelephonyCredentialToken
      parameters:
        - description: Identifies the resource.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "201":
          content:
            text/plain:
              schema:
                example: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ
                type: string
          description: JWT
        "404":
          description: Resource not Found
      summary: Create an Access Token.
      tags:
        - Access Tokens
      x-latency-category: responsive
  /texml_applications:
    get:
      description: Returns a list of your TeXML Applications.
      operationId: findTexmlApplications
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
        - description: If present, applications with <code>friendly_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
          in: query
          name: filter[friendly_name][contains]
          schema:
            default: "null"
            type: string
        - $ref: "#/components/parameters/FilterOutboundVoiceProfileId"
        - $ref: "#/components/parameters/SortConnection"
      responses:
        "200":
          $ref: "#/components/responses/GetAllTexmlApplicationsResponse"
        "400":
          description: Bad request
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
      summary: List all TeXML Applications
      tags:
        - TeXML Applications
      x-endpoint-cost: medium
      x-latency-category: responsive
    post:
      description: Creates a TeXML Application.
      operationId: CreateTexmlApplication
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTexmlApplicationRequest"
        description: Parameters that can be set when creating a TeXML Application
        required: true
      responses:
        "201":
          $ref: "#/components/responses/TexmlApplicationResponse"
        "422":
          description: Bad request
      summary: Creates a TeXML Application
      tags:
        - TeXML Applications
      x-endpoint-cost: medium
      x-latency-category: responsive
  "/texml_applications/{id}":
    delete:
      description: Deletes a TeXML Application.
      operationId: DeleteTexmlApplication
      parameters:
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          $ref: "#/components/responses/TexmlApplicationResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Deletes a TeXML Application
      tags:
        - TeXML Applications
      x-latency-category: responsive
    get:
      description: Retrieves the details of an existing TeXML Application.
      operationId: getTexmlApplication
      parameters:
        - $ref: "#/components/parameters/id"
      responses:
        "200":
          $ref: "#/components/responses/TexmlApplicationResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Retrieve a TeXML Application
      tags:
        - TeXML Applications
      x-latency-category: responsive
    patch:
      description: Updates settings of an existing TeXML Application.
      operationId: UpdateTexmlApplication
      parameters:
        - $ref: "#/components/parameters/id"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateTexmlApplicationRequest"
        description: Parameters that can be updated in a TeXML Application
        required: true
      responses:
        "200":
          $ref: "#/components/responses/TexmlApplicationResponse"
        "401":
          description: Unauthorized
        "404":
          description: Resource not found
        "422":
          description: Bad request
      summary: Update a TeXML Application
      tags:
        - TeXML Applications
      x-latency-category: responsive
  "/verifications/by_phone_number/{phone_number}":
    get:
      operationId: listVerifications
      parameters:
        - description: The phone number associated with the verifications to retrieve.
          in: path
          name: phone_number
          required: true
          schema:
            description: +E164 formatted phone number.
            example: "+13035551234"
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListVerificationsResponse"
          description: Expected verifications response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List verifications by phone number
      tags:
        - Verify
      x-latency-category: responsive
  "/verifications/by_phone_number/{phone_number}/actions/verify":
    post:
      operationId: verifyVerificationCode
      parameters:
        - description: The phone number associated with the verification code being verified.
          in: path
          name: phone_number
          required: true
          schema:
            description: +E164 formatted phone number.
            example: "+13035551234"
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/VerifyVerificationCodeRequest"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VerifyVerificationCodeResponse"
          description: Expected verify response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Submit a verification code
      tags:
        - Verify
      x-latency-category: responsive
  /verifications/call:
    post:
      operationId: createVerificationCall
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateVerificationRequestCall"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateVerificationResponse"
          description: Expected verifications response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Trigger a Call verification
      tags:
        - Verify
      x-latency-category: responsive
  /verifications/flashcall:
    post:
      operationId: createVerificationFlashcall
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateVerificationRequestFlashcall"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateVerificationResponse"
          description: Expected verifications response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Trigger a Flash call verification
      tags:
        - Verify
      x-latency-category: responsive
  /verifications/psd2:
    post:
      operationId: createVerificationPSD2
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateVerificationRequestPSD2"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateVerificationResponse"
          description: Expected verifications response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Trigger a PSD2 verification
      tags:
        - Verify
      x-latency-category: responsive
  /verifications/sms:
    post:
      operationId: createVerificationSMS
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateVerificationRequestSMS"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateVerificationResponse"
          description: Expected verifications response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Trigger a SMS verification
      tags:
        - Verify
      x-latency-category: responsive
  /verifications/whatsapp:
    post:
      operationId: createVerificationWhatsapp
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateVerificationRequestWhatsapp"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreateVerificationResponse"
          description: Expected verifications response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Trigger a Whatsapp verification
      tags:
        - Verify
      x-latency-category: responsive
  "/verifications/{verification_id}":
    get:
      operationId: retrieveVerification
      parameters:
        - description: The identifier of the verification to retrieve.
          in: path
          name: verification_id
          required: true
          schema:
            example: 12ade33a-21c0-473b-b055-b3c836e1c292
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RetrieveVerificationResponse"
          description: Expected verifications response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a verification
      tags:
        - Verify
      x-latency-category: responsive
  /verify_profiles:
    get:
      description: Gets a paginated list of Verify profiles.
      operationId: listVerifyProfiles
      parameters:
        - in: query
          name: filter[name]
          required: false
          schema:
            description: Optional filter for profile names.
            title: filter[name]
            type: string
        - in: query
          name: page[size]
          required: false
          schema:
            default: 25
            title: page[size]
            type: integer
        - in: query
          name: page[number]
          required: false
          schema:
            default: 1
            title: page[number]
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ListVerifyProfilesResponse"
          description: Expected Verify profile response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: List all Verify profiles
      tags:
        - Verify
      x-group-parameters: "true"
      x-latency-category: responsive
    post:
      description: Creates a new Verify profile to associate verifications with.
      operationId: createVerifyProfile
      requestBody:
        content:
          application/json:
            schema:
              properties:
                call:
                  $ref: "#/components/schemas/CreateVerifyProfileCallRequest"
                  type: object
                flashcall:
                  $ref: "#/components/schemas/CreateVerifyProfileFlashcallRequest"
                  type: object
                language:
                  example: en-US
                  type: string
                name:
                  example: Test Profile
                  type: string
                psd2:
                  $ref: "#/components/schemas/CreateVerifyProfilePSD2Request"
                  type: object
                sms:
                  $ref: "#/components/schemas/CreateVerifyProfileSMSRequest"
                  type: object
                webhook_failover_url:
                  example: http://example.com/webhook/failover
                  type: string
                webhook_url:
                  example: http://example.com/webhook
                  type: string
                whatsapp:
                  $ref: "#/components/schemas/CreateVerifyProfileWhatsappRequest"
                  type: object
              required:
                - name
              title: Create Verify Profile Request
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VerifyProfileResponseDataWrapper"
          description: Expected Verify profile response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a Verify profile
      tags:
        - Verify
      x-latency-category: responsive
  "/verify_profiles/{verify_profile_id}":
    delete:
      operationId: deleteVerifyProfile
      parameters:
        - description: The identifier of the Verify profile to delete.
          in: path
          name: verify_profile_id
          required: true
          schema:
            example: 12ade33a-21c0-473b-b055-b3c836e1c292
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VerifyProfileResponseDataWrapper"
          description: Expected Verify profile response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a Verify profile
      tags:
        - Verify
      x-latency-category: responsive
    get:
      description: Gets a single Verify profile.
      operationId: retrieveVerifyProfile
      parameters:
        - description: The identifier of the Verify profile to retrieve.
          in: path
          name: verify_profile_id
          required: true
          schema:
            example: 12ade33a-21c0-473b-b055-b3c836e1c292
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VerifyProfileResponseDataWrapper"
          description: Expected Verify profile response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Retrieve a Verify profile
      tags:
        - Verify
      x-latency-category: responsive
    patch:
      operationId: updateVerifyProfile
      parameters:
        - description: The identifier of the Verify profile to update.
          in: path
          name: verify_profile_id
          required: true
          schema:
            example: 12ade33a-21c0-473b-b055-b3c836e1c292
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                call:
                  $ref: "#/components/schemas/UpdateVerifyProfileCallRequest"
                  type: object
                flashcall:
                  $ref: "#/components/schemas/UpdateVerifyProfileFlashcallRequest"
                  type: object
                language:
                  example: en-US
                  type: string
                name:
                  example: Test Profile
                  type: string
                psd2:
                  $ref: "#/components/schemas/UpdateVerifyProfilePSD2Request"
                  type: object
                sms:
                  $ref: "#/components/schemas/UpdateVerifyProfileSMSRequest"
                  type: object
                webhook_failover_url:
                  example: http://example.com/webhook/failover
                  type: string
                webhook_url:
                  example: http://example.com/webhook
                  type: string
                whatsapp:
                  $ref: "#/components/schemas/UpdateVerifyProfileWhatsappRequest"
                  type: object
              title: Update Verify Profile Request
              type: object
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VerifyProfileResponseDataWrapper"
          description: Expected Verify profile response to a valid request.
        "400":
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update a Verify profile
      tags:
        - Verify
      x-latency-category: responsive
  /webhook_deliveries:
    get:
      description: Lists webhook_deliveries for the authenticated user
      operationId: getWebhookDeliveries
      parameters:
        - description: Return only webhook_deliveries matching the given `status`
          in: query
          name: filter[status][eq]
          required: false
          schema:
            enum:
              - delivered
              - failed
            example: delivered
            type: string
        - description: Return only webhook deliveries whose `webhook` component contains the given text
          in: query
          name: filter[webhook][contains]
          required: false
          schema:
            example: call.initiated
            type: string
        - description: Return only webhook_deliveries whose `attempts` component contains the given text
          in: query
          name: filter[attempts][contains]
          required: false
          schema:
            example: https://fallback.example.com/webhooks
            type: string
        - description: Return only webhook_deliveries whose delivery started later than or at given ISO 8601 datetime
          in: query
          name: filter[started_at][gte]
          required: false
          schema:
            example: 2019-03-29T11:10:00Z
            type: string
        - description: Return only webhook_deliveries whose delivery started earlier than or at given ISO 8601 datetime
          in: query
          name: filter[started_at][lte]
          required: false
          schema:
            example: 2019-03-29T11:10:00Z
            type: string
        - description: Return only webhook_deliveries whose delivery finished later than or at given ISO 8601 datetime
          in: query
          name: filter[finished_at][gte]
          required: false
          schema:
            example: 2019-03-29T11:10:00Z
            type: string
        - description: Return only webhook_deliveries whose delivery finished earlier than or at given ISO 8601 datetime
          in: query
          name: filter[finished_at][lte]
          required: false
          schema:
            example: 2019-03-29T11:10:00Z
            type: string
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/ListWebhookDeliveriesResponse"
        "401":
          description: Unauthorized
        "422":
          description: Unprocessable entity
      summary: List webhook deliveries
      tags:
        - Webhooks
      x-latency-category: responsive
  "/webhook_deliveries/{id}":
    get:
      description: Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.
      operationId: getWebhookDelivery
      parameters:
        - description: Uniquely identifies the webhook_delivery.
          in: path
          name: id
          required: true
          schema:
            example: C9C0797E-901D-4349-A33C-C2C8F31A92C2
            format: uuid
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: "#/components/schemas/webhook_delivery"
                type: object
          description: Webhook delivery record.
        "401":
          description: Unauthorized
        "404":
          description: WebhookDelivery not found
      summary: Find webhook_delivery details by ID
      tags:
        - Webhooks
      x-latency-category: responsive
  /whatsapp_contacts:
    post:
      deprecated: false
      description: Verify that a phone number belongs to a valid WhatsApp account. You must ensure that the status is valid before you can message a user, and you'll get their WhatsApp ID to use for messaging.
      operationId: checkContact
      requestBody:
        content:
          application/json:
            example:
              blocking: wait
              contacts:
                - "15125551000"
                - +1 512 555 1001
                - "5125551002"
                - +1 (512) 555-1004
                - 1-512-555-1005
              whatsapp_user_id: "15125551212"
            schema:
              $ref: "#/components/schemas/CheckContactRequestBody"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/CheckContactResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Check Contact
      tags:
        - WhatsApp Contacts
      x-latency-category: responsive
  /whatsapp_detail_record_reports:
    get:
      description: "Fetch all previous requests for WhatsApp detail reports. WhatsApp detail reports are reports for pulling all WhatsApp records. "
      operationId: getRequests
      parameters:
        - description: Page number
          in: query
          name: page[number]
          schema:
            default: 1
            format: int32
            type: integer
        - description: Size of the page
          in: query
          name: page[size]
          schema:
            default: 20
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WhatsAppGetAllDetailReportResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - WhatsApp Detail Reports
      x-latency-category: interactive
    post:
      description: Submit a request for new WhatsApp detail report. WhatsApp detail report pulls all raw WhatsApp data according to defined filters.
      operationId: submitRequest
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WhatsAppReportsReq"
        description: WhatsApp detail request data
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WhatsAppDetailReportResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - WhatsApp Detail Reports
      x-latency-category: background
  "/whatsapp_detail_record_reports/{id}":
    delete:
      description: Delete generated WhatsApp detail report by id
      operationId: deleteRequest
      parameters:
        - content:
            "*/*":
              schema:
                format: uuid
                type: string
          in: path
          name: id
          required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WhatsAppDetailReportResponse"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - WhatsApp Detail Reports
      x-latency-category: interactive
    get:
      description: Fetch single whatsapp detail report by id.
      operationId: getRequest
      parameters:
        - content:
            "*/*":
              schema:
                format: uuid
                type: string
          in: path
          name: id
          required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WhatsAppDetailReportResponse"
          description: Successful
        "404":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
          description: Resource not found
      security:
        - bearerAuth: []
      tags:
        - WhatsApp Detail Reports
      x-latency-category: interactive
  /whatsapp_media:
    post:
      deprecated: false
      description: Upload media. Accepted media types include image/jpeg, image/png, video/mp4, video/3gpp, audio/aac, audio/ogg.
      operationId: uploadMedia
      requestBody:
        content:
          multipart/form-data:
            example:
              media_content_type: image/jpeg
              upload_file: string($binary)
              whatsapp_user_id: "15125551212"
            schema:
              $ref: "#/components/schemas/MediaRequestBody"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/UploadMediaResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Upload Media
      tags:
        - WhatsApp Media
      x-latency-category: responsive
  "/whatsapp_media/{whatsapp_user_id}/{media_id}":
    delete:
      deprecated: false
      description: Delete uploaded media.
      parameters:
        - description: User's WhatsApp ID
          explode: false
          in: path
          name: whatsapp_user_id
          required: true
          schema:
            type: string
          style: simple
        - description: WhatsApp's Media ID
          explode: false
          in: path
          name: media_id
          required: true
          schema:
            type: string
          style: simple
      responses:
        "204":
          description: Request successful, empty response body.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete Media
      tags:
        - WhatsApp Media
      x-latency-category: responsive
    get:
      deprecated: false
      description: Retrieve uploaded media. Media is typically available for 30 days after uploading.
      parameters:
        - description: User's WhatsApp ID
          explode: false
          in: path
          name: whatsapp_user_id
          required: true
          schema:
            type: string
          style: simple
        - description: WhatsApp's Media ID
          explode: false
          in: path
          name: media_id
          required: true
          schema:
            type: string
          style: simple
      responses:
        "200":
          $ref: "#/components/responses/UploadedMediaResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Download Media
      tags:
        - WhatsApp Media
      x-latency-category: responsive
  /whatsapp_messages:
    post:
      deprecated: false
      description: Send text messages, media/documents, and message templates to your customers.
      operationId: sendMessage
      requestBody:
        content:
          application/json:
            example:
              text:
                body: <Message Text>
              to: "15125558989"
              type: text
              whatsapp_user_id: "15125551212"
            schema:
              $ref: "#/components/schemas/CreateWhatsAppMessageRequest"
        required: true
      responses:
        "200":
          $ref: "#/components/responses/WhatsAppMessageResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Send Message
      tags:
        - WhatsApp Messages
      x-latency-category: responsive
  "/whatsapp_messages/{message_id}":
    patch:
      deprecated: false
      description: Mark a message as read.
      operationId: markMessageAsRead
      parameters:
        - description: Message ID from Webhook
          in: path
          name: message_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            example:
              status: read
              whatsapp_user_id: "15125551212"
            schema:
              $ref: "#/components/schemas/MarkMessageAsReadRequestBody"
        required: true
      responses:
        "204":
          description: Request successful, empty response body.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Mark Message As Read
      tags:
        - WhatsApp Messages
      x-latency-category: responsive
  /whatsapp_usage_aggregations:
    get:
      description: "Generate and fetch WhatsApp usage aggregations synchronously. This endpoint will both generate and fetch the WhatsApp aggregations over a specified time period. "
      operationId: getUsageAggregationsSync
      parameters:
        - in: query
          name: start_date
          schema:
            example: 2020-07-01T00:00:00-06:00
            format: date-time
            type: string
        - in: query
          name: end_date
          schema:
            example: 2020-07-01T00:00:00-06:00
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WhatsAppUsageAggregationsResponseContainer"
          description: Successful
      security:
        - bearerAuth: []
      tags:
        - WhatsApp Usage Aggregations
      x-latency-category: background
  "/whatsapp_users/{whatsapp_user_id}":
    get:
      deprecated: false
      description: Retrieve WhatsApp user information.
      operationId: getUser
      parameters:
        - description: User's WhatsApp ID
          explode: false
          in: path
          name: whatsapp_user_id
          required: true
          schema:
            type: string
          style: simple
      responses:
        "200":
          $ref: "#/components/responses/WhatsAppUserResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get User
      tags:
        - WhatsApp Users
      x-latency-category: responsive
    patch:
      description: Update webhook URL used for a given WhatsApp user.
      operationId: updateWhatsAppWebhook
      parameters:
        - description: User's WhatsApp ID
          explode: false
          in: path
          name: whatsapp_user_id
          required: true
          schema:
            type: string
          style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateUserRequest"
        required: true
      responses:
        "204":
          description: Request successful, empty response body.
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Update WhatsApp User
      tags:
        - WhatsApp Users
      x-latency-category: responsive
  /wireless/detail_records_reports:
    get:
      description: Returns the WDR Reports that match the given parameters.
      operationId: getWdrReports
      parameters:
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/PageSize"
      responses:
        "200":
          $ref: "#/components/responses/GetWdrReportsResponse"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get all Wireless Detail Records (WDRs) Reports
      tags:
        - Reporting
      x-latency-category: background
    post:
      description: |
        Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.
      operationId: createWdrReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WdrReportRequest"
        required: true
      responses:
        "201":
          $ref: "#/components/responses/CreateWdrReportResponse"
        "422":
          $ref: "#/components/responses/UnprocessableEntity"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Create a Wireless Detail Records (WDRs) Report
      tags:
        - Reporting
      x-latency-category: background
  "/wireless/detail_records_reports/{id}":
    delete:
      description: Deletes one specific WDR report
      operationId: deleteWdrReport
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/DeleteWdrReportResponse"
        "404":
          $ref: "#/components/responses/ResourceNotFound"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Delete a Wireless Detail Record (WDR) Report
      tags:
        - Reporting
      x-latency-category: background
    get:
      description: Returns one specific WDR report
      operationId: getWdrReport
      parameters:
        - $ref: "#/components/parameters/ResourceId"
      responses:
        "200":
          $ref: "#/components/responses/GetWdrReportResponse"
        "404":
          $ref: "#/components/responses/ResourceNotFound"
        default:
          $ref: "#/components/responses/GenericErrorResponse"
      summary: Get a Wireless Detail Record (WDR) Report
      tags:
        - Reporting
      x-latency-category: background
components:
  callbacks: {}
  examples: {}
  headers: {}
  links: {}
  parameters:
    AssociatedRecordType:
      description: Filter by the associated record type
      in: query
      name: filter[associated_record_type][eq]
      schema:
        enum:
          - account
          - phone_number
        example: phone_number
        type: string
    BillingGroupId:
      description: The id of the billing group
      in: path
      name: id
      required: true
      schema:
        format: uuid
        type: string
    CallControlId:
      description: Unique identifier and token for controlling the call
      in: path
      name: call_control_id
      required: true
      schema:
        type: string
    ChannelTypeId:
      description: Filter by the id of a channel type
      in: query
      name: filter[channel_type_id][eq]
      schema:
        enum:
          - webhook
          - sms
          - email
          - voice
        example: webhook
        type: string
    DocReqsActionFilter:
      description: Filters requirements to those applying to a specific action.
      in: query
      name: filter[action]
      schema:
        enum:
          - ordering
          - porting
        example: porting
        type: string
    DocReqsCountryFilter:
      description: Filters results to those applying to a 2-character (ISO 3166-1 alpha-2) country code
      in: query
      name: filter[country_code]
      schema:
        example: US
        type: string
    DocReqsPhoneNumberTypeFilter:
      description: Filters results to those applying to a specific `phone_number_type`
      in: query
      name: filter[phone_number_type]
      schema:
        enum:
          - local
          - national
          - toll-free
        example: local
        type: string
    DocReqsRequirementId:
      description: Uniquely identifies the requirement_type record
      example: a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa
      in: path
      name: id
      required: true
      schema:
        format: uuid
        type: string
    DocReqsRequirementTypeId:
      description: Uniquely identifies the requirement_type record
      example: a38c217a-8019-48f8-bff6-0fdd9939075b
      in: path
      name: id
      required: true
      schema:
        format: uuid
        type: string
    DocReqsRequirementTypeNameFilter:
      description: Filters requirement types to those whose name contains a certain string.
      in: query
      name: filter[name][contains]
      schema:
        example: utility bill
        type: string
    DocReqsRequirementTypesSort:
      description: Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a `-` in front of the field name.
      in: query
      name: sort[]
      required: false
      schema:
        enum:
          - created_at
          - name
          - updated_at
        example: country_code
        type: string
    DocReqsRequirementsSort:
      description: Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a `-` in front of the field name.
      in: query
      name: sort[]
      required: false
      schema:
        enum:
          - action
          - country_code
          - locality
          - phone_number_type
        example: country_code
        type: string
    DocServiceDocumentIdFilter:
      description: Identifies the associated document to filter on.
      in: query
      name: filter[document_id]
      schema:
        example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        format: uuid
        type: string
    FilterAddressBook:
      description: If present, only returns results with the <code>address_book</code> flag set to the given value.
      in: query
      name: filter[address_book][eq]
      required: false
      schema:
        default: "null"
        type: string
    FilterAddressByAdministrativeArea:
      description: Filter by state or province where the address is located.
      in: query
      name: filter[address.administrative_area]
      schema:
        example: IL
        type: string
    FilterAddressByCountryCode:
      description: Filter by the mobile operator two-character (ISO 3166-1 alpha-2) origin country code.
      in: query
      name: filter[address.country_code]
      schema:
        example: US
        type: string
    FilterAddressByExtendedAddress:
      description: Returns entries with matching name of the supplemental field for address information.
      in: query
      name: filter[address.extended_address]
      schema:
        example: Suite 504
        type: string
    FilterAddressById:
      description: Uniquely identifies the address for the order.
      in: query
      name: filter[address.id]
      schema:
        example: "1293384261075731499"
        format: int64
        type: string
    FilterAddressByLocality:
      description: Filter by the name of the city where the address is located.
      in: query
      name: filter[address.locality]
      schema:
        example: Chicago
        type: string
    FilterAddressByPostalCode:
      description: Filter by postal code for the address.
      in: query
      name: filter[address.postal_code]
      schema:
        example: "60654"
        type: string
    FilterAddressByStreetAddress:
      description: Returns entries with matching name of the street where the address is located.
      in: query
      name: filter[address.street_address]
      schema:
        example: 311 W Superior St
        type: string
    FilterApplicationName:
      description: If present, applications with <code>application_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
      in: query
      name: filter[application_name][contains]
      schema:
        default: "null"
        type: string
    FilterBasicStatusLifecycle:
      description: Filter by a specific status of the resource's lifecycle.
      in: query
      name: filter[status]
      required: false
      schema:
        enum:
          - in-progress
          - completed
          - failed
        example: in-progress
        type: string
    FilterByActivationStatus:
      description: Filter results by activation status
      in: query
      name: filter[activation_status]
      schema:
        $ref: "#/components/schemas/ActivationStatus"
    FilterByPhoneNumber:
      description: Filter results by phone number
      in: query
      name: filter[phone_number]
      schema:
        type: string
    FilterByPortabilityStatus:
      description: Filter results by portability status
      in: query
      name: filter[portability_status]
      schema:
        $ref: "#/components/schemas/PortabilityStatus"
    FilterByPortingOrderID:
      description: Filter results by porting order id
      in: query
      name: filter[porting_order_id]
      schema:
        format: uuid
        type: string
    FilterByPortingOrderStatus:
      description: Filter results by status
      in: query
      name: filter[status]
      schema:
        $ref: "#/components/schemas/PortingOrderStatus"
    FilterCallEventStatus:
      description: Event status
      in: query
      name: filter[status]
      required: false
      schema:
        enum:
          - delivered
          - failed
        example: delivered
        type: string
    FilterCallEventTimestampEqualTo:
      description: "Event timestamp: equal"
      in: query
      name: filter[event_timestamp][eq]
      required: false
      schema:
        example: 2019-03-29T11:10:00Z
        type: string
    FilterCallEventTimestampGreaterThan:
      description: "Event timestamp: greater than"
      in: query
      name: filter[event_timestamp][gt]
      required: false
      schema:
        example: 2019-03-29T11:10:00Z
        type: string
    FilterCallEventTimestampGreaterThanOrEqualTo:
      description: "Event timestamp: greater than or equal"
      in: query
      name: filter[event_timestamp][gte]
      required: false
      schema:
        example: 2019-03-29T11:10:00Z
        type: string
    FilterCallEventTimestampLessThan:
      description: "Event timestamp: lower than"
      in: query
      name: filter[event_timestamp][lt]
      required: false
      schema:
        example: 2019-03-29T11:10:00Z
        type: string
    FilterCallEventTimestampLessThanOrEqualTo:
      description: "Event timestamp: lower than or equal"
      in: query
      name: filter[event_timestamp][lte]
      required: false
      schema:
        example: 2019-03-29T11:10:00Z
        type: string
    FilterCallEventType:
      description: Event type
      in: query
      name: filter[type]
      required: false
      schema:
        enum:
          - command
          - webhook
        example: webhook
        type: string
    FilterCallLegId:
      description: The unique identifier of an individual call leg.
      in: query
      name: filter[call_leg_id]
      required: false
      schema:
        format: uuid
        type: string
    FilterCallSessionId:
      description: The unique identifier of the call control session. A session may include multiple call leg events.
      in: query
      name: filter[call_session_id]
      required: false
      schema:
        format: uuid
        type: string
    FilterConferenceName:
      description: If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive
      in: query
      name: filter[name]
      schema:
        type: string
    FilterConnectionName:
      description: If present, connections with <code>connection_name</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
      in: query
      name: filter[connection_name][contains]
      schema:
        default: null
        type: string
    FilterCostByAmount:
      description: The total monetary amount of the order.
      in: query
      name: filter[cost.amount]
      schema:
        example: "2.53"
        type: string
    FilterCostByCurrency:
      description: Filter by ISO 4217 currency string.
      in: query
      name: filter[cost.currency]
      schema:
        example: USD
        type: string
    FilterCreatedAt:
      description: Filter by ISO 8601 formatted date-time string matching resource creation date-time.
      in: query
      name: filter[created_at]
      schema:
        example: 2018-02-02T22:25:27.521Z
        format: datetime
        type: string
    FilterCustomerReferenceContains:
      description: If present, addresses with <code>customer_reference</code> containing the given value will be returned. Matching is not case-sensitive.
      in: query
      name: filter[customer_reference][contains]
      required: false
      schema:
        type: string
    FilterCustomerReferenceEquals:
      description: Filter addresses via the customer reference set. Matching is not case-sensitive.
      in: query
      name: filter[customer_reference][eq]
      required: false
      schema:
        type: string
    FilterEmailContains:
      description: If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
      in: query
      name: filter[email][contains]
      required: false
      schema:
        default: "null"
        type: string
    FilterEmailEq:
      description: If present, only returns results with the <code>email</code> matching exactly the value given.
      in: query
      name: filter[email][eq]
      required: false
      schema:
        default: "null"
        type: string
    FilterInnerOutboundVoiceProfileId:
      description: Identifies the associated outbound voice profile.
      in: query
      name: filter[outbound.outbound_voice_profile_id]
      schema:
        example: "1293384261075731499"
        format: int64
        type: string
    FilterName:
      description: Filter by name
      in: query
      name: filter[name]
      schema:
        type: string
    FilterOutboundVoiceProfileId:
      description: Identifies the associated outbound voice profile.
      in: query
      name: filter[outbound_voice_profile_id]
      schema:
        example: "1293384261075731499"
        format: int64
        type: string
    FilterQuantity:
      description: Filter orders by how many SIM cards were ordered.
      in: query
      name: filter[quantity]
      schema:
        example: 21
        type: integer
    FilterQuantityLessThan:
      description: Returns orders with <code>quantity</code> lower than the specified argument.
      in: query
      name: filter[quantity][lt]
      schema:
        example: 21
        type: integer
    FilterResourceId:
      description: Filter by resource_id
      in: query
      name: filter[resource_id]
      schema:
        type: string
    FilterSIMCardGroupId:
      description: A valid SIM card group ID.
      in: query
      name: filter[sim_card_group_id]
      schema:
        example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9
        format: uuid
        type: string
    FilterSipUsername:
      description: Filter by sip_username
      in: query
      name: filter[sip_username]
      schema:
        type: string
    FilterStatus:
      description: Filter by status
      in: query
      name: filter[status]
      schema:
        type: string
    FilterStreetAddress:
      description: If present, addresses with <code>street_address</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.
      in: query
      name: filter[street_address][contains]
      required: false
      schema:
        default: "null"
        type: string
    FilterUpdatedAt:
      description: Filter by ISO 8601 formatted date-time string matching resource last update date-time.
      in: query
      name: filter[updated_at]
      schema:
        example: 2018-02-02T22:25:27.521Z
        format: datetime
        type: string
    FilterUsedAsEmergency:
      description: "If set as 'true', only addresses used as the emergency address for at least one active phone-number will be returned. When set to 'false', the opposite happens: only addresses not used as the emergency address from phone-numbers will be returned."
      in: query
      name: filter[used_as_emergency]
      required: false
      schema:
        default: "null"
        type: string
    FqdnId:
      description: Identifies the resource.
      in: path
      name: id
      required: true
      schema:
        example: "1517907029795014409"
        format: int64
        type: string
    Id:
      description: The id of the resource.
      in: path
      name: id
      required: true
      schema:
        format: uuid
        type: string
    IncludeOTAUpdates:
      description: It includes the associated OTA update objects in the response when present.
      in: query
      name: include_ota_updates
      schema:
        default: false
        example: true
        type: boolean
    IncludeSIMCardGroup:
      description: It includes the associated SIM card group object in the response when present.
      in: query
      name: include_sim_card_group
      schema:
        default: false
        example: true
        type: boolean
    IntId:
      description: Identifies the resource.
      in: path
      name: id
      required: true
      schema:
        example: "1293384261075731499"
        format: int64
        type: string
    IpId:
      description: Identifies the type of resource.
      in: path
      name: id
      required: true
      schema:
        example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        format: uuid
        type: string
    LedgerBillingGroupReportId:
      description: The id of the ledger billing group report
      in: path
      name: id
      required: true
      schema:
        format: uuid
        type: string
    LinkedRecordTypeFilter:
      description: The `linked_record_type` of the document to filter on.
      in: query
      name: filter[linked_record_type]
      schema:
        example: porting_order
        type: string
    LinkedResourceIdFilter:
      description: The `linked_resource_id` of the document to filter on.
      in: query
      name: filter[linked_resource_id]
      schema:
        example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        format: uuid
        type: string
    MediaName:
      description: Uniquely identifies a media resource.
      in: path
      name: media_name
      required: true
      schema:
        type: string
    MessagingProfileId:
      description: The id of the messaging profile to retrieve
      in: path
      name: id
      required: true
      schema:
        format: uuid
        type: string
    MessagingProfileMetric:
      description: The id of the messaging profile(s) to retrieve
      in: query
      name: id
      required: false
      schema:
        format: uuid
        type: string
    MessagingProfileMetricTimeFrame:
      description: The timeframe for which you'd like to retrieve metrics.
      in: query
      name: time_frame
      required: false
      schema:
        default: 24h
        enum:
          - 1h
          - 3h
          - 24h
          - 3d
          - 7d
          - 30d
        type: string
    NameFilter:
      description: Optional filter on outbound voice profile name.
      in: query
      name: filter[name][contains]
      schema:
        example: office-profile
        type: string
    NotificationChannelId:
      description: Filter by the id of a notification channel
      in: query
      name: filter[notification_channel][eq]
      schema:
        example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
        type: string
    NotificationEventConditionId:
      description: Filter by the id of a notification channel
      in: query
      name: filter[notification_event_condition_id][eq]
      schema:
        example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
        type: string
    NotificationProfileId:
      description: Filter by the id of a notification profile
      in: query
      name: filter[notification_profile_id][eq]
      schema:
        example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
        type: string
    NumberLookupType:
      description: Specifies the type of number lookup to be performed
      in: query
      name: type
      required: false
      schema:
        enum:
          - carrier
          - caller-name
        type: string
    OptionalTag:
      description: Filter by tag
      in: query
      name: filter[tag]
      schema:
        type: string
    PageNumber:
      description: The page number to load.
      in: query
      name: page[number]
      schema:
        default: 1
        minimum: 1
        type: integer
    PageSize:
      description: The size of the page.
      in: query
      name: page[size]
      schema:
        default: 20
        maximum: 250
        minimum: 1
        type: integer
    PathCommentID:
      description: Comment id
      in: path
      name: id
      required: true
      schema:
        type: string
    PathPhoneNumber:
      description: Phone number
      in: path
      name: phone_number
      required: true
      schema:
        type: string
    PathPortingOrderID:
      description: Porting Order id
      in: path
      name: id
      required: true
      schema:
        format: uuid
        type: string
    PathPortingOrdersActivationJobID:
      description: Activation Job Identifier
      in: path
      name: activationJobId
      required: true
      schema:
        format: uuid
        type: string
    PhoneNumber:
      description: The phone number to be looked up
      in: path
      name: phone_number
      required: true
      schema:
        example: "+18665552368"
        type: string
    QueryIncludePhoneNumbers:
      description: Include the first 50 phone number objects in the results
      in: query
      name: include_phone_numbers
      required: false
      schema:
        default: true
        type: boolean
    RequiredTag:
      description: Filter by tag, required by bulk operations.
      in: query
      name: filter[tag]
      required: true
      schema:
        type: string
    ResourceId:
      description: Identifies the resource.
      in: path
      name: id
      required: true
      schema:
        example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        format: uuid
        type: string
    SIMCardId:
      description: Identifies a SIM card.
      in: path
      name: sim_card_id
      required: true
      schema:
        example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        format: uuid
        type: string
    ShortCodeId:
      description: The id of the short code
      in: path
      name: id
      required: true
      schema:
        format: uuid
        type: string
    Sort:
      description: |-
        Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/>
        That is: <ul>
          <li>
            <code>email</code>: sorts the result by the
            <code>email</code> field in ascending order.
          </li>

          <li>
            <code>-email</code>: sorts the result by the
            <code>email</code> field in descending order.
          </li>
        </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
      in: query
      name: sort
      required: false
      schema:
        default: created_at
        enum:
          - created_at
          - email
        example: email
        type: string
    SortAddress:
      description: |-
        Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/>
        That is: <ul>
          <li>
            <code>street_address</code>: sorts the result by the
            <code>street_address</code> field in ascending order.
          </li>

          <li>
            <code>-street_address</code>: sorts the result by the
            <code>street_address</code> field in descending order.
          </li>
        </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
      in: query
      name: sort
      required: false
      schema:
        default: created_at
        enum:
          - created_at
          - first_name
          - last_name
          - business_name
          - street_address
        example: street_address
        type: string
    SortAuthenticationProvider:
      description: |-
        Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/>
        That is: <ul>
          <li>
            <code>name</code>: sorts the result by the
            <code>name</code> field in ascending order.
          </li>

          <li>
            <code>-name</code>: sorts the result by the
            <code>name</code> field in descending order.
          </li>
        </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
      in: query
      name: sort
      required: false
      schema:
        default: -created_at
        enum:
          - name
          - -name
          - short_name
          - -short_name
          - active
          - -active
          - created_at
          - -created_at
          - updated_at
          - -updated_at
        example: name
        type: string
    SortConnection:
      description: |-
        Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code> -</code> prefix.<br/><br/>
        That is: <ul>
          <li>
            <code>connection_name</code>: sorts the result by the
            <code>connection_name</code> field in ascending order.
          </li>

          <li>
            <code>-connection_name</code>: sorts the result by the
            <code>connection_name</code> field in descending order.
          </li>
        </ul> <br/> If not given, results are sorted by <code>created_at</code> in descending order.
      in: query
      name: sort
      schema:
        default: created_at
        enum:
          - created_at
          - connection_name
          - active
        example: connection_name
        type: string
    SortOutboundVoiceProfile:
      description: |-
        Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the <code>-</code> prefix.<br/><br/>
        That is: <ul>
          <li>
            <code>name</code>: sorts the result by the
            <code>name</code> field in ascending order.
          </li>

          <li>
            <code>-name</code>: sorts the result by the
            <code>name</code> field in descending order.
          </li>
        </ul> <br/>
      in: query
      name: sort
      schema:
        default: -created_at
        enum:
          - enabled
          - -enabled
          - created_at
          - -created_at
          - name
          - -name
          - service_plan
          - -service_plan
          - traffic_type
          - -traffic_type
          - usage_payment_method
          - -usage_payment_method
        example: name
        type: string
    Status:
      description: The status of a notification setting
      in: query
      name: filter[status][eq]
      schema:
        enum:
          - enabled
          - enable-received
          - enable-pending
          - enable-submtited
          - delete-received
          - delete-pending
          - delete-submitted
          - deleted
        example: enable-received
        type: string
    id:
      description: Identifies the resource.
      in: path
      name: id
      required: true
      schema:
        example: "1293384261075731499"
        format: int64
        type: string
  requestBodies: {}
  responses:
    AddressResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Address"
            type: object
      description: Successful response
    AuthenticationProviderResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/AuthenticationProvider"
            type: object
      description: Successful response
    BulkCredentialResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                properties:
                  credentials:
                    description: Amount of credentials affected
                    example: 0
                    type: integer
                type: object
            title: Bulk Credential Response
            type: object
      description: Successful response for Bulk credential requests
    BulkSIMCardNetworkPreferenceResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                description: Multi requested SIM cards network preferences.
                items:
                  $ref: "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates"
                type: array
              errors:
                items:
                  $ref: "#/components/schemas/Error"
                type: array
            type: object
      description: ""
    BulkUploadDocServiceDocumentsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/DocServiceDocument"
                type: array
            type: object
      description: Successful response
    CallControlApplicationResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/CallControlApplication"
            title: Call Control Application Response
            type: object
      description: Successful response with details about a call control application.
    CallControlCommandResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/CallControlCommandResult"
            title: Call Control Command Response
            type: object
      description: Successful response upon making a call control command.
    CheckContactResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/CheckContact"
                type: array
            title: Check Contact Response
            type: object
      description: Successful response with details about WhatsApp contact(s).
    CommentResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                allOf:
                  - $ref: "#/components/schemas/Comment"
                  - type: object
            type: object
      description: A Comment Response
    ConferenceCommandResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/ConferenceCommandResult"
            title: Conference Command Response
            type: object
      description: Successful response upon making a conference command.
    ConferenceResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Conference"
            title: Conference Response
            type: object
      description: Successful response with details about a conference.
    ConnectionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Connection"
            title: Connection Response
            type: object
      description: Successful response with details about a connection.
    CreateBillingGroupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/BillingGroup"
            type: object
      description: Expected billing group response to a valid request
    CreateLedgerBillingGroupReportResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/LedgerBillingGroupReport"
            type: object
      description: Expected ledger billing group report response to a valid request
    CreatePrivateWirelessGatewayResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PrivateWirelessGateway"
            type: object
      description: Successful response
    CreateRoomClientTokenResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                example:
                  refresh_token: eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDkzNzA1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6ImQ3OWJlMzhjLWFkNTQtNGQ5ZC1hODc4LWExNjVjNTk0MGQwNyIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6InJlZnJlc2gifQ.FHsp7KlVXn1E5tTUiKZzmQ4of39gi57AakeQeqI0oAa8hzjFMVb0RGj-mxWTvHVen4GpgsUW_epqqaxK16viCA
                  refresh_token_expires_at: 2021-04-22T12:15:05Z
                  token: eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA
                  token_expires_at: 2021-04-22T12:24:55Z
                properties:
                  refresh_token:
                    example: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ
                    format: jwt
                    type: string
                  refresh_token_expires_at:
                    description: ISO 8601 timestamp when the refresh token expires.
                    example: 2021-03-26T17:51:59Z
                    format: datetime
                    type: string
                  token:
                    example: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ
                    format: jwt
                    type: string
                  token_expires_at:
                    description: ISO 8601 timestamp when the token expires.
                    example: 2021-03-26T17:51:59Z
                    format: datetime
                    type: string
                type: object
            type: object
      description: Create room client token response.
    CreateRoomResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Room"
            type: object
      description: Create room response.
    CreateSimCardGroupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardGroup"
            type: object
      description: Successful Response
    CreateSimCardOrderResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardOrder"
            type: object
      description: Successful Response
    CreateWdrReportResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/WdrReport"
            type: object
      description: Successful response
    CredentialConnectionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/CredentialConnection"
            title: Credential Connection Response
            type: object
      description: Successful response with details about a credential connection.
    CsvDownloadResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/CsvDownload"
                type: array
            title: CSV Download Response
            type: object
      description: Successful response with details about a CSV download.
    DELETESIMCardNetworkPreferenceResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates"
            type: object
      description: |-
        A successful network preferences deletion response. <br/><br/>
        The delete won't be done right away - this is an asynchronous operation. The request will return the resource with an in-progress OTA update resource (in the ota_updates node) representing the delete operation. Similarly to the PUT API, the resource will only be deleted when the OTA updated is successfully completed.
    DecommissionedSIMCardPublicIPResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardPublicIP"
            type: object
      description: A successful and synchronous decommission of a public IP. This response happens when no further processing is required. Therefore, a new public IP can be requested right away.
    DeleteBillingGroupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/BillingGroup"
            type: object
      description: Expected billing group response to a valid request
    DeletePhoneNumberResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PhoneNumberDeletedDetailed"
            title: Phone Number Response
            type: object
      description: Successful response with details about a phone number.
    DeletePrivateWirelessGatewayResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PrivateWirelessGateway"
            type: object
      description: Successful response
    DeleteSimCardGroupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardGroup"
            type: object
      description: Successful Response
    DeleteSimCardResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCard"
            type: object
      description: Successful response
    DeleteWdrReportResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/WdrReport"
            type: object
      description: Successful response
    DocReqsListRequirementTypesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/DocReqsRequirementTypeList"
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    DocReqsRequirementResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/DocReqsRequirement"
            type: object
      description: Successful response
    DocReqsRequirementTypeResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/DocReqsRequirementType"
            type: object
      description: Successful response
    DocServiceDocumentResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/DocServiceDocument"
            type: object
      description: Successful response
    DownloadDocServiceDocumentResponse:
      content:
        "*":
          schema:
            format: binary
            type: string
      description: Successful response
    DownloadLOATemplate:
      content:
        application/pdf:
          schema:
            format: binary
            type: string
      description: Successful response
    FaxApplicationResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/FaxApplication"
            title: Fax Application Response
            type: object
      description: Successful response
    Forbidden:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
      description: Forbidden
    FqdnConnectionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/FqdnConnection"
            title: FQDN Connection Response
            type: object
      description: Successful response with details about an FQDN connection.
    FqdnResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Fqdn"
            title: FQDN Response
            type: object
      description: Successful response with details about an FQDN connection.
    GenericErrorResponse:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Errors"
      description: Unexpected error
    GetAllAddressResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Address"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    GetAllAuthenticationProviderResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/AuthenticationProvider"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    GetAllFaxApplicationsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/FaxApplication"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: Get All Fax Applications Response
            type: object
      description: Successful response
    GetAllPrivateWirelessGatewaysResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PrivateWirelessGateway"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    GetAllSimCardGroupsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/SIMCardGroup"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    GetAllSimCardOrdersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/SIMCardOrder"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    GetAllTelephonyCredentialResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/TelephonyCredential"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: Get All Telephony Credential Response
            type: object
      description: Successful response with multiple credentials
    GetAllTexmlApplicationsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/TexmlApplication"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: Get All Texml Applications Response
            type: object
      description: Successful response
    GetFaxResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Fax"
            title: Get Fax Response
            type: object
      description: Get fax response
    GetPrivateWirelessGatewayResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PrivateWirelessGateway"
            type: object
      description: Successful response
    GetRoomParticipantResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/RoomParticipant"
            type: object
      description: Get room participant response.
    GetRoomResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Room"
            type: object
      description: Get room response.
    GetRoomSessionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/RoomSession"
            type: object
      description: Get room session response.
    GetSimCardGroupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardGroup"
            type: object
      description: Successful Response
    GetSimCardOrderResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardOrder"
            type: object
      description: Successful Response
    GetSimCardResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCard"
            type: object
      description: Successful response
    GetWdrReportResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/WdrReport"
            type: object
      description: Successful response
    GetWdrReportsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/WdrReport"
                type: array
            type: object
      description: Successful response
    InventoryCoverageResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/InventoryCoverage"
                type: array
              meta:
                $ref: "#/components/schemas/InventoryCoverageMetadata"
            type: object
      description: Successful response with a list of inventory coverage levels
    IpConnectionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/IpConnection"
            title: Ip Connection Response
            type: object
      description: Successful response with details about an IP connection.
    IpResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Ip"
            title: Ip Response
            type: object
      description: Successful response with details about an IP.
    ListAvailablePhoneNumbersBlockResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/AvailablePhoneNumberBlock"
                type: array
              meta:
                $ref: "#/components/schemas/AvailablePhoneNumbersMetadata"
            title: List Available Phone Numbers Blocks Response
            type: object
      description: Successful response with a list of available phone numbers blocks.
    ListAvailablePhoneNumbersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/AvailablePhoneNumber"
                type: array
              meta:
                $ref: "#/components/schemas/AvailablePhoneNumbersMetadata"
            title: List Available Phone Numbers Response
            type: object
      description: Successful response with a list of available phone numbers.
    ListBillingGroupsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/BillingGroup"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: A paginated array of billing groups
    ListCallControlApplicationsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/CallControlApplication"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Call Control Applications Response
            type: object
      description: Successful response with a list of call control applications.
    ListCallEventsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/CallEvent"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Call Events Response
            type: object
      description: Successful response with a list of call events.
    ListConferencesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Conference"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Conferences Response
            type: object
      description: Successful response with a list of conferences.
    ListConnectionsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Connection"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Connections Response
            type: object
      description: Successful response with a list of connections.
    ListCredentialConnectionsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/CredentialConnection"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Credential Connections Response
            type: object
      description: Successful response with a list of credential connections.
    ListCsvDownloadsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/CsvDownload"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List CSV Downloads Response
            type: object
      description: Successful response with a list of CSV downloads.
    ListDocServiceDocumentLinksResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/DocServiceDocumentLink"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    ListDocServiceDocumentsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/DocServiceDocument"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    ListFaxesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Fax"
                type: array
              meta:
                example:
                  page_number: 2
                  page_size: 1
                  total_pages: 3
                  total_results: 3
                type: object
            title: List Faxes Response
            type: object
      description: List faxes response
    ListFqdnConnectionsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/FqdnConnection"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List FQDN Connections Response
            type: object
      description: Successful response with a list of FQDN connections.
    ListFqdnsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Fqdn"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List FQDNs Response
            type: object
      description: Successful response with a list of FQDN connections.
    ListIpConnectionsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/IpConnection"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Ip Connections Response
            type: object
      description: Successful response with a list of IP connections.
    ListIpsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Ip"
                type: array
            title: List Ips Response
            type: object
      description: Successful response with a list of IPs.
    ListManagedAccountsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/ManagedAccount"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response with a list of managed accounts.
    ListMediaResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/MediaResource"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List of media resources response
            type: object
      description: A response with a list of media resources
    ListMessagingHostedNumberOrdersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/MessagingHostedNumberOrder"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Messaging Hosted Number Order Response
            type: object
      description: Successful response with a list of messaging hosted number orders.
    ListMessagingProfileMetrics:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/MessagingProfileHighLevelMetrics"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Messaging Profile Metrics Response
            type: object
      description: Successful response with a list of messaging profile metrics.
    ListMessagingProfilePhoneNumbersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PhoneNumberWithMessagingSettings"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Messaging Profile Phone Numbers Response
            type: object
      description: Successful response with a list of messaging profile phone numbers.
    ListMessagingProfileShortCodesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/ShortCode"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Messaging Profile Short Codes Response
            type: object
      description: Successful response with a list of messaging profile short codes.
    ListMessagingProfilesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/MessagingProfile"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Messaging Profiles Response
            type: object
      description: Successful response with a list of messaging profiles.
    ListMessagingUrlDomains:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/MessagingUrlDomain"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Messaging Profile Url Domains Response
            type: object
      description: Successful response with details about a messaging URL domain.
    ListNumberBlockOrdersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/NumberBlockOrder"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Number Block Orders Response
            type: object
      description: Successful response with a list of number block orders.
    ListNumberOrderDocumentsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/NumberOrderDocument"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Number Order Documents Response
            type: object
      description: Successful response with a list of number order documents.
    ListNumberOrderPhoneNumbersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/NumberOrderPhoneNumber"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Number Order Phone Numbers Response
            type: object
      description: Successful response with a list of number order phone numbers.
    ListNumberOrdersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/NumberOrder"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Number Orders Response
            type: object
      description: Successful response with a list of number orders.
    ListNumberReservationsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/NumberReservation"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Number Reservations Response
            type: object
      description: Successful response with a list of number reservations.
    ListOutboundVoiceProfilesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/OutboundVoiceProfile"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Outbound Voice Profiles Response
            type: object
      description: Successful response
    ListParticipantsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Participant"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Participants Response
            type: object
      description: Successful response with a list of conference participants.
    ListPhoneNumberBlocksJobsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PhoneNumberBlocksJob"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Phone Number Blocks Background Jobs Response
            type: object
      description: Successful response with a list of phone number blocks background jobs.
    ListPhoneNumbers:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PhoneNumber"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    ListPhoneNumbersJobsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PhoneNumbersJob"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Phone Numbers Background Jobs Response
            type: object
      description: Successful response with a list of phone numbers background jobs.
    ListPhoneNumbersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PhoneNumberDetailed"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Phone Numbers Response
            type: object
      description: Successful response with a list of phone numbers.
    ListPhoneNumbersWithMessagingSettingsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PhoneNumberWithMessagingSettings"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Messaging Settings Response
            type: object
      description: Successful response with a list of phone numbers with messaging settings.
    ListPhoneNumbersWithVoiceSettingsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PhoneNumberWithVoiceSettings"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Phone Numbers With Voice Settings Response
            type: object
      description: Successful response with a list of phone numbers with voice settings.
    ListPortingOrder:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PortingOrder"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    ListPortingOrderWithoutPagination:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PortingOrder"
                type: array
            type: object
      description: Successful response
    ListPortingOrdersActivationJobs:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PortingOrdersActivationJob"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    ListPortingOrdersComments:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PortingOrdersComment"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    ListPortingOrdersExceptionTypes:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PortingOrdersExceptionType"
                type: array
            type: object
      description: Successful response
    ListPortoutComments:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PortoutComment"
                type: array
              meta:
                $ref: "#/components/schemas/Metadata"
            type: object
      description: Portout Comments
    ListPortoutResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PortoutDetails"
                type: array
              meta:
                $ref: "#/components/schemas/Metadata"
            type: object
      description: Portout Response
    ListQueueCallsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/QueueCall"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Queue Calls Response
            type: object
      description: Successful response with a list of calls in a queue.
    ListRecordingsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Recording"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Recordings Response
            type: object
      description: Successful response with a list of recordings.
    ListRequirementsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/DocReqsRequirementList"
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    ListRoomParticipantsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/RoomParticipant"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: List room participants response.
    ListRoomSessionsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/RoomSession"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: List room sessions response.
    ListRoomsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Room"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: List rooms response.
    ListShortCodesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/ShortCode"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Short Codes Response
            type: object
      description: Successful response with a list of short codes.
    ListSubNumberOrdersResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/SubNumberOrder"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Sub Number Orders Response
            type: object
      description: Successful response with a list of sub number orders.
    ListTagsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  properties:
                    amount:
                      example: 1
                      type: integer
                    tag:
                      example: a_tag
                      type: string
                  type: object
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            title: List Tags Response
            type: object
      description: Successful response with multiple tags
    ListWebhookDeliveriesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/webhook_delivery"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMetaSimple"
            type: object
      description: A paginated array of webhook_delivery attempts
    ManagedAccountResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/ManagedAccount"
            type: object
      description: Successful response with information about a single managed account.
    MediaDownloadResponse:
      content:
        "*/*":
          schema:
            format: binary
            type: string
      description: A response describing a media resource
    MediaResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/MediaResource"
            title: Media resource response
            type: object
      description: A response describing a media resource
    MessageResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/OutboundMessagePayload"
            title: Message Response
            type: object
      description: Successful response with details about a message.
    MessagingHostedNumberOrderResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/MessagingHostedNumberOrder"
            title: Retrieve Messaging Hosted Number Order Response
            type: object
      description: Successful response with details about a messaging hosted number order.
    MessagingHostedNumberResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/HostedNumber"
            title: Retrieve Messaging Hosted Number Response
            type: object
      description: Successful response with details about a messaging hosted number.
    MessagingProfileResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/MessagingProfile"
            title: Messaging Profile Response
            type: object
      description: Successful response with details about a messaging profile.
    NotFoundResponse:
      description: Conference does not exist
    NumberBlockOrderResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/NumberBlockOrder"
            title: Number Block Order Response
            type: object
      description: Successful response with details about a number block order.
    NumberLookupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/NumberLookupRecord"
            title: Number Lookup Response
            type: object
      description: Successful response
    NumberOrderDocumentResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/NumberOrderDocument"
            title: Number Order Document Response
            type: object
      description: Successful response with details about a number order document.
    NumberOrderPhoneNumberResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/NumberOrderPhoneNumber"
            title: Number Order Phone Number Response
            type: object
      description: Successful response with details about a number order phone number.
    NumberOrderResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/NumberOrderWithPhoneNumbers"
            title: Number Order Response
            type: object
      description: Successful response with details about a number order.
    NumberReservationResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/NumberReservation"
            title: Number Reservation Response
            type: object
      description: Successful response with details about a number reservation.
    OTAUpdateResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/CompleteOTAUpdate"
            type: object
      description: Successful response
    OutboundVoiceProfileResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/OutboundVoiceProfile"
            title: Outbound Voice Profile Response
            type: object
      description: Successful response
    PUTSIMCardNetworkPreferenceResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates"
            type: object
      description: |-
        A successful network preferences definition response. <br/><br/>
        The sent mobile_operator_networks_preferences parameter won't be applied to the main resource right away - this is an asynchronous operation. While interacting with this API, you will face the following scenarios:

          * The first request for this API will return an empty mobile_operator_networks_preferences with an in-progress OTA update resource in the ota_updates node containing the exact sent parameters to indicate the operation progress. The value will be applied to the principal object when the OTA update finishes its processing, thus indicating the SIM card network preference current state. 
          * The subsequent requests will contain the current state, that is what's applied to the SIM card settings, and return the related OTA update in the ota_updates node.
          
        The returned OTA updated (present in the ota_updates node) will, by default, be the resource related to the operation, not all of them.
    PhoneNumberResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PhoneNumberDetailed"
            title: Phone Number Response
            type: object
      description: Successful response with details about a phone number.
    PhoneNumberWithMessagingSettingsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PhoneNumberWithMessagingSettings"
            title: Retrieve Messaging Settings Response
            type: object
      description: Successful response with details about a phone number including voice settings.
    PhoneNumberWithVoiceSettingsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PhoneNumberWithVoiceSettings"
            title: Retrieve Phone Number Voice Response
            type: object
      description: Successful response with details about a phone number including voice settings.
    PortabilityCheckResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/PortabilityCheckDetails"
                type: array
            type: object
      description: PortabilityCheck Response
    PortoutCommentResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PortoutComment"
            type: object
      description: Portout Comment Response
    PortoutResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PortoutDetails"
            type: object
      description: Portout Response
    QueueCallResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/QueueCall"
            title: Queue Call Response
            type: object
      description: Successful response with details about a call in a queue.
    QueueResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Queue"
            title: Queue Response
            type: object
      description: Successful response with details about a queue.
    ReadCommentResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                allOf:
                  - $ref: "#/components/schemas/ReadComment"
                  - type: object
            type: object
      description: A Comment Response
    ReceivedSIMCardPublicIPResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardPublicIP"
            type: object
      description: A successful response on an asynchronous operation. The content in this response represents the current status of the public IP. But, it'll change during the operation processing.
    RecordingResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Recording"
            title: Get Recording Response
            type: object
      description: Successful response with details about a recording.
    RefreshFaxResponse:
      content:
        application/json:
          schema:
            example:
              data:
                result: ok
            properties:
              result:
                example: ok
                type: string
            title: Refresh Fax Response
            type: object
      description: Refresh fax response
    RefreshRoomClientTokenResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                example:
                  token: eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA
                  token_expires_at: 2021-04-22T12:24:55Z
                properties:
                  token:
                    example: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ
                    format: jwt
                    type: string
                  token_expires_at:
                    description: ISO 8601 timestamp when the token expires.
                    example: 2021-03-26T17:51:59Z
                    format: datetime
                    type: string
                type: object
            type: object
      description: Refresh room client token response.
    RegisterSimCardsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                description: Successfully registered SIM cards.
                items:
                  $ref: "#/components/schemas/SimpleSIMCard"
                type: array
              errors:
                items:
                  $ref: "#/components/schemas/Error"
                type: array
            type: object
      description: Successful response
    ResourceNotFound:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Error"
      description: Resource not found
    RetrieveBillingGroupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/BillingGroup"
            type: object
      description: Expected billing group response to a valid request
    RetrieveCallStatusResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Call"
            title: Retrieve Call Status Response
            type: object
      description: Successful response with details about a call status.
    RetrieveLedgerBillingGroupReportResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/LedgerBillingGroupReport"
            type: object
      description: Expected ledger billing group report response to a valid request
    RetrieveMessagingProfileMetrics:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/MessagingProfileDetailedMetrics"
            title: Retrieve Messaging Profile Metrics Response
            type: object
      description: Successful response with details about a messaging profile's metrics.
    RetrievePortoutResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PortoutDetails"
            type: object
      description: Expected portout response to a valid request
    SIMCardGroupActionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardGroupAction"
            type: object
      description: Successful Response
    SIMCardNetworkPreferenceResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardNetworkPreference"
            type: object
      description: A successful network preferences definition response.
    SIMCardNetworkPreferenceWithOTAUpdatesResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates"
            type: object
      description: A successful network preferences definition response.
    SIMCardOrdersPreviewResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardOrderPreview"
            type: object
      description: Successful response
    SIMCardPublicIPResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardPublicIP"
            type: object
      description: Successful response
    SearchMobileOperatorNetworksResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/MobileOperatorNetwork"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    SearchOTAUpdateResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/SimplifiedOTAUpdate"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    SearchSimCardsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/SimpleSIMCard"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    SendFaxResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Fax"
            title: Send Fax Response
            type: object
      description: Send fax response
    ShortCodeResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/ShortCode"
            title: Short Code Response
            type: object
      description: Successful response with details about a short code.
    ShowPhoneNumber:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PhoneNumber"
              meta:
                properties:
                  porting_order_url:
                    description: Link to list porting order
                    example: /porting_orders/a700d03c-4062-4091-8189-1b75216cf7a2
                    format: uri
                    type: string
                type: object
            type: object
      description: Successful response
    ShowPortingOrder:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PortingOrder"
              meta:
                properties:
                  phone_numbers_url:
                    description: Link to list all phone numbers
                    example: /porting_phone_numbers?filter[porting_order_id]=a700d03c-4062-4091-8189-1b75216cf7a2
                    type: string
                type: object
            type: object
      description: Successful response
    ShowPortingOrdersActivationJob:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PortingOrdersActivationJob"
            type: object
      description: Successful response
    ShowPortingOrdersComment:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PortingOrdersComment"
            type: object
      description: Successful response
    SimCardGroupActionCollectionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/SIMCardGroupAction"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    SimpleSimCardResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SimpleSIMCard"
            type: object
      description: Successful response
    SubNumberOrderResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SubNumberOrder"
            title: Sub Number Order Response
            type: object
      description: Successful response with details about a sub number order.
    TelephonyCredentialResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/TelephonyCredential"
            title: Telephony Credential Response
            type: object
      description: Successful response with details about a credential
    TexmlApplicationResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/TexmlApplication"
            title: Texml Application Response
            type: object
      description: Successful response
    UnauthorizedResponse:
      description: Unauthorized response. Happens when the current user is not a manager account.
    UnprocessableEntity:
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Errors"
      description: Unprocessable entity. Check the 'detail' field in response for details.
    UnprocessableEntityResponse:
      description: Unprocessable entity
    UnprocessableManagedAccountEntity:
      content:
        application/json:
          schema:
            properties:
              errors:
                items:
                  $ref: "#/components/schemas/UnprocessableEntityError"
                type: array
            type: object
      description: Unprocessable entity. Check the 'detail' field in response for details.
    UpdateBillingGroupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/BillingGroup"
            type: object
      description: Expected billing group response to a valid request
    UpdatePortoutResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/PortoutDetails"
            type: object
      description: Expected portout response to a valid request
    UpdateSimCardGroupResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCardGroup"
            type: object
      description: Successful Response
    UpdateSimCardResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/SIMCard"
            type: object
      description: Successful response
    UploadMediaResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/UploadMedia"
                type: array
            title: Upload Media.
            type: object
      description: Successful response
    UploadedMediaResponse:
      content:
        "*":
          schema:
            format: binary
            title: The requested media.
            type: string
      description: Successful response
    UserBalanceResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/UserBalance"
            type: object
      description: Retrieve user balance details
    ValidateAddressResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/ValidateAddressResult"
            title: Validate address action response
            type: object
      description: Action response
    WhatsAppMessageResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/Message"
            title: Successful response with details about the WhatsApp message sent.
            type: object
      description: Successful response
    WhatsAppUserResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                $ref: "#/components/schemas/WhatsAppUser"
            title: Successful response with details about the WhatsApp message sent.
            type: object
      description: Successful response
    WirelessConnectivityLogCollectionResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/WirelessConnectivityLog"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: Successful response
    listCommentsResponse:
      content:
        application/json:
          schema:
            properties:
              data:
                items:
                  $ref: "#/components/schemas/Comment"
                type: array
              meta:
                $ref: "#/components/schemas/PaginationMeta"
            type: object
      description: An array of Comment Responses
  schemas:
    ActivationStatus:
      description: Activation status
      enum:
        - New
        - Pending
        - Conflict
        - Cancel Pending
        - Failed
        - Concurred
        - Activate RDY
        - Disconnect Pending
        - Concurrence Sent
        - Old
        - Sending
        - Active
        - Canceled
      example: Active
      type: string
    Address:
      properties:
        address_book:
          $ref: "#/components/schemas/address_book"
        administrative_area:
          $ref: "#/components/schemas/administrative_area"
        borough:
          $ref: "#/components/schemas/borough"
        business_name:
          $ref: "#/components/schemas/business_name"
        country_code:
          $ref: "#/components/schemas/country_code"
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        customer_reference:
          $ref: "#/components/schemas/customer_reference"
        extended_address:
          $ref: "#/components/schemas/extended_address"
        first_name:
          $ref: "#/components/schemas/first_name"
        id:
          description: Uniquely identifies the address.
          example: "1293384261075731499"
          format: int64
          type: string
        last_name:
          $ref: "#/components/schemas/last_name"
        locality:
          $ref: "#/components/schemas/locality"
        neighborhood:
          $ref: "#/components/schemas/neighborhood"
        phone_number:
          $ref: "#/components/schemas/phone_number"
        postal_code:
          $ref: "#/components/schemas/postal_code"
        record_type:
          description: Identifies the type of the resource.
          example: address
          type: string
        street_address:
          $ref: "#/components/schemas/street_address"
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
        validate_address:
          $ref: "#/components/schemas/validate_address"
      title: Address
      type: object
    AddressCreate:
      properties:
        address_book:
          $ref: "#/components/schemas/address_book"
        administrative_area:
          $ref: "#/components/schemas/administrative_area"
        borough:
          $ref: "#/components/schemas/borough"
        business_name:
          $ref: "#/components/schemas/business_name"
        country_code:
          $ref: "#/components/schemas/country_code"
        customer_reference:
          $ref: "#/components/schemas/customer_reference"
        extended_address:
          $ref: "#/components/schemas/extended_address"
        first_name:
          $ref: "#/components/schemas/first_name"
        last_name:
          $ref: "#/components/schemas/last_name"
        locality:
          $ref: "#/components/schemas/locality"
        neighborhood:
          $ref: "#/components/schemas/neighborhood"
        phone_number:
          $ref: "#/components/schemas/phone_number"
        postal_code:
          $ref: "#/components/schemas/postal_code"
        street_address:
          $ref: "#/components/schemas/street_address"
        validate_address:
          $ref: "#/components/schemas/validate_address"
      required:
        - first_name
        - last_name
        - business_name
        - street_address
        - locality
        - country_code
      type: object
    AnchorsiteOverride:
      default: Latency
      description: "`Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media."
      enum:
        - Latency
        - Chicago, IL
        - Ashburn, VA
        - San Jose, CA
        - Sydney, Australia
        - Amsterdam, Netherlands
        - London, UK
        - Toronto, Canada
        - Vancouver, Canada
        - Frankfurt, Germany
      example: Amsterdam, Netherlands
      title: Anchorsite Override
      type: string
    AnswerRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        webhook_url: https://www.example.com/server-b/
        webhook_url_method: POST
      properties:
        billing_group_id:
          description: Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID.
          example: f5586561-8ff0-4291-a0ac-84fe544797bd
          format: uuid
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        webhook_url:
          description: Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.
          example: https://www.example.com/server-b/
          type: string
        webhook_url_method:
          default: POST
          description: HTTP request type used for `webhook_url`.
          enum:
            - POST
            - GET
          example: GET
          type: string
      title: Answer Request
      type: object
    ApplicationName:
      description: A user-assigned name to help manage the application.
      example: call-router
      title: Application Name
      type: string
    Audio:
      description: The media object containing audio details.
      example:
        id: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68
      properties:
        id:
          description: The media object ID returned when the media is successfully uploaded to the media endpoint.
          example: your-media-id
          type: string
        link:
          description: The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both.
          example: http://www.example.com/file
          type: string
      title: Audio
      type: object
    AuthenticationProvider:
      properties:
        active:
          $ref: "#/components/schemas/active"
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        id:
          description: Uniquely identifies the authentication provider.
          example: 35146afd-df93-4963-b1e9-1a085e2ae874
          format: uuid
          type: string
        name:
          $ref: "#/components/schemas/name"
        organization_id:
          $ref: "#/components/schemas/organization_id"
        record_type:
          description: Identifies the type of the resource.
          example: authentication_provider
          type: string
        settings:
          description: The settings associated with the authentication provider.
          properties:
            assertion_consumer_service_url:
              description: The Assertion Consumer Service URL for the service provider (Telnyx).
              example: https://api.telnyx.com/sso/saml/auth/myorg
              type: string
            idp_cert_fingerprint:
              description: The certificate fingerprint for the identity provider (IdP)
              example: 13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7
              type: string
            idp_cert_fingerprint_algorithm:
              default: sha1
              description: The algorithm used to generate the identity provider's (IdP) certificate fingerprint
              enum:
                - sha1
                - sha256
                - sha384
                - sha512
              example: sha256
              type: string
            idp_entity_id:
              description: The Entity ID for the identity provider (IdP).
              example: https://myorg.myidp.com/saml/metadata
              type: string
            idp_sso_target_url:
              description: The SSO target url for the identity provider (IdP).
              example: https://myorg.myidp.com/trust/saml2/http-post/sso
              type: string
            name_identifier_format:
              description: The name identifier format associated with the authentication provider. This must be the same for both the Identity Provider (IdP) and the service provider (Telnyx).
              example: urn:oasis:names:tc:SAML:1.1:nameid-format
              type: string
            service_provider_entity_id:
              description: The Entity ID for the service provider (Telnyx).
              example: https://api.telnyx.com/sso/saml/metadata/myorg
              type: string
          type: object
        short_name:
          $ref: "#/components/schemas/short_name"
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
      title: AuthenticationProvider
      type: object
    AuthenticationProviderCreate:
      properties:
        active:
          $ref: "#/components/schemas/active"
        name:
          $ref: "#/components/schemas/name"
        settings:
          $ref: "#/components/schemas/settings"
        settings_url:
          $ref: "#/components/schemas/settings_url"
        short_name:
          $ref: "#/components/schemas/short_name"
      required:
        - name
        - short_name
        - settings
      type: object
    AvailablePhoneNumber:
      example:
        best_effort: false
        cost_information:
          currency: USD
          monthly_cost: "6.54"
          upfront_cost: "3.21"
        features:
          - name: sms
          - name: voice
        phone_number: "+19705555098"
        quickship: true
        record_type: available_phone_number
        region_information:
          - region_name: US
            region_type: country_code
        reservable: true
        vanity_format: ""
      properties:
        best_effort:
          description: Specifies whether the phone number is an exact match based on the search criteria or not.
          example: false
          type: boolean
        cost_information:
          $ref: "#/components/schemas/CostInformation"
        features:
          items:
            $ref: "#/components/schemas/Feature"
          type: array
        phone_number:
          example: "+19705555098"
          type: string
        quickship:
          description: Specifies whether the phone number can receive calls immediately after purchase or not.
          example: true
          type: boolean
        record_type:
          enum:
            - available_phone_number
          example: available_phone_number
          type: string
        region_information:
          items:
            $ref: "#/components/schemas/RegionInformation"
          type: array
        reservable:
          description: Specifies whether the phone number can be reserved before purchase or not.
          example: true
          type: boolean
        vanity_format:
          type: string
      type: object
    AvailablePhoneNumberBlock:
      example:
        cost_information:
          currency: USD
          monthly_cost: "6.54"
          upfront_cost: "3.21"
        features:
          - name: sms
          - name: voice
        phone_number: "+19705555000"
        range: 10
        record_type: available_phone_number_block
        region_information:
          - region_name: US
            region_type: country_code
      properties:
        cost_information:
          $ref: "#/components/schemas/CostInformation"
        features:
          items:
            $ref: "#/components/schemas/Feature"
          type: array
        range:
          example: 10
          type: integer
        record_type:
          enum:
            - available_phone_number_block
          example: available_phone_number_block
          type: string
        region_information:
          items:
            $ref: "#/components/schemas/RegionInformation"
          type: array
        starting_number:
          example: "+19705555000"
          type: string
      type: object
    AvailablePhoneNumbersMetadata:
      example:
        best_effort_results: 50
        total_results: 100
      properties:
        best_effort_results:
          example: 0
          type: integer
        total_results:
          example: 1
          type: integer
      type: object
    BillingGroup:
      example:
        created_at: 2019-10-15T10:07:15.527Z
        deleted_at: null
        id: f5586561-8ff0-4291-a0ac-84fe544797bd
        name: My billing group name
        organization_id: f1486bae-f067-460c-ad43-73a92848f902
        record_type: billing_group
        updated_at: 2019-10-15T10:07:15.527Z
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          type: string
        deleted_at:
          description: ISO 8601 formatted date indicating when the resource was removed.
          example: null
          format: date-time
          type: string
        id:
          description: Identifies the type of resource.
          example: f5586561-8ff0-4291-a0ac-84fe544797bd
          format: uuid
          type: string
        name:
          description: A user-specified name for the billing group
          example: My billing group name
          format: string
          type: string
        organization_id:
          description: Identifies the organization that owns the resource.
          example: f1486bae-f067-460c-ad43-73a92848f902
          format: uuid
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - billing_group
          example: billing_group
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          type: string
      type: object
    BridgeRequest:
      example:
        call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        park_after_unbridge: self
      properties:
        call_control_id:
          description: The Call Control ID of the call you want to bridge with.
          example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        park_after_unbridge:
          description: Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up or is transferred). If supplied with the value `self`, the current leg will be parked after unbridge. If not set, the default behavior is to hang up the leg.
          example: self
          type: string
        queue:
          description: The name of the queue you want to bridge with, can't be used together with call_control_id parameter. Bridging with a queue means bridging with the first call in the queue. The call will always be removed from the queue regardless of whether bridging succeeds. Returns an error when the queue is empty.
          example: support
          type: string
      required:
        - call_control_id
      title: Bridge Request
      type: object
    BulkCredentialRequest:
      example:
        connection_id: "804252963366242252"
        name: Default Name
        tag: My Credentials
      properties:
        amount:
          description: Amount of credentials to be created. A single tag can hold at maximum 1000 credentials
          example: 100
          type: integer
        connection_id:
          description: Identifies the connection this credential is associated with.
          example: "1234567890"
          type: string
        name:
          description: A default name for all credentials.
          example: Default Credentials
          type: string
        tag:
          description: Tags a credential for bulk operations. A single tag can hold at maximum 1000 credentials.
          example: My Credentials
          type: string
      required:
        - tag
        - connection_id
      title: Bulk Credential Request
      type: object
    Call:
      example:
        call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
        call_leg_id: 2dc6fc34-f9e0-11ea-b68e-02420a0f7768
        call_session_id: 2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768
        is_alive: false
        record_type: call
      properties:
        call_control_id:
          description: Unique identifier and token for controlling the call.
          example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          type: string
        call_leg_id:
          description: ID that is unique to the call and can be used to correlate webhook events
          example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          type: string
        call_session_id:
          description: ID that is unique to the call session and can be used to correlate webhook events
          example: 428c31b6-7af4-4bcb-b68e-5013ef9657c1
          type: string
        is_alive:
          description: Indicates whether the call is alive or not. For Dial command it will always be `false` (dialing is asynchronous).
          example: true
          type: boolean
        record_type:
          enum:
            - call
          example: call
          type: string
      required:
        - call_control_id
        - call_leg_id
        - call_session_id
        - is_alive
        - record_type
      title: Call
      type: object
    CallAnswered:
      example:
        event_type: call.answered
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: "+35319605860"
          state: answered
          to: "+35319605860"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.answered
          example: call.answered
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            state:
              description: State received from a command.
              enum:
                - answered
              example: answered
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Answered
      type: object
    CallAnsweredEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallAnswered"
      title: Call Answered Event
      type: object
    CallBridged:
      example:
        event_type: call.bridged
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: "+35319605860"
          state: bridged
          to: "+35319605860"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.bridged
          example: call.bridged
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            state:
              description: State received from a command.
              enum:
                - bridged
              example: bridged
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Bridged
      type: object
    CallBridgedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallBridged"
      title: Call Bridged Event
      type: object
    CallControlApplication:
      example:
        active: false
        anchorsite_override: '"Latency"'
        application_name: call-router
        created_at: 2018-02-02T22:25:27.521Z
        dtmf_type: Inband
        first_command_timeout: true
        first_command_timeout_secs: 10
        id: "1293384261075731499"
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        record_type: call_control_application
        updated_at: 2018-02-02T22:25:27.521Z
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          default: true
          description: Specifies whether the connection can be used.
          type: boolean
        anchorsite_override:
          default: '"Latency"'
          description: |
            `Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.
          enum:
            - '"Latency"'
            - '"Chicago, IL"'
            - '"Ashburn, VA"'
            - '"San Jose, CA"'
          example: '"Amsterdam, Netherlands"'
          type: string
        application_name:
          description: A user-assigned name to help manage the application.
          example: call-router
          type: string
        created_at:
          description: ISO 8601 formatted date of when the resource was created
          example: 2018-02-02T22:25:27.521Z
          type: string
        dtmf_type:
          default: RFC 2833
          description: Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
          enum:
            - RFC 2833
            - Inband
            - SIP INFO
          example: Inband
          type: string
        first_command_timeout:
          default: false
          description: Specifies whether calls to phone numbers associated with this connection should hangup after timing out.
          example: true
          type: boolean
        first_command_timeout_secs:
          default: 30
          description: Specifies how many seconds to wait before timing out a dial command.
          example: 10
          type: integer
        id:
          example: "1293384261075731499"
          format: int64
          type: string
        inbound:
          $ref: "#/components/schemas/CallControlApplicationInbound"
        outbound:
          $ref: "#/components/schemas/CallControlApplicationOutbound"
        record_type:
          default: call_control_application
          enum:
            - call_control_application
          type: string
        updated_at:
          description: ISO 8601 formatted date of when the resource was last updated
          example: 2018-02-02T22:25:27.521Z
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as `https`.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as `https`.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      title: Call Control Application
      type: object
    CallControlApplicationInbound:
      properties:
        channel_limit:
          default: null
          description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
          example: 10
          type: integer
        sip_subdomain:
          default: null
          description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
          example: example
          type: string
        sip_subdomain_receive_settings:
          default: from_anyone
          description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
          enum:
            - only_my_connections
            - from_anyone
          example: only_my_connections
          type: string
      title: Call Control Application Inbound
      type: object
    CallControlApplicationOutbound:
      properties:
        channel_limit:
          default: null
          description: When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
          example: 10
          type: integer
        outbound_voice_profile_id:
          description: Identifies the associated outbound voice profile.
          example: "1293384261075731499"
          format: int64
          type: string
      title: Call Control Application Outbound
      type: object
    CallControlCommandResult:
      example:
        result: ok
      properties:
        result:
          example: ok
          type: string
      title: Call Control Command Result
      type: object
    CallDtmfReceived:
      example:
        event_type: call.dtmf.received
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          digit: "#"
          from: "+35319605860"
          to: "+35319605860"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.dtmf.received
          example: call.dtmf.received
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Identifies the type of resource.
              example: 7267xxxxxxxxxxxxxx
              type: string
            digit:
              description: The received DTMF digit or symbol.
              example: "#"
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call DTMF Received
      type: object
    CallDtmfReceivedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallDtmfReceived"
      title: Call DTMF Received Event
      type: object
    CallEnqueued:
      example:
        event_type: call.enqueued
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          current_position: 5
          queue: support
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.enqueued
          example: call.enqueued
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Telnyx connection ID used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            current_position:
              description: Current position of the call in the queue.
              example: 7
              type: integer
            queue:
              description: The name of the queue
              example: support
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Enqueued
      type: object
    CallEnqueuedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallEnqueued"
      title: Call Enqueued Event
      type: object
    CallEvent:
      example:
        call_leg_id: 308fe500-5213-11e9-ace7-02420a0f0668
        call_session_id: 308fec30-5213-11e9-9d3f-02420a0f0668
        event_timestamp: 2019-03-29T11:10:19.127783Z
        metadata: {}
        name: call.hangup
        record_type: call_event
        type: webhook
      properties:
        call_leg_id:
          description: Uniquely identifies an individual call leg.
          example: 308fe500-5213-11e9-ace7-02420a0f0668
          type: string
        call_session_id:
          description: Uniquely identifies the call control session. A session may include multiple call leg events.
          example: 308fec30-5213-11e9-9d3f-02420a0f0668
          type: string
        event_timestamp:
          description: Event timestamp
          example: 2019-03-29T11:10:19.127783Z
          type: string
        metadata:
          description: Event metadata, which includes raw event, and extra information based on event type
          type: object
        name:
          description: Event name
          example: call.hangup
          type: string
        record_type:
          enum:
            - call_event
          example: call_event
          type: string
        type:
          description: Event type
          enum:
            - command
            - webhook
          example: webhook
          type: string
      required:
        - record_type
        - call_leg_id
        - call_session_id
        - event_timestamp
        - name
        - type
        - metadata
      title: Call Event
      type: object
    CallForkStarted:
      example:
        event_type: call.fork.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.fork.started
          example: call.fork.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Fork Started
      type: object
    CallForkStartedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallForkStarted"
      title: Call Fork Started Event
      type: object
    CallForkStopped:
      example:
        event_type: call.fork.stopped
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.fork.stopped
          example: call.fork.stopped
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Fork Stopped
      type: object
    CallForkStoppedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallForkStopped"
      title: Call Fork Stopped Event
      type: object
    CallForwarding:
      description: The call forwarding settings for a phone number.
      example:
        call_forwarding_enabled: true
        forwarding_type: always
        forwards_to: "+13035559123"
      properties:
        call_forwarding_enabled:
          default: true
          description: Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.
          example: true
          type: boolean
        forwarding_type:
          description: Call forwarding type. 'forwards_to' must be set for this to have an effect.
          enum:
            - always
            - on_failure
          example: always
          type: string
        forwards_to:
          description: The phone number to which inbound calls to this number are forwarded. Inbound calls will not be forwarded if this field is left blank. If set, must be a +E.164-formatted phone number.
          type: string
      type: object
    CallGatherEnded:
      example:
        event_type: call.gather.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          digits: "123"
          from: "+35319605860"
          status: valid
          to: "+35319605860"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.gather.ended
          example: call.gather.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            digits:
              description: The received DTMF digit or symbol.
              example: "5503"
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            status:
              description: Reflects how command ended.
              enum:
                - valid
                - invalid
                - call_hangup
                - cancelled
                - cancelled_amd
              example: valid
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Gather Ended
      type: object
    CallGatherEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallGatherEnded"
      title: Call Gather Ended Event
      type: object
    CallHangup:
      example:
        event_type: call.hangup
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: "+35319605860"
          hangup_cause: call_rejected
          hangup_source: caller
          sip_hangup_cause: "603"
          start_time: 2018-02-02T22:20:27.521992Z
          state: hangup
          to: "+35319605860"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.hangup
          example: call.hangup
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            hangup_cause:
              description: The reason the call was ended (`call_rejected`, `normal_clearing`, `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found` or `unspecified`).
              enum:
                - call_rejected
                - normal_clearing
                - originator_cancel
                - timeout
                - time_limit
                - user_busy
                - not_found
                - unspecified
              example: call_rejected
              type: string
            hangup_source:
              description: The party who ended the call (`callee`, `caller`, `unknown`).
              enum:
                - caller
                - callee
                - unknown
              example: caller
              type: string
            sip_hangup_cause:
              description: The reason the call was ended (SIP response code). If the SIP response is unavailable (in inbound calls for example) this is set to `unspecified`.
              example: "603"
              type: string
            start_time:
              description: ISO 8601 datetime of when the call started.
              example: 2018-02-02T22:20:27.521992Z
              format: date-time
              type: string
            state:
              description: State received from a command.
              enum:
                - hangup
              example: hangup
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Hangup
      type: object
    CallHangupEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallHangup"
      title: Call Hangup Event
      type: object
    CallInitiated:
      example:
        event_type: call.initiated
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          direction: incoming
          from: "+35319605860"
          state: parked
          to: "+35319605860"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.initiated
          example: call.initiated
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            direction:
              description: Whether the call is `incoming` or `outgoing`.
              enum:
                - incoming
                - outgoing
              example: incoming
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            state:
              description: State received from a command.
              enum:
                - parked
                - bridging
              example: parked
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Initiated
      type: object
    CallInitiatedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallInitiated"
      title: Call Initiated Event
      type: object
    CallLeftQueue:
      example:
        event_type: call.left.queue
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          queue: support
          reason: leave
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.left.queue
          example: call.left.queue
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Telnyx connection ID used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            queue:
              description: The name of the queue
              example: support
              type: string
            reason:
              description: The reason for leaving the queue
              enum:
                - bridged
                - bridging-in-process
                - hangup
                - leave
                - timeout
              example: bridged
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Left Queue
      type: object
    CallLeftQueueEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallLeftQueue"
      title: Call Left Queue Event
      type: object
    CallMachineDetectionEnded:
      example:
        event_type: call.machine.detection.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: "+35319605860"
          result: human
          to: "+35319605860"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.machine.detection.ended
          example: call.machine.detection.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            result:
              description: Answering machine detection result.
              enum:
                - human
                - machine
                - not_sure
              example: machine
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Machine Detection Ended
      type: object
    CallMachineDetectionEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallMachineDetectionEnded"
      title: Call Machine Detection Ended Event
      type: object
    CallMachineGreetingEnded:
      example:
        event_type: call.machine.greeting.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          from: "+35319605860"
          result: ended
          to: "+35319605860"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.machine.greeting.ended
          example: call.machine.greeting.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            result:
              description: Answering machine greeting ended result.
              enum:
                - ended
                - not_sure
              example: ended
              type: string
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Machine Greeting Ended
      type: object
    CallMachineGreetingEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallMachineGreetingEnded"
      title: Call Machine Greeting Ended Event
      type: object
    CallPlaybackEnded:
      example:
        event_type: call.playback.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          media_name: my_media_uploaded_to_media_storage_api
          overlay: false
          status: valid
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.playback.ended
          example: call.playback.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            overlay:
              description: Whether the audio is going to be played in overlay mode or not.
              example: false
              type: boolean
            status:
              description: Reflects how command ended.
              enum:
                - valid
                - invalid
                - call_hangup
              example: valid
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Playback Ended
      type: object
    CallPlaybackEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallPlaybackEnded"
      title: Call Playback Ended Event
      type: object
    CallPlaybackStarted:
      example:
        event_type: call.playback.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          media_url: http://example.com/audio.wav
          overlay: false
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.playback.started
          example: call.playback.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            overlay:
              description: Whether the audio is going to be played in overlay mode or not.
              example: false
              type: boolean
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Playback Started
      type: object
    CallPlaybackStartedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallPlaybackStarted"
      title: Call Playback Started Event
      type: object
    CallRecording:
      description: The call recording settings for a phone number.
      example:
        inbound_call_recording_channels: single
        inbound_call_recording_enabled: true
        inbound_call_recording_format: wav
      properties:
        inbound_call_recording_channels:
          default: single
          description: When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.
          enum:
            - single
            - dual
          type: string
        inbound_call_recording_enabled:
          default: false
          description: When enabled, any inbound call to this number will be recorded.
          type: boolean
        inbound_call_recording_format:
          default: wav
          description: The audio file format for calls being recorded.
          enum:
            - wav
            - mp3
          type: string
      type: object
    CallRecordingSaved:
      example:
        event_type: call.recording.saved
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          channels: single
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          public_recording_urls:
            mp3: http://example.com/recording.mp3
            wav: http://example.com/recording.wav
          recording_ended_at: 2018-02-02T22:20:27.521992Z
          recording_started_at: 2018-02-02T22:20:27.521992Z
          recording_urls:
            mp3: http://example.com/recording.mp3
            wav: http://example.com/recording.wav
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.recording.saved
          example: call.recording.saved
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            channels:
              description: Whether recording was recorded in `single` or `dual` channel.
              enum:
                - single
                - dual
              example: single
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            public_recording_urls:
              description: Recording URLs in requested format. The URL is valid for as long as the file exists. For security purposes, this feature is activated on a per request basis.  Please contact customer support with your Account ID to request activation.
              properties:
                mp3:
                  description: Recording URL in requested `mp3` format.
                  example: http://example.com/recording.mp3
                  nullable: true
                  type: string
                wav:
                  description: Recording URL in requested `wav` format.
                  example: http://example.com/recording.wav
                  nullable: true
                  type: string
              type: object
            recording_ended_at:
              description: ISO 8601 datetime of when recording ended.
              example: 2018-02-02T22:25:27.521992Z
              format: date-time
              type: string
            recording_started_at:
              description: ISO 8601 datetime of when recording started.
              example: 2018-02-02T22:20:27.521992Z
              format: date-time
              type: string
            recording_urls:
              description: Recording URLs in requested format. These URLs are valid for 10 minutes. After 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings documentation, or via Mission Control under Reporting -> Recordings.
              properties:
                mp3:
                  description: Recording URL in requested `mp3` format.
                  example: http://example.com/recording.mp3
                  nullable: true
                  type: string
                wav:
                  description: Recording URL in requested `wav` format.
                  example: http://example.com/recording.wav
                  nullable: true
                  type: string
              type: object
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Recording Saved
      type: object
    CallRecordingSavedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallRecordingSaved"
      title: Call Recording Saved Event
      type: object
    CallReferCompleted:
      example:
        event_type: call.refer.completed
        id: 4ce4366d-8d87-44be-a00b-942154e9c5f5
        occurred_at: 2020-03-30T13:29:44.650000Z
        payload:
          call_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
          call_leg_id: 817f7de8-728a-11ea-9ce6-02420a0f8969
          call_session_id: 817f8c2a-728a-11ea-9cbe-02420a0f8969
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: "1289082222292239760"
          from: "+35319605860"
          sip_notify_response: 200
          to: "+13129457420"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.refer.completed
          example: call.refer.completed
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique ID for controlling the call.
              example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            sip_notify_response:
              description: SIP NOTIFY event status for tracking the REFER attempt.
              example: 200
              type: integer
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      type: object
    CallReferCompletedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallReferCompleted"
      title: Call Recording Saved Event
      type: object
    CallReferFailed:
      example:
        event_type: call.refer.failed
        id: fbeb70e0-54eb-4e26-8d19-56b43e66f754
        occurred_at: 2020-03-30T13:29:42.130013Z
        payload:
          call_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
          call_leg_id: 817f7de8-728a-11ea-9ce6-02420a0f8969
          call_session_id: 817f8c2a-728a-11ea-9cbe-02420a0f8969
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: "1289082222292239760"
          from: "+35319605860"
          sip_notify_response: 603
          to: "+13129457420"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.refer.failed
          example: call.refer.failed
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique ID for controlling the call.
              example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            sip_notify_response:
              description: SIP NOTIFY event status for tracking the REFER attempt.
              example: 603
              type: integer
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      type: object
    CallReferFailedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallReferFailed"
      title: Call Recording Saved Event
      type: object
    CallReferStarted:
      example:
        event_type: call.refer.started
        id: fbeb70e0-54eb-4e26-8d19-56b43e66f754
        occurred_at: 2020-03-30T13:29:42.130013Z
        payload:
          call_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
          call_leg_id: 817f7de8-728a-11ea-9ce6-02420a0f8969
          call_session_id: 817f8c2a-728a-11ea-9cbe-02420a0f8969
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: "1289082222292239760"
          from: "+35319605860"
          sip_notify_response: 100
          to: "+13129457420"
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.refer.started
          example: call.refer.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique ID for controlling the call.
              example: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            from:
              description: Number or SIP URI placing the call.
              example: "+35319605860"
              type: string
            sip_notify_response:
              description: SIP NOTIFY event status for tracking the REFER attempt.
              example: 100
              type: integer
            to:
              description: Destination number or SIP URI of the call.
              example: "+13129457420"
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Refer Started
      type: object
    CallReferStartedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallReferStarted"
      title: Call Refer Started Event
      type: object
    CallRequest:
      example:
        answering_machine_detection: detect
        answering_machine_detection_config:
          after_greeting_silence_millis: 1000
          between_words_silence_millis: 1000
          greeting_duration_millis: 1000
          greeting_silence_duration_millis: 2000
          greeting_total_analysis_time_millis: 50000
          initial_silence_millis: 1000
          maximum_number_of_words: 1000
          maximum_word_length_millis: 2000
          silence_threshold: 512
          total_analysis_time_millis: 5000
        audio_url: http://www.example.com/sounds/greeting.wav
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        connection_id: 7267xxxxxxxxxxxxxx
        custom_headers:
          - name: head_1
            value: val_1
          - name: head_2
            value: val_2
        from: "+18005550101"
        from_display_name: Company Name
        link_to: ilditnZK_eVysupV21KzmzN_sM29ygfauQojpm4BgFtfX5hXAcjotg==
        sip_auth_password: password
        sip_auth_username: username
        timeout_limit_secs: 60
        timeout_secs: 60
        to: +18005550100 or sip:username@sip.telnyx.com
        webhook_url: https://www.example.com/server-b/
        webhook_url_method: POST
      properties:
        answering_machine_detection:
          default: disabled
          description: Enables Answering Machine Detection. When a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will receive another 'call.machine.greeting.ended' webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive 'call.machine.greeting.ended' if a beep is detected.
          enum:
            - detect
            - detect_beep
            - detect_words
            - greeting_end
            - disabled
          type: string
        answering_machine_detection_config:
          description: Optional configuration parameters to modify 'answering_machine_detection' performance.
          properties:
            after_greeting_silence_millis:
              default: 800
              description: Silence duration threshold after a greeting message or voice for it be considered human.
              example: 1000
              format: int32
              type: integer
            between_words_silence_millis:
              default: 50
              description: Maximum threshold for silence between words.
              example: 100
              format: int32
              type: integer
            greeting_duration_millis:
              default: 3500
              description: Maximum threshold of a human greeting. If greeting longer than this value, considered machine.
              example: 1500
              format: int32
              type: integer
            greeting_silence_duration_millis:
              default: 1500
              description: If machine already detected, maximum threshold for silence between words. If exceeded, the greeting is considered ended.
              example: 2000
              format: int32
              type: integer
            greeting_total_analysis_time_millis:
              default: 5000
              description: If machine already detected, maximum timeout threshold to determine the end of the machine greeting.
              example: 7500
              format: int32
              type: integer
            initial_silence_millis:
              default: 3500
              description: If initial silence duration is greater than this value, consider it a machine.
              example: 1800
              format: int32
              type: integer
            maximum_number_of_words:
              default: 5
              description: If number of detected words is greater than this value, consder it a machine.
              example: 3
              format: int32
              type: integer
            maximum_word_length_millis:
              default: 3500
              description: If a single word lasts longer than this threshold, consider it a machine.
              example: 2000
              format: int32
              type: integer
            silence_threshold:
              default: 256
              description: Minimum noise threshold for any analysis.
              example: 512
              format: int32
              type: integer
            total_analysis_time_millis:
              default: 3500
              description: Maximum timeout threshold for overall detection.
              example: 5000
              format: int32
              type: integer
          type: object
        audio_url:
          description: The URL of a file to be played back to the callee when the call is answered. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request.
          example: http://example.com/message.wav
          type: string
        billing_group_id:
          description: Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID.
          example: f5586561-8ff0-4291-a0ac-84fe544797bd
          format: uuid
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        connection_id:
          description: The ID of the Call Control App (formerly ID of the connection) to be used when dialing the destination.
          type: string
        custom_headers:
          description: Custom headers to be added to the SIP INVITE.
          example:
            - name: head_1
              value: val_1
            - name: head_2
              value: val_2
          items:
            $ref: "#/components/schemas/CustomSipHeader"
          type: array
        from:
          description: The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format. This attribute will default to the `from` number of the original call if omitted.
          example: "+18005550101"
          type: string
        from_display_name:
          description: The `from_display_name` string 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: Company Name
          type: string
        link_to:
          description: Use another call's control id for sharing the same call session id
          example: ilditnZK_eVysupV21KzmzN_sM29ygfauQojpm4BgFtfX5hXAcjotg==
          type: string
        media_name:
          description: The media_name of a file to be played back to the callee when the call is answered. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.
          example: my_media_uploaded_to_media_storage_api
          type: string
        sip_auth_password:
          description: SIP Authentication password used for SIP challenges.
          type: string
        sip_auth_username:
          description: SIP Authentication username used for SIP challenges.
          type: string
        time_limit_secs:
          default: 14400
          description: Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length.
          example: 600
          format: int32
          type: integer
        timeout_secs:
          default: 30
          description: The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being called. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds.
          example: 60
          format: int32
          type: integer
        to:
          description: The DID or SIP URI to dial out to.
          example: +18005550100 or sip:username@sip.telnyx.com
          type: string
        webhook_url:
          description: Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.
          example: https://www.example.com/server-b/
          type: string
        webhook_url_method:
          default: POST
          description: HTTP request type used for `webhook_url`.
          enum:
            - POST
            - GET
          example: GET
          type: string
      required:
        - connection_id
        - to
        - from
      title: Dial Request
      type: object
    CallSpeakEnded:
      example:
        event_type: call.speak.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
          status: completed
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.speak.ended
          example: call.speak.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            status:
              description: Reflects how `speak` ended.
              enum:
                - completed
                - call_hangup
              example: completed
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Speak Ended
      type: object
    CallSpeakEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallSpeakEnded"
      title: Call Speak Ended Event
      type: object
    CallSpeakStarted:
      example:
        event_type: call.speak.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.speak.started
          example: call.speak.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Call Speak Started
      type: object
    CallSpeakStartedEvent:
      properties:
        data:
          $ref: "#/components/schemas/CallSpeakStarted"
      title: Call Speak Started Event
      type: object
    CallerName:
      properties:
        caller_name:
          description: The name of the requested phone number's owner as per the CNAM database
          example: TELNYX LLC
          type: string
        error_code:
          description: A caller-name lookup specific error code, expressed as a stringified 5-digit integer
          example: "10001"
          type: string
      type: object
    Carrier:
      properties:
        error_code:
          description: Unused
          example: null
          type: string
        mobile_country_code:
          description: Region code that matches the specific country calling code if the requested phone number type is mobile
          example: US
          type: string
        mobile_network_code:
          description: National destination code (NDC), with a 0 prefix, if an NDC is found and the requested phone number type is mobile
          example: 866
          type: string
        name:
          description: SPID (Service Provider ID) name, if the requested phone number has been ported; otherwise, the name of carrier who owns the phone number block
          example: Telnyx/4
          type: string
        type:
          description: A phone number type that identifies the type of service associated with the requested phone number
          enum:
            - fixed line
            - mobile
            - voip
            - fixed line or mobile
            - toll free
            - premium rate
            - shared cost
            - personal number
            - pager
            - uan
            - voicemail
            - unknown
          example: voip
          type: string
      type: object
    CdrGetSyncUsageReportResponse:
      properties:
        data:
          $ref: "#/components/schemas/CdrUsageReportResponse"
      type: object
    CdrUsageReportResponse:
      properties:
        aggregation_type:
          enum:
            - NO_AGGREGATION
            - CONNECTION
            - TAG
            - BILLING_GROUP
          type: string
        connections:
          example: "[1234567890L, 9876543210L]"
          items:
            format: int64
            type: integer
          properties:
            empty:
              type: boolean
          type: array
        created_at:
          example: 2018-02-02T22:25:27.521Z
          format: date-time
          type: string
        end_time:
          example: 2018-02-02T22:25:27.521Z
          format: date-time
          type: string
        id:
          description: Identifies the resource
          format: uuid
          type: string
        product_breakdown:
          enum:
            - NO_BREAKDOWN
            - DID_VS_TOLL_FREE
            - COUNTRY
            - DID_VS_TOLL_FREE_PER_COUNTRY
          type: string
        record_type:
          example: cdr_usage_report
          type: string
        report_url:
          example: http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv
          type: string
        result:
          type: object
        start_time:
          example: 2018-02-02T22:25:27.521Z
          format: date-time
          type: string
        status:
          enum:
            - PENDING
            - COMPLETE
            - FAILED
            - EXPIRED
          type: string
        updated_at:
          example: 2018-02-02T22:25:27.521Z
          format: date-time
          type: string
      type: object
    CheckContact:
      description: ""
      example:
        id: "15125551234"
        input: +1 (512) 555-1234
        record_type: whatsapp_contact
        status: valid
      properties:
        id:
          description: WhatsApp user identifier that can be used in other API calls. Only returned if the status is valid.
          type: string
        input:
          description: The value you sent in the contacts field of the JSON request.
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - whatsapp_contact
          readOnly: true
          type: string
        status:
          description: Status of the user.
          enum:
            - processing
            - valid
            - invalid
          type: string
          x-enum-descriptions:
            - "processing: Input is still being processed."
            - "valid: Input determined to be a valid WhatsApp user."
            - "invalid: Input determined to not be a valid WhatsApp user or the phone number is in a bad format."
      title: Check Contact
      type: object
    CheckContactRequestBody:
      example:
        blocking: wait
        contacts:
          - "15125551000"
          - +1 512 555 1001
          - "5125551002"
          - +1 (512) 555-1004
          - 1-512-555-1005
        whatsapp_user_id: "15125551212"
      properties:
        blocking:
          default: no_wait
          description: Blocking determines whether the request should wait for the processing to complete (synchronous) or not (asynchronous).
          enum:
            - no_wait
            - wait
          type: string
        contacts:
          description: Array of contact phone numbers. The numbers can be in any standard telephone number format.
          items:
            type: string
          type: array
        whatsapp_user_id:
          description: The sender's WhatsApp ID.
          type: string
      required:
        - whatsapp_user_id
        - contacts
      title: Check Contact Request Body
      type: object
    CnamListing:
      description: The CNAM listing settings for a phone number.
      example:
        cnam_listing_details: example
        cnam_listing_enabled: true
      properties:
        cnam_listing_details:
          description: The CNAM listing details for this number. Must be alphanumeric characters or spaces with a maximum length of 15. Requires cnam_listing_enabled to also be set to true.
          type: string
        cnam_listing_enabled:
          default: false
          description: Enables CNAM listings for this number. Requires cnam_listing_details to also be set.
          type: boolean
      type: object
    Comment:
      properties:
        body:
          example: Hi there, ....
          type: string
        comment_record_id:
          example: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
          format: uuid
          type: string
        comment_record_type:
          enum:
            - number_order
            - sub_number_order
            - number_order_phone_number
          example: sub_number_order
          type: string
        commenter:
          example: user@company.com
          readOnly: true
          type: string
        commenter_type:
          enum:
            - admin
            - user
          example: user
          readOnly: true
          type: string
        created_at:
          description: An ISO 8901 datetime string denoting when the comment was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        read_at:
          description: An ISO 8901 datetime string for when the comment was read.
          example: null
          format: datetime
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the comment was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
    CompleteOTAUpdate:
      description: This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card. <br/><br/>
      example:
        created_at: 2018-02-02T22:25:27.521Z
        id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        record_type: ota_update
        settings:
          mobile_operator_networks_preferences:
            - mobile_operator_network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
              mobile_operator_network_name: AT&T Mobility (USACG)
              priority: 0
        sim_card_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        status: in-progress
        type: sim_card_network_preferences
        updated_at: 2018-02-02T22:25:27.521Z
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        record_type:
          example: ota_update
          readOnly: true
          type: string
        settings:
          description: A JSON object representation of the operation. The information present here will relate directly to the source of the OTA request.
          properties:
            mobile_operator_networks_preferences:
              $ref: "#/components/schemas/MobileOperatorNetworksPreferencesResponse"
          type: object
        sim_card_id:
          description: The identification UUID of the related SIM card resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        status:
          enum:
            - in-progress
            - completed
            - failed
          example: in-progress
          type: string
        type:
          description: Represents the type of the operation requested. This will relate directly to the source of the request.
          enum:
            - sim_card_network_preferences
          example: sim_card_network_preferences
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: OTAUpdate
      type: object
    Conference:
      example:
        connection_id: 3fa85f64-9191-4567-b3fc-2c963f66afa6
        created_at: 2019-01-23T18:10:02.574Z
        end_reason: all_left
        ended_by:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==
          call_session_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
        expires_at: 2019-01-23T18:10:02.574Z
        id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        name: All hands meeting
        record_type: conference
        region: sv1
        status: completed
        updated_at: 2019-01-23T18:10:02.574Z
      properties:
        connection_id:
          description: Identifies the connection (Call Control App) associated with the conference
          example: 3fa85f64-9191-4567-b3fc-2c963f66afa6
          type: string
        created_at:
          description: ISO 8601 formatted date of when the conference was created
          example: 2019-01-23T18:10:02.574Z
          type: string
        end_reason:
          description: Reason why the conference ended
          enum:
            - all_left
            - ended_via_api
            - host_left
            - time_exceeded
          example: all_left
          type: string
        ended_by:
          description: IDs related to who ended the conference. It is expected for them to all be there or all be null
          properties:
            call_control_id:
              description: Call Control ID which ended the conference
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==
              type: string
            call_session_id:
              description: Call Session ID which ended the conference
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
          type: object
        expires_at:
          description: ISO 8601 formatted date of when the conference will expire
          example: 2019-01-23T18:10:02.574Z
          type: string
        id:
          description: Uniquely identifies the conference
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: string
        name:
          description: Name of the conference
          example: All hands meeting
          type: string
        record_type:
          enum:
            - conference
          example: conference
          type: string
        region:
          description: Region where the conference is hosted
          example: sv1
          type: string
        status:
          description: Status of the conference
          enum:
            - init
            - in_progress
            - completed
          example: completed
          type: string
        updated_at:
          description: ISO 8601 formatted date of when the conference was last updated
          example: 2019-01-23T18:10:02.574Z
          type: string
      required:
        - record_type
        - id
        - name
        - created_at
        - expires_at
      title: Conference
      type: object
    ConferenceCallRequest:
      example:
        call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        from: "+18005550101"
        hold: true
        hold_audio_url: http://www.example.com/audio.wav
        mute: true
        start_conference_on_enter: true
        supervisor_role: whisper
        to: "+18005550100"
        whisper_call_control_ids:
          - v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ
          - v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw
      properties:
        call_control_id:
          description: Unique identifier and token for controlling the call
          example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        from:
          description: The `from` number to be used as the caller id presented to the destination (`to` number).
          example: "+18005550101"
          type: string
        hold:
          default: false
          description: Whether the participant should be put on hold immediately after joining the conference.
          example: true
          type: boolean
        hold_audio_url:
          description: The URL of a file to be played to the participant when they are put on hold after joining the conference. If media_name is also supplied, this is currently ignored. Takes effect only when "start_conference_on_create" is set to "false". This property takes effect only if "hold" is set to "true".
          example: http://example.com/message.wav
          type: string
        hold_media_name:
          description: The media_name of a file to be played to the participant when they are put on hold after joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when "start_conference_on_create" is set to "false". This property takes effect only if "hold" is set to "true".
          example: my_media_uploaded_to_media_storage_api
          type: string
        mute:
          default: false
          description: Whether the participant should be muted immediately after joining the conference.
          example: false
          type: boolean
        start_conference_on_enter:
          default: false
          description: Whether the conference should be started after the participant joins the conference.
          example: true
          type: boolean
        supervisor_role:
          description: Sets the joining participant as a supervisor for the conference. A conference can have multiple supervisors. "barge" means the supervisor enters the conference as a normal participant. This is the same as "none". "monitor" means the supervisor is muted but can hear all participants. "whisper" means that only the specified "whisper_call_control_ids" can hear the supervisor. Defaults to "none".
          enum:
            - barge
            - monitor
            - none
            - whisper
          example: whisper
          type: string
        to:
          description: The DID or SIP URI to dial out and bridge to the given call.
          example: +18005550100 or sip:username@sip.telnyx.com
          type: string
        whisper_call_control_ids:
          description: Array of unique call_control_ids the joining supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only.
          example:
            - v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ
            - v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw
          items:
            type: string
          type: array
      required:
        - call_control_id
        - from
        - to
      title: Conference Dial Request
      type: object
    ConferenceCommandResult:
      example:
        result: ok
      properties:
        result:
          example: ok
          type: string
      required:
        - result
      title: Conference Command Result
      type: object
    ConferenceCreated:
      example:
        event_type: conference.created
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.created
          example: conference.created
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that the participant joined.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Created
      type: object
    ConferenceCreatedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceCreated"
      title: Conference Created Event
      type: object
    ConferenceDetailRecord:
      properties:
        call_leg_id:
          description: Telnyx UUID that identifies the conference call leg
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        call_sec:
          description: Duration of the conference call in seconds
          example: 100
          type: integer
        call_session_id:
          description: Telnyx UUID that identifies with conference call session
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        connection_id:
          description: Connection id
          example: "1583941447772537867"
          type: string
        ended_at:
          description: Conference end time
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        expires_at:
          description: Conference expiry time
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        id:
          description: Conference id
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        is_telnyx_billable:
          description: Indicates whether Telnyx billing charges might be applicable
          example: false
          type: boolean
        name:
          description: Conference name
          example: My Conference
          type: string
        participant_call_sec:
          description: Sum of the conference call duration for all participants in seconds
          example: 100
          type: integer
        participant_count:
          description: Number of participants that joined the conference call
          example: 5
          type: integer
        record_type:
          default: conference_detail_record
          example: conference_detail_record
          type: string
        region:
          description: Region where the conference is hosted
          example: ch1
          type: string
        started_at:
          description: Conference start time
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        user_id:
          description: User id
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
      required:
        - record_type
      type: object
    ConferenceEnded:
      example:
        event_type: conference.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          occured_at: 2018-02-02T22:25:27.521Z
          reason: host_left
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.ended
          example: conference.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that the participant joined.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
            reason:
              description: Reason the conference ended.
              enum:
                - all_left
                - host_left
                - time_exceeded
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Ended
      type: object
    ConferenceEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceEnded"
      title: Conference Ended Event
      type: object
    ConferenceFloorChangedEvent:
      example:
        event_type: conference.floor.changed
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.floor.changed
          example: conference.floor.changed
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Call Control ID of the new speaker.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: Call Leg ID of the new speaker.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: Call Session ID of the new speaker.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that had a speaker change event.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Telnyx connection ID used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Floor Changed
      type: object
    ConferenceHoldRequest:
      example:
        audio_url: http://example.com/message.wav
        call_control_ids:
          - v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
      properties:
        audio_url:
          description: The URL of a file to be played to the participants when they are put on hold. media_name and audio_url cannot be used together in one request.
          example: http://example.com/message.wav
          type: string
        call_control_ids:
          description: List of unique identifiers and tokens for controlling the call. When empty all participants will be placed on hold.
          items:
            type: string
          type: array
        media_name:
          description: The media_name of a file to be played to the participants when they are put on hold. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.
          example: my_media_uploaded_to_media_storage_api
          type: string
      title: Conference Hold Request
      type: object
    ConferenceMuteRequest:
      example:
        call_control_ids:
          - v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
      properties:
        call_control_ids:
          description: Array of unique identifiers and tokens for controlling the call. When empty all participants will be muted.
          items:
            type: string
          type: array
      title: Conference Mute Request
      type: object
    ConferenceParticipantDetailRecord:
      properties:
        billed_sec:
          description: Duration of the conference call for billing purposes
          example: 120
          type: integer
        call_leg_id:
          description: Telnyx UUID that identifies the conference call leg
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        call_sec:
          description: Duration of the conference call in seconds
          example: 100
          type: integer
        call_session_id:
          description: Telnyx UUID that identifies with conference call session
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        conference_id:
          description: Conference id
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        cost:
          description: Currency amount for Telnyx billing cost
          example: "0.004"
          type: string
        currency:
          description: Telnyx account currency used to describe monetary values, including billing cost
          example: USD
          type: string
        destination_number:
          description: Number called by the participant to join the conference
          example: "+18005550199"
          type: string
        id:
          description: Participant id
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        is_telnyx_billable:
          description: Indicates whether Telnyx billing charges might be applicable
          example: true
          type: boolean
        joined_at:
          description: Participant join time
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        left_at:
          description: Participant leave time
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        originating_number:
          description: Participant origin number used in the conference call
          example: "+18005550199"
          type: string
        rate:
          description: Currency amount per billing unit used to calculate the Telnyx billing cost
          example: "0.002"
          type: string
        rate_measured_in:
          description: Billing unit used to calculate the Telnyx billing cost
          example: minutes
          type: string
        record_type:
          default: conference_participant_detail_record
          example: conference_participant_detail_record
          type: string
        user_id:
          description: User id
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
      required:
        - record_type
      type: object
    ConferenceParticipantJoined:
      example:
        event_type: conference.participant.joined
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.participant.joined
          example: conference.participant.joined
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that the participant joined.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Participant Joined
      type: object
    ConferenceParticipantJoinedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceParticipantJoined"
      title: Conference Participant Joined Event
      type: object
    ConferenceParticipantLeft:
      example:
        event_type: conference.participant.left
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.participant.left
          example: conference.participant.left
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: Conference ID that the participant joined.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Participant Left
      type: object
    ConferenceParticipantLeftEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceParticipantLeft"
      title: Conference Participant Left Event
      type: object
    ConferenceParticipantPlaybackEnded:
      example:
        event_type: conference.participant.playback.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          media_url: https://www.example.com/audio.mp3
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.participant.playback.ended
          example: conference.participant.playback.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Participant Playback Ended
      type: object
    ConferenceParticipantPlaybackEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceParticipantPlaybackEnded"
      title: Conference Participant Playback Ended Event
      type: object
    ConferenceParticipantPlaybackStarted:
      example:
        event_type: conference.participant.playback.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          media_url: https://www.example.com/audio.mp3
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.participant.playback.started
          example: conference.participant.playback.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Participant Playback Started
      type: object
    ConferenceParticipantPlaybackStartedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceParticipantPlaybackStarted"
      title: Conference Participant Playback Started Event
      type: object
    ConferenceParticipantSpeakEnded:
      example:
        event_type: conference.participant.speak.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.participant.speak.ended
          example: conference.participant.speak.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Participant Speak Ended
      type: object
    ConferenceParticipantSpeakEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceParticipantSpeakEnded"
      title: Conference Participant Speak Ended Event
      type: object
    ConferenceParticipantSpeakStarted:
      example:
        event_type: conference.participant.speak.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.participant.speak.started
          example: conference.participant.speak.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: State received from a command.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Participant Speak Started
      type: object
    ConferenceParticipantSpeakStartedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceParticipantSpeakStarted"
      title: Conference Participant Speak Started Event
      type: object
    ConferencePlayRequest:
      example:
        audio_url: http://www.example.com/sounds/greeting.wav
      properties:
        audio_url:
          description: The URL of a file to be played back in the conference. media_name and audio_url cannot be used together in one request.
          example: http://example.com/message.wav
          type: string
        call_control_ids:
          description: List of call control ids identifying participants the audio file should be played to. If not given, the audio file will be played to the entire conference.
          items:
            type: string
          type: array
        loop:
          $ref: "#/components/schemas/Loopcount"
          default: 1
          description: The number of times the audio file should be played. If supplied, the value must be an integer between 1 and 100, or the special string `infinity` for an endless loop.
          example: infinity
        media_name:
          description: The media_name of a file to be played back in the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.
          example: my_media_uploaded_to_media_storage_api
          type: string
      title: Conference Play Request
      type: object
    ConferencePlaybackEnded:
      example:
        event_type: conference.playback.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          media_url: https://www.example.com/audio.mp3
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.playback.ended
          example: conference.playback.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Playback Ended
      type: object
    ConferencePlaybackEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferencePlaybackEnded"
      title: Conference Playback Ended Event
      type: object
    ConferencePlaybackStarted:
      example:
        event_type: conference.playback.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          media_url: https://www.example.com/audio.mp3
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.playback.started
          example: conference.playback.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            media_name:
              description: The name of the audio media file being played back, if media_name has been used to start.
              example: my_media_uploaded_to_media_storage_api
              type: string
            media_url:
              description: The audio URL being played back, if audio_url has been used to start.
              example: http://example.com/audio.wav
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Playback Started
      type: object
    ConferencePlaybackStartedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferencePlaybackStarted"
      title: Conference Playback Started Event
      type: object
    ConferenceRecordingSaved:
      example:
        event_type: conference.recording.saved
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          channels: single
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          format: mp3
          public_recording_urls:
            mp3: http://example.com/recording.mp3
            wav: http://example.com/recording.wav
          recording_ended_at: 2018-02-02T22:20:27.521992Z
          recording_id: 4577f9a2-cf0e-44f3-ac57-9f95fb03fa47
          recording_started_at: 2021-05-11T10:17:03.692107Z
          recording_urls:
            mp3: http://example.com/recording.mp3
            wav: http://example.com/recording.wav
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.recording.saved
          example: conference.recording.saved
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_control_id:
              description: Participant's call ID used to issue commands via Call Control API.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            channels:
              description: Whether recording was recorded in `single` or `dual` channel.
              enum:
                - single
                - dual
              example: single
              type: string
            conference_id:
              description: ID of the conference that is being recorded.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              format: uuid
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            format:
              description: The audio file format used when storing the call recording. Can be either `mp3` or `wav`.
              enum:
                - wav
                - mp3
              example: mp3
              type: string
            public_recording_urls:
              description: Recording URLs in requested format. The URL is valid for as long as the file exists. For security purposes, this feature is activated on a per request basis.  Please contact customer support with your Account ID to request activation.
              properties:
                mp3:
                  description: Recording URL in requested `mp3` format.
                  example: http://example.com/recording.mp3
                  nullable: true
                  type: string
                wav:
                  description: Recording URL in requested `wav` format.
                  example: http://example.com/recording.wav
                  nullable: true
                  type: string
              type: object
            recording_ended_at:
              description: ISO 8601 datetime of when recording ended.
              example: 2018-02-02T22:25:27.521992Z
              format: date-time
              type: string
            recording_id:
              description: ID of the conference recording.
              example: 4577f9a2-cf0e-44f3-ac57-9f95fb03fa47
              format: uuid
              type: string
            recording_started_at:
              description: ISO 8601 datetime of when recording started.
              example: 2018-02-02T22:20:27.521992Z
              format: date-time
              type: string
            recording_urls:
              description: Recording URLs in requested format. These URLs are valid for 10 minutes. After 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings documentation, or via Mission Control under Reporting -> Recordings.
              properties:
                mp3:
                  description: Recording URL in requested `mp3` format.
                  example: http://example.com/recording.mp3
                  nullable: true
                  type: string
                wav:
                  description: Recording URL in requested `wav` format.
                  example: http://example.com/recording.wav
                  nullable: true
                  type: string
              type: object
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Recording Saved
      type: object
    ConferenceRecordingSavedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceRecordingSaved"
      title: Conference Recording Saved Event
      type: object
    ConferenceSpeakEnded:
      example:
        event_type: conference.speak.ended
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.speak.ended
          example: conference.speak.ended
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Speak Ended
      type: object
    ConferenceSpeakEndedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceSpeakEnded"
      title: Conference Speak Ended Event
      type: object
    ConferenceSpeakRequest:
      example:
        call_control_ids:
          - v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        language: en-US
        payload: Say this to participants
        payload_type: text
        voice: female
      properties:
        call_control_ids:
          description: Call Control IDs of participants who will hear the spoken text. When empty all participants will hear the spoken text.
          items:
            type: string
          type: array
        command_id:
          description: Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        language:
          description: The language used to speak the text.
          enum:
            - arb
            - cmn-CN
            - cy-GB
            - da-DK
            - de-DE
            - en-AU
            - en-GB
            - en-GB-WLS
            - en-IN
            - en-US
            - es-ES
            - es-MX
            - es-US
            - fr-CA
            - fr-FR
            - hi-IN
            - is-IS
            - it-IT
            - ja-JP
            - ko-KR
            - nb-NO
            - nl-NL
            - pl-PL
            - pt-BR
            - pt-PT
            - ro-RO
            - ru-RU
            - sv-SE
            - tr-TR
          example: en-US
          type: string
        payload:
          description: The text or SSML to be converted into speech. There is a 5,000 character limit.
          example: Say this to participants
          type: string
        payload_type:
          default: text
          description: The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).
          enum:
            - text
            - ssml
          example: ssml
          type: string
        voice:
          description: The gender of the voice used to speak the text.
          enum:
            - male
            - female
          example: female
          type: string
      required:
        - payload
        - voice
        - language
      title: Conference Speak Request
      type: object
    ConferenceSpeakStarted:
      example:
        event_type: conference.speak.started
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          conference_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
          connection_id: 7267xxxxxxxxxxxxxx
          creator_call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          occured_at: 2018-02-02T22:25:27.521Z
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - conference.speak.started
          example: conference.speak.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            conference_id:
              description: ID of the conference the text was spoken in.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            connection_id:
              description: Call Control App ID (formerly Telnyx connection ID) used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            creator_call_session_id:
              description: ID that is unique to the call session that started the conference.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521Z
              format: date-time
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Conference Speak Started
      type: object
    ConferenceSpeakStartedEvent:
      properties:
        data:
          $ref: "#/components/schemas/ConferenceSpeakStarted"
      title: Conference Speak Started Event
      type: object
    ConferenceStopRequest:
      properties:
        call_control_ids:
          description: List of call control ids identifying participants the audio file should stop be played to. If not given, the audio will be stoped to the entire conference.
          items:
            type: string
          type: array
      title: Conference Stop Request
      type: object
    ConferenceUnholdRequest:
      example:
        call_control_ids:
          - v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
      properties:
        call_control_ids:
          description: List of unique identifiers and tokens for controlling the call. Enter each call control ID to be unheld.
          items:
            type: string
          type: array
      required:
        - call_control_ids
      title: Conference Unhold Request
      type: object
    ConferenceUnmuteRequest:
      example:
        call_control_ids:
          - v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
      properties:
        call_control_ids:
          description: List of unique identifiers and tokens for controlling the call. Enter each call control ID to be unmuted. When empty all participants will be unmuted.
          items:
            type: string
          type: array
      title: Conference Unmute Request
      type: object
    Connection:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: string
        created_at: 2018-02-02T22:25:27.521Z
        id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        outbound_voice_profile_id: "1293384261075731499"
        record_type: ip_connection
        updated_at: 2018-02-02T22:25:27.521Z
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
      properties:
        active:
          description: Defaults to true
          example: true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          example: string
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        id:
          description: Identifies the specific resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: int64
          type: string
        outbound_voice_profile_id:
          $ref: "#/components/schemas/OutboundVoiceProfileId"
        record_type:
          description: Identifies the type of the resource.
          example: ip_connection
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          default: null
          description: The URL where webhooks related to this connection will be sent.
          example: https://example.com
          format: url
          nullable: true
          type: string
      title: Connection
      type: object
    ConnectionActive:
      default: true
      description: Specifies whether the connection can be used.
      example: false
      title: Connection Active
      type: boolean
    ConnectionName:
      description: A user-assigned name to help manage the connection.
      example: office-connection
      title: Connection Name
      type: string
    ConnectionRtcpSettings:
      example:
        capture_enabled: true
        port: rtcp-mux
        report_frequency_secs: 10
      properties:
        capture_enabled:
          default: false
          description: BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal.
          example: true
          type: boolean
        port:
          default: rtp+1
          description: RTCP port by default is rtp+1, it can also be set to rtcp-mux
          enum:
            - rtcp-mux
            - rtp+1
        report_frequency_secs:
          default: 5
          description: RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds.
          example: 10
          type: integer
      title: Connection RTCP Settings
      type: object
    ConsumedData:
      description: Represents the amount of data consumed.
      properties:
        amount:
          example: 10
          type: integer
        unit:
          default: B
          example: B
          type: string
      title: ConsumedData
      type: object
    Contact:
      example:
        addresses:
          - city: Menlo Park
            country: United States
            country_code: us
            state: CA
            street: 1 Hacker Way
            type: HOME
            zip: "94025"
          - city: Menlo Park
            country: United States
            country_code: us
            state: CA
            street: 200 Jefferson Dr
            type: WORK
            zip: "94025"
        birthday: 2012-08-18
        emails:
          - email: test@fb.com
            type: WORK
          - email: test@whatsapp.com
            type: WORK
        name:
          first_name: John
          formatted_name: John Smith
          last_name: Smith
        org:
          company: WhatsApp
          department: Design
          title: Manager
        phones:
          - phone: +1 (940) 555-1234
            type: HOME
          - id: "16505551234"
            phone: +1 (650) 555-1234
            type: WORK
        urls:
          - type: WORK
            url: https://www.facebook.com
      properties:
        addresses:
          description: Full contact address(es)
          items:
            $ref: "#/components/schemas/WhatsAppContactAddress"
          type: array
        birthday:
          description: YYYY-MM-DD formatted string
          type: string
        emails:
          description: Contact email address(es)
          items:
            $ref: "#/components/schemas/Email"
          type: array
        ims:
          description: ""
          items:
            type: string
          type: array
        name:
          $ref: "#/components/schemas/Name"
        org:
          $ref: "#/components/schemas/Organization"
        phones:
          description: Contact phone number(s)
          items:
            $ref: "#/components/schemas/Phone"
          type: array
        urls:
          description: Contact URL(s)
          items:
            $ref: "#/components/schemas/Url"
          type: array
      title: Contact
      type: object
    CostInformation:
      example:
        currency: USD
        monthly_cost: "6.54"
        upfront_cost: "3.21"
      properties:
        currency:
          description: The ISO 4217 code for the currency.
          example: USD
          type: string
        monthly_cost:
          example: "6.54"
          type: string
        upfront_cost:
          example: "3.21"
          type: string
      type: object
    CreateCallControlApplicationRequest:
      example:
        active: false
        anchorsite_override: '"Latency"'
        application_name: call-router
        dtmf_type: Inband
        first_command_timeout: true
        first_command_timeout_secs: 10
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          default: true
          description: Specifies whether the connection can be used.
          type: boolean
        anchorsite_override:
          default: '"Latency"'
          description: |
            <code>Latency</code> directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.
          enum:
            - '"Latency"'
            - '"Chicago, IL"'
            - '"Ashburn, VA"'
            - '"San Jose, CA"'
          example: '"Amsterdam, Netherlands"'
          type: string
        application_name:
          description: A user-assigned name to help manage the application.
          example: call-router
          type: string
        dtmf_type:
          default: RFC 2833
          description: Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
          enum:
            - RFC 2833
            - Inband
            - SIP INFO
          example: Inband
          type: string
        first_command_timeout:
          default: false
          description: Specifies whether calls to phone numbers associated with this connection should hangup after timing out.
          example: true
          type: boolean
        first_command_timeout_secs:
          default: 30
          description: Specifies how many seconds to wait before timing out a dial command.
          example: 10
          type: integer
        inbound:
          $ref: "#/components/schemas/CallControlApplicationInbound"
        outbound:
          $ref: "#/components/schemas/CallControlApplicationOutbound"
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      required:
        - application_name
        - webhook_event_url
      title: Create Call Control Application Request
      type: object
    CreateConferenceRequest:
      example:
        beep_enabled: always
        call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        duration_minutes: 5
        hold_audio_url: http://www.example.com/audio.wav
        name: Business
        start_conference_on_create: false
      properties:
        beep_enabled:
          default: never
          description: Whether a beep sound should be played when participants join and/or leave the conference.
          enum:
            - always
            - never
            - on_enter
            - on_exit
          example: on_exit
          type: string
        call_control_id:
          description: Unique identifier and token for controlling the call
          example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        comfort_noise:
          default: true
          description: Toggle background comfort noise.
          example: false
          type: boolean
        command_id:
          description: Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        duration_minutes:
          description: Time length (minutes) after which the conference will end.
          example: 5
          type: integer
        hold_audio_url:
          description: The URL of a file to be played to participants joining the conference. The URL can point to either a WAV or MP3 file. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when "start_conference_on_create" is set to "false".
          example: http://example.com/message.wav
          type: string
        hold_media_name:
          description: The media_name of a file to be played to participants joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when "start_conference_on_create" is set to "false".
          example: my_media_uploaded_to_media_storage_api
          type: string
        name:
          description: Name of the conference
          example: Business
          type: string
        start_conference_on_create:
          description: Whether the conference should be started on creation. If the conference isn't started all participants that join are automatically put on hold. Defaults to "true".
          example: false
          type: boolean
      required:
        - call_control_id
        - name
      title: Create Conference Request
      type: object
    CreateCredentialConnectionRequest:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: my name
        default_on_hold_comfort_noise_enabled: false
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        inbound:
          ani_number_format: +E.164
          channel_limit: 10
          codecs: G722
          default_routing_method: sequential
          dnis_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          timeout_1xx_secs: 10
          timeout_2xx_secs: 20
        onnet_t38_passthrough_enabled: true
        outbound:
          ani_override: always
          call_parking_enabled: true
          channel_limit: 10
          generate_ringback_tone: true
          instant_ringback_enabled: true
          localization: US
          outbound_voice_profile_id: "1293384261075731499"
          t38_reinvite_source: telnyx
        password: my123secure456password789
        rtcp_settings:
          capture_enabled: true
          port: rtcp-mux
          report_frequency_seconds: 10
        sip_uri_calling_preference: " disabled"
        user_name: myusername123
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          description: Defaults to true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          type: string
        default_on_hold_comfort_noise_enabled:
          default: false
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        inbound:
          $ref: "#/components/schemas/CredentialInbound"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
          type: boolean
        outbound:
          $ref: "#/components/schemas/CredentialOutbound"
        password:
          description: The password to be used as part of the credentials. Must be 8 to 128 characters long.
          example: my123secure456password789
          type: string
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        sip_uri_calling_preference:
          default: disabled
          description: This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).
          enum:
            - disabled
            - unrestricted
            - internal
          type: string
        user_name:
          description: The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).
          example: myusername123
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      required:
        - user_name
        - password
        - connection_name
      title: Create Credential Connection Request
      type: object
    CreateDocServiceDocumentRequest:
      oneOf:
        - $ref: "#/components/schemas/DocServiceDocumentUploadURL"
        - $ref: "#/components/schemas/DocServiceDocumentUploadInline"
    CreateFaxApplicationRequest:
      example:
        active: false
        anchorsite_override: Amsterdam, Netherlands
        application_name: fax-router
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          $ref: "#/components/schemas/ConnectionActive"
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        application_name:
          $ref: "#/components/schemas/ApplicationName"
        inbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            sip_subdomain:
              default: null
              description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
              example: example
              type: string
            sip_subdomain_receive_settings:
              default: from_anyone
              description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
              enum:
                - only_my_connections
                - from_anyone
              example: only_my_connections
              type: string
          type: object
        outbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            outbound_voice_profile_id:
              $ref: "#/components/schemas/OutboundVoiceProfileId"
          type: object
        webhook_event_failover_url:
          $ref: "#/components/schemas/WebhookEventFailoverUrl"
        webhook_event_url:
          $ref: "#/components/schemas/WebhookEventUrl"
        webhook_timeout_secs:
          $ref: "#/components/schemas/WebhookTimeoutSecs"
      required:
        - application_name
        - webhook_event_url
      title: Create Fax Application Request
      type: object
    CreateFqdnConnectionRequest:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: string
        default_on_hold_comfort_noise_enabled: true
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        inbound:
          ani_number_format: +E.164
          channel_limit: 10
          codecs:
            - G722
          default_routing_method: sequential
          dnis_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          sip_region: US
          sip_subdomain: string
          sip_subdomain_receive_settings: only_my_connections
          timeout_1xx_secs: 10
          timeout_2xx_secs: 10
        onnet_t38_passthrough_enabled: true
        rtcp_settings:
          capture_enabled: true
          port: rtcp-mux
          report_frequency_secs: 10
        transport_protocol: UDP
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          default: true
          description: Defaults to true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          type: string
        default_on_hold_comfort_noise_enabled:
          default: true
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        inbound:
          $ref: "#/components/schemas/InboundFqdn"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
          type: boolean
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        transport_protocol:
          $ref: "#/components/schemas/FqdnConnectionTransportProtocol"
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      required:
        - connection_name
      title: Create FQDN Connection Request
    CreateFqdnRequest:
      example:
        connection_id: "1516447646313612565"
        dns_record_type: a
        fqdn: example.com
        port: 8080
      properties:
        connection_id:
          description: ID of the FQDN connection to which this IP should be attached.
          type: string
        dns_record_type:
          description: The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.
          example: a
          type: string
        fqdn:
          description: FQDN represented by this resource.
          example: example.com
          type: string
        port:
          default: 5060
          description: Port to use when connecting to this FQDN.
          example: 5060
          nullable: true
          type: integer
      required:
        - fqdn
        - dns_record_type
        - connection_id
      title: Create FQDN Request
      type: object
    CreateInboundIpRequest:
      example:
        ani_number_format: +E.164
        channel_limit: 10
        codecs: G722
        default_routing_method: sequential
        dnis_number_format: +e164
        generate_ringback_tone: true
        isup_headers_enabled: true
        prack_enabled: true
        privacy_zone_enabled: true
        sip_compact_headers_enabled: true
        sip_region: US
        sip_subdomain: test
        sip_subdomain_receive_settings: only_my_connections
        timeout_1xx_secs: 10
        timeout_2xx_secs: 20
      properties:
        ani_number_format:
          default: E.164-national
          description: This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.
          enum:
            - +E.164
            - E.164
            - +E.164-national
            - E.164-national
          type: string
        channel_limit:
          default: null
          description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
          type: integer
        codecs:
          default:
            - G722
            - G711U
            - G711A
            - G729
            - OPUS
            - H.264
          description: "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP."
          items:
            type: string
          type: array
        default_routing_method:
          description: Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed.
          enum:
            - sequential
            - round-robin
          type: string
        dnis_number_format:
          default: e164
          enum:
            - +e164
            - e164
            - national
            - sip_username
          type: string
        generate_ringback_tone:
          default: false
          description: Generate ringback tone through 183 session progress message with early media.
          type: boolean
        isup_headers_enabled:
          default: false
          description: When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)
          type: boolean
        prack_enabled:
          default: false
          description: Enable PRACK messages as defined in RFC3262.
          type: boolean
        privacy_zone_enabled:
          default: false
          description: By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.
          type: boolean
        sip_compact_headers_enabled:
          default: true
          description: Defaults to true.
          type: boolean
        sip_region:
          default: US
          description: Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used.
          enum:
            - US
            - Europe
            - Australia
          type: string
        sip_subdomain:
          description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
          type: string
        sip_subdomain_receive_settings:
          description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
          enum:
            - only_my_connections
            - from_anyone
          type: string
        timeout_1xx_secs:
          default: 3
          description: Time(sec) before aborting if connection is not made.
          maximum: 120
          minimum: 1
          type: integer
        timeout_2xx_secs:
          default: 90
          description: "Time(sec) before aborting if call is unanswered (min: 1, max: 600)."
          type: integer
      title: Create Inbound Ip Request
      type: object
    CreateIpConnectionRequest:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: string
        default_on_hold_comfort_noise_enabled: true
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        "inbound:":
          ani_number_format: +E.164
          channel_limit: 10
          codecs: G722
          default_primary_ip_id: 192.168.0.0
          default_routing_method: sequential
          default_secondary_ip_id: 192.168.0.0
          default_tertiary_ip_id: 192.168.0.0
          dns_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          sip_region: US
          sip_subdomain: test
          sip_subdomain_receive_settings: only_my_connections
          timeout_1xx_secs: 10
          timeout_2xx_secs: 20
        onnet_t38_passthrough_enabled: false
        outbound:
          ani_override: string
          ani_override_type: always
          call_parking_enabled: true
          channel_limit: 10
          generate_ringback_tone: true
          instant_ringback_enabled: true
          ip_authentication_method: token
          ip_authentication_token: string
          localization: string
          outbound_voice_profile_id: "1293384261075731499"
          t38_reinvite_source: telnyx
          tech_prefix: string
        rtcp_settings:
          capture_enabled: true
          port: rtcp-mux
          report_frequency_secs: 10
        transport_protocol: UDP
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          description: Defaults to true
          example: true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          example: string
          type: string
        default_on_hold_comfort_noise_enabled:
          default: true
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          example: true
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          example: true
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        inbound:
          $ref: "#/components/schemas/CreateInboundIpRequest"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
          example: false
          type: boolean
        outbound:
          $ref: "#/components/schemas/OutboundIp"
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        transport_protocol:
          default: UDP
          description: One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.
          enum:
            - UDP
            - TCP
            - TLS
          example: UDP
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      title: Create IP Connection Request
    CreateIpRequest:
      example:
        connection_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        ip_address: 192.168.0.0
        port: 5060
      properties:
        connection_id:
          description: ID of the IP Connection to which this IP should be attached.
          type: string
        ip_address:
          description: IP adddress represented by this resource.
          example: 192.168.0.0
          type: string
        port:
          default: 5060
          description: Port to use when connecting to this IP.
          example: 5060
          type: integer
      required:
        - ip_address
      title: Create Ip Request
      type: object
    CreateLongCodeMessageRequest:
      example:
        from: "+18445550001"
        media_urls:
          - http://example.com
        subject: From Telnyx!
        text: Hello, World!
        to: "+13125550002"
        type: MMS
        use_profile_webhooks: true
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: http://example.com/webhooks
      properties:
        auto_detect:
          default: false
          description: Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.
          type: boolean
        from:
          description: Phone number, in +E.164 format, used to send the message.
          format: address
          type: string
        media_urls:
          description: |-
            A list of media URLs. The total media size must be less than 1 MB.

            **Required for MMS**
          items:
            format: url
            type: string
          type: array
        subject:
          description: Subject of multimedia message
          type: string
        text:
          description: |-
            Message body (i.e., content) as a non-empty string.

            **Required for SMS**
          type: string
        to:
          $ref: "#/components/schemas/ToNumber"
        type:
          description: The protocol for sending the message, either SMS or MMS.
          enum:
            - SMS
            - MMS
          type: string
        use_profile_webhooks:
          default: true
          description: If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.
          type: boolean
        webhook_failover_url:
          description: The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
          format: url
          type: string
        webhook_url:
          description: The URL where webhooks related to this message will be sent.
          format: url
          type: string
      required:
        - from
        - to
      type: object
    CreateManagedAccountRequest:
      example:
        business_name: Larry's Cat Food Inc
        email: larry_cat_food@customer.org
        password: 3jVjLq!tMuWKyWx4NN*CvhnB
      properties:
        business_name:
          description: The name of the business for which the new managed account is being created, that will be used as the managed accounts's organization's name.
          example: Larry's Cat Food Inc
          type: string
        email:
          description: The email address for the managed account. If not provided, the email address will be generated based on the email address of the manager account.
          example: new_managed_account@customer.org
          type: string
        password:
          description: Password for the managed account. If a password is not supplied, the account will not be able to be signed into directly. (A password reset may still be performed later to enable sign-in via password.)
          example: 3jVjLq!tMuWKyWx4NN*CvhnB
          type: string
      required:
        - business_name
      title: Create Managed Account Request
    CreateMessageRequest:
      example:
        from: "+18445550001"
        media_urls:
          - http://example.com
        messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
        subject: From Telnyx!
        text: Hello, World!
        to: "+18445550001"
        type: MMS
        use_profile_webhooks: true
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: http://example.com/webhooks
      properties:
        auto_detect:
          default: false
          description: Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.
          type: boolean
        from:
          description: |
            Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).

            **Required if sending with a phone number, short code, or alphanumeric sender ID.**
          format: address
          type: string
        media_urls:
          description: |-
            A list of media URLs. The total media size must be less than 1 MB.

            **Required for MMS**
          items:
            format: url
            type: string
          type: array
        messaging_profile_id:
          description: |
            Unique identifier for a messaging profile.

            **Required if sending via number pool or with an alphanumeric sender ID.**
          type: string
        subject:
          description: Subject of multimedia message
          type: string
        text:
          description: |-
            Message body (i.e., content) as a non-empty string.

            **Required for SMS**
          type: string
        to:
          $ref: "#/components/schemas/ToNumber"
        type:
          description: The protocol for sending the message, either SMS or MMS.
          enum:
            - SMS
            - MMS
          type: string
        use_profile_webhooks:
          default: true
          description: If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.
          type: boolean
        webhook_failover_url:
          description: The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
          format: url
          type: string
        webhook_url:
          description: The URL where webhooks related to this message will be sent.
          format: url
          type: string
      required:
        - to
      type: object
    CreateMessagingHostedNumberOrderRequest:
      example:
        messaging_profile_id: dc8f39ac-953d-4520-b93b-786ae87db0da
        phone_numbers:
          - "+18665550001"
          - "+18665550002"
      properties:
        messaging_profile_id:
          description: Automatically associate the number with this messaging profile ID when the order is complete.
          type: string
        phone_numbers:
          description: Phone numbers to be used for hosted messaging.
          items:
            format: +E.164
            type: string
          type: array
      type: object
    CreateMessagingProfileRequest:
      example:
        enabled: true
        name: My name
        number_pool_settings:
          geomatch: false
          long_code_weight: 1
          skip_unhealthy: true
          sticky_sender: false
          toll_free_weight: 10
        url_shortener_settings:
          domain: example.ex
          prefix: ""
          replace_blacklist_only: true
          send_webhooks: false
        webhook_api_version: "2"
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: https://www.example.com/hooks
      properties:
        enabled:
          default: true
          description: Specifies whether the messaging profile is enabled or not.
          type: boolean
        name:
          description: A user friendly name for the messaging profile.
          type: string
        number_pool_settings:
          $ref: "#/components/schemas/NumberPoolSettings"
        url_shortener_settings:
          $ref: "#/components/schemas/UrlShortenerSettings"
        webhook_api_version:
          default: "2"
          description: Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.
          enum:
            - "1"
            - "2"
            - 2010-04-01
          type: string
        webhook_failover_url:
          default: ""
          description: The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.
          format: url
          nullable: true
          type: string
        webhook_url:
          default: ""
          description: The URL where webhooks related to this messaging profile will be sent.
          format: url
          nullable: true
          type: string
      required:
        - name
      type: object
    CreateMultiPartDocServiceDocumentRequest:
      properties:
        file:
          description: The file you are uploading.
          format: binary
          type: string
      type: object
    CreateNumberBlockOrderRequest:
      example:
        range: 10
        starting_number: "+19705555000"
      properties:
        connection_id:
          description: Identifies the connection associated with this phone number.
          example: "346789098765567"
          type: string
        created_at:
          description: An ISO 8901 datetime string denoting when the number order was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        errors:
          description: Errors the reservation could happen upon
          example: Number is already on hold
          readOnly: true
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        messaging_profile_id:
          description: Identifies the messaging profile associated with the phone number.
          example: abc85f64-5717-4562-b3fc-2c9600
          type: string
        phone_numbers_count:
          description: The count of phone numbers in the number order.
          example: 10
          readOnly: true
          type: integer
        range:
          description: The phone number range included in the block.
          example: 10
          type: integer
          writeOnly: true
        record_type:
          example: number_block_order
          readOnly: true
          type: string
        requirements_met:
          description: True if all requirements are met for every phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        starting_number:
          description: Starting phone number block
          example: "+19705555000"
          format: e164_phone_number
          type: string
          writeOnly: true
        status:
          description: The status of the order.
          enum:
            - pending
            - success
            - failure
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the number order was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
      required:
        - starting_number
        - range
    CreateNumberOrderDocumentRequest:
      example:
        created_at: 2018-01-01T00:00:00.000000Z
        customer_reference: MY REF 001
        file_id: 1e3c5822-0362-4702-8e46-5a129f0d3976
        id: 387d1e31-a218-4375-8151-103f2d5e2d2c
        record_type: number_order_document
        requirement_type: address_proof
        requirements_id: 36aaf27d-986b-493c-bd1b-de16af2e4292
      properties:
        created_at:
          description: An ISO 8901 datetime string denoting when the number order document was uploaded.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        file_id:
          description: The id of the file to associate as a number order document.
          example: 1e3c5822-0362-4702-8e46-5a129f0d3976
          type: string
        id:
          example: 387d1e31-a218-4375-8151-103f2d5e2d2c
          format: uuid
          readOnly: true
          type: string
        record_type:
          example: number_order_document
          readOnly: true
          type: string
        requirement_type:
          enum:
            - address_proof
            - identification
            - reg_form
          readOnly: true
          type: string
        requirements_id:
          description: Unique id for a requirement.
          example: 36aaf27d-986b-493c-bd1b-de16af2e4292
          type: string
    CreateNumberOrderRequest:
      example:
        billing_group_id: abc85f64-5717-4562-b3fc-2c9600
        connection_id: "346789098765567"
        created_at: 2018-01-01T00:00:00.000000Z
        customer_reference: MY REF 001
        id: 12ade33a-21c0-473b-b055-b3c836e1c292
        messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600
        phone_numbers:
          - id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
            phone_number: "+19705555098"
            record_type: number_order_phone_number
            regulatory_group_id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
            regulatory_requirements:
              - field_type: address
                field_value: 45f45a04-b4be-4592-95b1-9306b9db2b21
                record_type: phone_number_regulatory_requirement
                requirement_id: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
            requirements_met: true
            status: success
        phone_numbers_count: 1
        record_type: number_order
        requirements_met: true
        status: pending
        updated_at: 2018-01-01T00:00:00.000000Z
      properties:
        billing_group_id:
          description: Identifies the billing group associated with the phone number.
          example: abc85f64-5717-4562-b3fc-2c9600
          type: string
        connection_id:
          description: Identifies the connection associated with this phone number.
          example: "346789098765567"
          type: string
        created_at:
          description: An ISO 8901 datetime string denoting when the number order was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        messaging_profile_id:
          description: Identifies the messaging profile associated with the phone number.
          example: abc85f64-5717-4562-b3fc-2c9600
          type: string
        phone_numbers:
          items:
            $ref: "#/components/schemas/PhoneNumber"
          type: array
          writeOnly: true
        phone_numbers_count:
          description: The count of phone numbers in the number order.
          example: 1
          readOnly: true
          type: integer
        record_type:
          example: number_order
          readOnly: true
          type: string
        requirements_met:
          description: True if all requirements are met for every phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        status:
          description: The status of the order.
          enum:
            - pending
            - success
            - failure
          example: success
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the number order was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
    CreateNumberPoolMessageRequest:
      example:
        from: "+18445550001"
        media_urls:
          - http://example.com
        messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
        subject: From Telnyx!
        text: Hello, World!
        to:
          - "+13125550002"
        type: MMS
        use_profile_webhooks: true
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: http://example.com/webhooks
      properties:
        auto_detect:
          default: false
          description: Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.
          type: boolean
        media_urls:
          description: |-
            A list of media URLs. The total media size must be less than 1 MB.

            **Required for MMS**
          items:
            format: url
            type: string
          type: array
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          type: string
        subject:
          description: Subject of multimedia message
          type: string
        text:
          description: |-
            Message body (i.e., content) as a non-empty string.

            **Required for SMS**
          type: string
        to:
          $ref: "#/components/schemas/ToNumber"
        type:
          description: The protocol for sending the message, either SMS or MMS.
          enum:
            - SMS
            - MMS
          type: string
        use_profile_webhooks:
          default: true
          description: If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.
          type: boolean
        webhook_failover_url:
          description: The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
          format: url
          type: string
        webhook_url:
          description: The URL where webhooks related to this message will be sent.
          format: url
          type: string
      required:
        - to
        - messaging_profile_id
      type: object
    CreateNumberReservationRequest:
      example:
        created_at: 2018-01-01T00:00:00.000000Z
        customer_reference: MY REF 001
        id: 12ade33a-21c0-473b-b055-b3c836e1c292
        phone_numbers:
          - created_at: 2018-01-01T00:00:00.000000Z
            expired_at: 2018-01-01T00:00:00.000000Z
            id: 12ade33a-21c0-473b-b055-b3c836e1c292
            phone_number: "+19705555098"
            record_type: reserved_phone_number
            status: pending
            updated_at: 2018-01-01T00:00:00.000000Z
        record_type: number_reservation
        status: pending
        updated_at: 2018-01-01T00:00:00.000000Z
      properties:
        created_at:
          description: An ISO 8901 datetime string denoting when the numbers reservation was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        phone_numbers:
          items:
            $ref: "#/components/schemas/ReservedPhoneNumber"
          type: array
        record_type:
          example: number_reservation
          readOnly: true
          type: string
        status:
          description: The status of the entire reservation.
          enum:
            - pending
            - success
            - failure
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the number reservation was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
    CreateOutboundVoiceProfileRequest:
      example:
        billing_group_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        concurrent_call_limit: 10
        daily_spend_limit: "100.00"
        daily_spend_limit_enabled: true
        enabled: true
        max_destination_rate: 10
        name: office
        service_plan: global
        tags:
          - office-profile
        traffic_type: conversational
        usage_payment_method: rate-deck
        whitelisted_destinations:
          - US
          - BR
          - AU
      properties:
        billing_group_id:
          default: null
          description: The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          nullable: true
          type: string
        call_recording:
          $ref: "#/components/schemas/OutboundCallRecording"
        concurrent_call_limit:
          description: Must be no more than your global concurrent call limit. Null means no limit.
          example: 10
          nullable: true
          type: integer
        daily_spend_limit:
          description: The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.
          example: "100.00"
          type: string
        daily_spend_limit_enabled:
          default: false
          description: Specifies whether to enforce the daily_spend_limit on this outbound voice profile.
          example: true
          type: boolean
        enabled:
          default: true
          description: Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.
          example: true
          type: boolean
        max_destination_rate:
          description: Maximum rate (price per minute) for a Destination to be allowed when making outbound calls.
          type: number
        name:
          description: A user-supplied name to help with organization.
          example: office
          minLength: 3
          type: string
        service_plan:
          $ref: "#/components/schemas/ServicePlan"
        tags:
          example:
            - office-profile
          items:
            type: string
          type: array
        traffic_type:
          $ref: "#/components/schemas/TrafficType"
        usage_payment_method:
          $ref: "#/components/schemas/UsagePaymentMethod"
        whitelisted_destinations:
          default:
            - US
            - CA
          description: The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.
          example:
            - US
            - BR
            - AU
          items:
            type: string
          type: array
      required:
        - name
      title: Outbound Voice Profile
      type: object
    CreatePortingOrder:
      properties:
        phone_numbers:
          description: The list of +E.164 formatted phone numbers
          example:
            - "+13035550000"
            - "+13035550001"
            - "+13035550002"
          items:
            type: string
          type: array
      required:
        - phone_numbers
      title: CreatePortingOrder
      type: object
    CreatePortingOrderComment:
      properties:
        body:
          example: Please, let me know when the port completes
          type: string
      type: object
    CreateRoomClientTokenRequest:
      properties:
        refresh_token_ttl_secs:
          default: 3600
          description: The time to live in seconds of the Refresh Token, after that time the Refresh Token is invalid and can't be used to refresh Client Token.
          example: 3600
          maximum: 86400
          minimum: 60
          type: integer
        token_ttl_secs:
          default: 600
          description: The time to live in seconds of the Client Token, after that time the Client Token is invalid and can't be used to join a Room.
          example: 600
          maximum: 3600
          minimum: 10
          type: integer
      type: object
    CreateRoomRequest:
      properties:
        max_participants:
          default: 10
          description: The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected.
          example: 10
          maximum: 50
          minimum: 2
          type: integer
        unique_name:
          description: The unique (within the Telnyx account scope) name of the room.
          example: My room
          type: string
      type: object
    CreateShortCodeMessageRequest:
      example:
        from: "+18445550001"
        media_urls:
          - http://example.com
        subject: From Telnyx!
        text: Hello, World!
        to: "+18445550001"
        type: MMS
        use_profile_webhooks: true
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: http://example.com/webhooks
      properties:
        auto_detect:
          default: false
          description: Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.
          type: boolean
        from:
          description: Phone number, in +E.164 format, used to send the message.
          format: address
          type: string
        media_urls:
          description: |-
            A list of media URLs. The total media size must be less than 1 MB.

            **Required for MMS**
          items:
            format: url
            type: string
          type: array
        subject:
          description: Subject of multimedia message
          type: string
        text:
          description: |-
            Message body (i.e., content) as a non-empty string.

            **Required for SMS**
          type: string
        to:
          $ref: "#/components/schemas/ToNumber"
        type:
          description: The protocol for sending the message, either SMS or MMS.
          enum:
            - SMS
            - MMS
          type: string
        use_profile_webhooks:
          default: true
          description: If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.
          type: boolean
        webhook_failover_url:
          description: The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
          format: url
          type: string
        webhook_url:
          description: The URL where webhooks related to this message will be sent.
          format: url
          type: string
      required:
        - from
        - to
      type: object
    CreateTexmlApplicationRequest:
      example:
        active: false
        anchorsite_override: Amsterdam, Netherlands
        dtmf_type: Inband
        first_command_timeout: true
        first_command_timeout_secs: 10
        friendly_name: call-router
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        status_callback: https://example.com
        status_callback_method: get
        voice_fallback_url: https://fallback.example.com
        voice_method: get
        voice_url: https://example.com
      properties:
        active:
          $ref: "#/components/schemas/ConnectionActive"
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        first_command_timeout:
          $ref: "#/components/schemas/FirstCommandTimeout"
        first_command_timeout_secs:
          $ref: "#/components/schemas/FirstCommandTimeoutSecs"
        friendly_name:
          $ref: "#/components/schemas/ApplicationName"
        inbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            sip_subdomain:
              default: null
              description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
              example: example
              type: string
            sip_subdomain_receive_settings:
              default: from_anyone
              description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
              enum:
                - only_my_connections
                - from_anyone
              example: only_my_connections
              type: string
          type: object
        outbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            outbound_voice_profile_id:
              $ref: "#/components/schemas/OutboundVoiceProfileId"
          type: object
        status_callback:
          default: null
          description: URL for Telnyx to send requests to containing information about call progress events.
          example: https://example.com
          format: url
          type: string
        status_callback_method:
          default: post
          description: HTTP request method Telnyx should use when requesting the status_callback URL.
          enum:
            - get
            - post
          example: get
          type: string
        voice_fallback_url:
          default: null
          description: URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.
          example: https://fallback.example.com
          format: url
          type: string
        voice_method:
          default: post
          description: HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.
          enum:
            - get
            - post
          example: get
          type: string
        voice_url:
          description: URL to which Telnyx will deliver your XML Translator webhooks.
          example: https://example.com
          format: url
          type: string
      required:
        - friendly_name
        - voice_url
      title: Create Texml Application Request
      type: object
    CreateVerificationRequestCall:
      description: The request body when creating a verification.
      properties:
        call_timeout_secs:
          description: Must be less than the profile's default_verification_timeout_secs or timeout_secs, whichever is lesser.
          example: 30
          type: integer
        phone_number:
          description: +E164 formatted phone number.
          example: "+13035551234"
          type: string
        timeout_secs:
          description: The number of seconds the verification code is valid for.
          example: 300
          type: integer
        verify_profile_id:
          description: The identifier of the associated Verify profile.
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          type: string
      required:
        - phone_number
        - verify_profile_id
      title: CreateVerificationRequestCall
      type: object
    CreateVerificationRequestFlashcall:
      description: The request body when creating a verification.
      properties:
        phone_number:
          description: +E164 formatted phone number.
          example: "+13035551234"
          type: string
        timeout_secs:
          description: The number of seconds the verification code is valid for.
          example: 300
          type: integer
        verify_profile_id:
          description: The identifier of the associated Verify profile.
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          type: string
      required:
        - phone_number
        - verify_profile_id
      title: CreateVerificationRequestFlashcall
      type: object
    CreateVerificationRequestPSD2:
      description: The request body when creating a verification.
      properties:
        amount:
          example: "99.99"
          type: string
        currency:
          $ref: "#/components/schemas/Currencies"
        payee:
          example: Acme Corp Inc. LTD
          type: string
        phone_number:
          description: +E164 formatted phone number.
          example: "+13035551234"
          type: string
        timeout_secs:
          description: The number of seconds the verification code is valid for.
          example: 300
          type: integer
        verify_profile_id:
          description: The identifier of the associated Verify profile.
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          type: string
      required:
        - phone_number
        - verify_profile_id
        - currency
        - amount
        - payee
      title: CreateVerificationRequestPSD2
      type: object
    CreateVerificationRequestSMS:
      description: The request body when creating a verification.
      properties:
        phone_number:
          description: +E164 formatted phone number.
          example: "+13035551234"
          type: string
        timeout_secs:
          description: The number of seconds the verification code is valid for.
          example: 300
          type: integer
        verify_profile_id:
          description: The identifier of the associated Verify profile.
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          type: string
      required:
        - phone_number
        - verify_profile_id
      title: CreateVerificationRequestSMS
      type: object
    CreateVerificationRequestWhatsapp:
      description: The request body when creating a verification.
      properties:
        phone_number:
          description: +E164 formatted phone number.
          example: "+13035551234"
          type: string
        timeout_secs:
          description: The number of seconds the verification code is valid for.
          example: 300
          type: integer
        verify_profile_id:
          description: The identifier of the associated Verify profile.
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          type: string
      required:
        - phone_number
        - verify_profile_id
      title: CreateVerificationRequestWhatsapp
      type: object
    CreateVerificationResponse:
      properties:
        data:
          $ref: "#/components/schemas/Verification"
      required:
        - data
      title: CreateVerifyVerificationResponse
      type: object
    CreateVerifyProfileCallRequest:
      properties:
        default_call_timeout_secs:
          default: 45
          description: Must be less than default_verification_timeout_secs
          example: 30
          type: integer
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
        speech_template:
          description: Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code.
          example: "Hello, this is the Acme Inc verification code you requested: {code}."
          type: string
      required:
        - name
      title: CreateVerifyProfileCallRequest
      type: object
    CreateVerifyProfileFlashcallRequest:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      required:
        - name
      title: CreateVerifyProfileFlashcallRequest
      type: object
    CreateVerifyProfilePSD2Request:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      title: CreateVerifyProfilePSD2Request
      type: object
    CreateVerifyProfileSMSRequest:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
        messaging_enabled:
          description: Enables SMS text messaging for the Verify profile.
          example: true
          type: boolean
        messaging_template:
          description: Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code.
          example: "Hello, this is the Acme Inc verification code you requested: {code}."
          type: string
        rcs_enabled:
          description: Enables RCS messaging for the Verify profile.
          example: true
          type: boolean
        vsms_enabled:
          description: Enables VSMS for the Verify profile.
          example: true
          type: boolean
      title: CreateVerifyProfileSMSRequest
      type: object
    CreateVerifyProfileWhatsappRequest:
      properties:
        app_name:
          description: The name that identifies the application requesting 2fa in the verification message.
          example: Example Secure App
          type: string
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      title: CreateVerifyProfileWhatsappRequest
      type: object
    CreateWhatsAppMessageRequest:
      example:
        preview_url: true
        text:
          body: "Check out this site: http://www.telnyx.com"
        to: "15125557878"
        type: text
      properties:
        audio:
          $ref: "#/components/schemas/Audio"
        contacts:
          description: ""
          items:
            $ref: "#/components/schemas/Contact"
          type: array
        document:
          $ref: "#/components/schemas/Document"
        hsm:
          $ref: "#/components/schemas/Hsm"
        image:
          $ref: "#/components/schemas/Image"
        location:
          $ref: "#/components/schemas/Location"
        preview_url:
          description: |-
            Specifying preview_url in the request is optional when not including a URL in your message.
            To include a URL preview, set preview_url to true in the message body and make sure the URL begins with http:// or https://.
          type: boolean
        template:
          $ref: "#/components/schemas/Template"
        text:
          $ref: "#/components/schemas/Text"
        to:
          description: The WhatsApp ID (phone number) returned from contacts endpoint.
          type: string
        type:
          $ref: "#/components/schemas/MessageType"
        video:
          $ref: "#/components/schemas/Video"
        whatsapp_user_id:
          description: The sender's WhatsApp ID.
          type: string
      required:
        - to
        - whatsapp_user_id
      title: Send Message Request Body
      type: object
    CreatedAt:
      description: ISO 8601 formatted date indicating when the resource was created.
      example: 2020-02-02T22:25:27.521Z
      title: Created At
      type: string
    CredentialConnection:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: string
        created_at: 2018-02-02T22:25:27.521Z
        default_on_hold_comfort_noise_enabled: true
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        inbound:
          ani_number_format: +E.164
          channel_limit: 10
          codecs:
            - G722
          dnis_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          timeout_1xx_secs: 10
          timeout_2xx_secs: "15"
        onnet_t38_passthrough_enabled: true
        outbound:
          ani_override: string
          ani_override_type: always
          call_parking_enabled: true
          channel_limit: 10
          generate_ringback_tone: true
          instant_ringback_enabled: true
          localization: string
          outbound_voice_profile_id: "1293384261075731499"
          t38_reinvite_source: telnyx
        password: my123secure456password789
        record_type: credential_connection
        rtcp_settings:
          capture_enabled: true
          port: rtp+1
          report_frequency_seconds: 10
        sip_uri_calling_preference: disabled
        updated_at: 2018-02-02T22:25:27.521Z
        user_name: myusername123
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          description: Defaults to true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          type: string
        created_at:
          description: ISO-8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        default_on_hold_comfort_noise_enabled:
          default: true
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        id:
          description: Identifies the type of resource.
          example: "1293384261075731499"
          format: int64
          type: string
        inbound:
          $ref: "#/components/schemas/CredentialInbound"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
          type: boolean
        outbound:
          $ref: "#/components/schemas/CredentialOutbound"
        password:
          description: The password to be used as part of the credentials. Must be 8 to 128 characters long.
          example: my123secure456password789
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: credential_connection
          type: string
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        sip_uri_calling_preference:
          default: null
          description: This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).
          enum:
            - disabled
            - unrestricted
            - internal
          example: disabled
          type: string
        updated_at:
          description: ISO-8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
        user_name:
          description: The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).
          example: myusername123
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      title: Credential Connection
      type: object
    CredentialInbound:
      example:
        ani_number_format: +E.164
        channel_limit: 10
        codecs: G722
        default_routing_method: sequential
        dnis_number_format: +e164
        generate_ringback_tone: true
        isup_headers_enabled: true
        prack_enabled: true
        privacy_zone_enabled: true
        sip_compact_headers_enabled: true
        timeout_1xx_secs: 10
        timeout_2xx_secs: 20
      properties:
        ani_number_format:
          default: E.164-national
          description: This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.
          enum:
            - +E.164
            - E.164
            - +E.164-national
            - E.164-national
          type: string
        channel_limit:
          default: null
          description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
          type: integer
        codecs:
          default:
            - G722
            - G711U
            - G711A
            - G729
            - OPUS
            - H.264
          description: "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP."
          items:
            type: string
          type: array
        dnis_number_format:
          default: e164
          enum:
            - +e164
            - e164
            - national
            - sip_username
          type: string
        generate_ringback_tone:
          default: false
          description: Generate ringback tone through 183 session progress message with early media.
          type: boolean
        isup_headers_enabled:
          default: false
          description: When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)
          type: boolean
        prack_enabled:
          default: false
          description: Enable PRACK messages as defined in RFC3262.
          type: boolean
        privacy_zone_enabled:
          default: false
          description: By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.
          type: boolean
        sip_compact_headers_enabled:
          default: true
          description: Defaults to true.
          type: boolean
        timeout_1xx_secs:
          default: 3
          description: Time(sec) before aborting if connection is not made.
          maximum: 120
          minimum: 1
          type: integer
        timeout_2xx_secs:
          default: "90"
          description: "Time(sec) before aborting if call is unanswered (min: 1, max: 600)."
          maximum: 600
          minimum: 1
          type: string
      title: Credential Inbound
      type: object
    CredentialOutbound:
      example:
        ani_override: always
        call_parking_enabled: true
        channel_limit: 10
        generate_ringback_tone: true
        instant_ringback_enabled: true
        localization: US
        outbound_voice_profile_id: "1293384261075731499"
        t38_reinvite_source: telnyx
      properties:
        ani_override:
          default: ""
          description: Set a phone number as the ani_override value to override caller id number on outbound calls.
          type: string
        ani_override_type:
          default: always
          description: Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.
          enum:
            - always
            - normal
            - emergency
          type: string
        call_parking_enabled:
          default: false
          description: Forces all SIP calls originated on this connection to be "parked" instead of "bridged" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next.
          type: boolean
        channel_limit:
          default: null
          description: When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
          type: integer
        generate_ringback_tone:
          default: false
          description: Generate ringback tone through 183 session progress message with early media.
          type: boolean
        instant_ringback_enabled:
          default: true
          description: When set, ringback will not wait for indication before sending ringback tone to calling party.
          type: boolean
        localization:
          default: US
          description: A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.
          example: US
          type: string
        outbound_voice_profile_id:
          $ref: "#/components/schemas/OutboundVoiceProfileId"
        t38_reinvite_source:
          default: telnyx
          description: This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite.
          enum:
            - telnyx
            - customer
            - disabled
            - passthru
            - caller-passthru
            - callee-passthru
          type: string
      title: Credential Outbound
      type: object
    CsvDownload:
      example:
        id: 42587e44-3a3e-46de-9255-0c9a7a1d1ec7
        record_type: csv_download
        status: pending
        url: https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7
      properties:
        id:
          description: Identifies the resource.
          example: 42587e44-3a3e-46de-9255-0c9a7a1d1ec7
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: csv_download
          readOnly: true
          type: string
        status:
          default: pending
          description: Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved.
          enum:
            - pending
            - complete
            - failed
            - expired
          example: pending
          type: string
        url:
          description: The URL at which the CSV file can be retrieved.
          example: https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7
          type: string
      type: object
    Currencies:
      description: The supported currencies.
      enum:
        - USD
        - EUR
        - GBP
        - AUD
        - CAD
      example: USD
      title: Currencies
      type: string
    Currency:
      description: ""
      example:
        amount_1000: 100990
        currency_code: USD
      properties:
        amount_1000:
          format: int32
          type: integer
        currency_code:
          type: string
        fallback_value:
          type: string
      required:
        - amount_1000
        - currency_code
      title: Currency
      type: object
    CustomSipHeader:
      example:
        name: head_1
        value: val_1
      properties:
        name:
          description: The name of the header to add.
          example: head_1
          type: string
        value:
          description: The value of the header.
          example: val_1
          type: string
      required:
        - name
        - value
      title: Custom SIP Header
      type: object
    DateTimeComponent:
      description: Date/time by component
      example:
        day_of_month: 25
        day_of_week: 5
        hour: 15
        minute: 33
        month: 2
        year: 1977
      properties:
        day_of_month:
          description: The day of month
          format: int32
          type: integer
        day_of_week:
          description: Both strings and numbers are accepted. If different from the value derived from the date (if specified), use the derived value.
          enum:
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
          format: int32
          type: integer
          x-enum-descriptions:
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
          x-enum-varnames:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
            - SUNDAY
        hour:
          description: The hour
          format: int32
          type: integer
        minute:
          description: The minute
          format: int32
          type: integer
        month:
          description: The month
          format: int32
          type: integer
        year:
          description: The year
          format: int32
          type: integer
      title: Date Time by Component
      type: object
    DateTimeObject:
      description: The Whatsapp Business API Client will attempt to format the date/time based on a specified localization.
      example:
        component:
          day_of_month: 25
          day_of_week: 5
          hour: 15
          minute: 33
          month: 2
          year: 1977
      properties:
        component:
          $ref: "#/components/schemas/DateTimeComponent"
        unix_epoch:
          $ref: "#/components/schemas/DateTimeUnixEpoch"
      title: Date Time Object
      type: object
    DateTimeUnixEpoch:
      description: Date/time by Unix epoch
      example:
        timestamp: 123456789
      properties:
        timestamp:
          description: Epoch timestamp in seconds
          format: int32
          type: integer
      title: Date Time by Unix Epoch
      type: object
    DetailRecord:
      description: An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records
      discriminator:
        propertyName: record_type
      oneOf:
        - $ref: "#/components/schemas/MessageDetailRecord"
        - $ref: "#/components/schemas/ConferenceDetailRecord"
        - $ref: "#/components/schemas/ConferenceParticipantDetailRecord"
      required:
        - record_type
      type: object
    DetailRecordsSearchResponse:
      properties:
        data:
          items:
            $ref: "#/components/schemas/DetailRecord"
          type: array
        meta:
          $ref: "#/components/schemas/PaginationMeta"
      type: object
    Direction:
      enum:
        - INBOUND
        - OUTBOUND
      type: string
    DocReqsRequirement:
      properties:
        action:
          description: Indicates whether this requirement applies to ordering, porting, or both
          enum:
            - both
            - ordering
            - porting
          example: ordering
          readOnly: false
          type: string
        country_code:
          description: The 2-character (ISO 3166-1 alpha-2) country code where this requirement applies
          example: FR
          readOnly: false
          type: string
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2021-04-09T22:25:27.521Z
          readOnly: true
          type: string
        id:
          description: Identifies the associated document
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        locality:
          description: The locality where this requirement applies
          example: Nice
          readOnly: false
          type: string
        phone_number_type:
          description: Indicates the phone_number_type this requirement applies to. Leave blank if this requirement applies to all number_types.
          enum:
            - local
            - national
            - toll_free
          example: local
          readOnly: false
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: requirement
          readOnly: true
          type: string
        requirements_types:
          description: Lists the requirement types necessary to fulfill this requirement
          items:
            $ref: "#/components/schemas/DocReqsRequirementType"
          readOnly: true
          type: array
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was last updated.
          example: 2021-04-12T20:20:20.020Z
          readOnly: true
          type: string
      type: object
    DocReqsRequirementList:
      items:
        $ref: "#/components/schemas/DocReqsRequirement"
      type: array
    DocReqsRequirementType:
      properties:
        acceptance_criteria:
          description: Specifies objective criteria for acceptance
          properties:
            locality_limit:
              description: Specifies geography-based acceptance criteria
              example: Issued by the same country that the phone number belongs to
              readOnly: false
              type: string
            time_limit:
              description: Specifies time-based acceptance criteria
              example: Current and not expired
              readOnly: false
              type: string
          type: object
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2021-04-09T22:25:27.521Z
          readOnly: true
          type: string
        description:
          description: Describes the requirement type
          example: Proves the customer has a physical address in the same locality as the phone number
          readOnly: false
          type: string
        example:
          description: Provides one or more examples of acceptable documents
          example: Utility bill, internet bill, phone bill, or lease
          readOnly: false
          type: string
        id:
          description: Identifies the associated document
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        name:
          description: A short descriptive name for this requirement_type
          example: Proof of Address
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource
          example: requirement_type
          readOnly: true
          type: string
        type:
          description: Defines the type of this requirement type
          enum:
            - document
            - address
            - textual
          example: document
          readOnly: false
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was last updated.
          example: 2021-04-12T20:20:20.020Z
          readOnly: true
          type: string
      type: object
    DocReqsRequirementTypeList:
      items:
        $ref: "#/components/schemas/DocReqsRequirementType"
      type: array
    DocServiceDocument:
      allOf:
        - $ref: "#/components/schemas/DocServiceRecord"
        - properties:
            content_type:
              description: The document's content_type.
              example: application/pdf
              readOnly: true
              type: string
            filename:
              description: The filename of the document.
              example: test-document.pdf
              type: string
            record_type:
              description: Identifies the type of the resource.
              example: document
              readOnly: true
              type: string
            sha256:
              description: The document's SHA256 hash provided for optional verification purposes.
              example: 08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c
              readOnly: true
              type: string
            size:
              description: Indicates the document's filesize
              properties:
                amount:
                  description: The number of bytes
                  example: 123456
                  readOnly: true
                  type: integer
                unit:
                  description: Identifies the unit
                  example: bytes
                  readOnly: true
                  type: string
              readOnly: true
              type: object
            status:
              description: Indicates the current document reviewing status
              enum:
                - pending
                - verified
                - denied
              example: pending
              readOnly: true
              type: string
          type: object
    DocServiceDocumentLink:
      allOf:
        - $ref: "#/components/schemas/DocServiceRecord"
        - properties:
            document_id:
              description: Identifies the associated document.
              example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
              format: uuid
              readOnly: true
              type: string
            linked_record_type:
              description: The linked resource's record type.
              example: porting_order
              readOnly: true
              type: string
            linked_resource_id:
              description: Identifies the linked resource.
              example: 132091b4-442b-4a2a-b87f-61e707e46d54
              readOnly: true
              type: string
            record_type:
              description: Identifies the type of the resource.
              example: document_link
              readOnly: true
              type: string
          type: object
    DocServiceDocumentUploadInline:
      properties:
        file:
          description: The Base64 encoded contents of the file you are uploading.
          example: "[Base64 encoded content]"
          format: byte
          type: string
      required:
        - file
      type: object
    DocServiceDocumentUploadURL:
      properties:
        url:
          description: If the file is already hosted publicly, you can provide a URL and have the documents service fetch it for you.
          example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
          type: string
      required:
        - url
      type: object
    DocServiceRecord:
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: sample_record_type
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      type: object
    Document:
      description: The media object containing a document reference
      example:
        caption: Very important document
        filename: example.pdf
        id: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68
      properties:
        caption:
          description: Describes the specified media.
          example: My cool media!
          type: string
        filename:
          description: Describes the filename for the specific document.
          example: example.pdf
          type: string
        id:
          description: The media object ID returned when the media is successfully uploaded to the media endpoint.
          example: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68
          type: string
        link:
          description: The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both.
          example: http://www.example.com/file
          type: string
      title: Document
      type: object
    DownlinkData:
      properties:
        amount:
          description: Downlink data
          example: 1
          type: number
        unit:
          default: MB
          description: Transmission unit
          enum:
            - B
            - KB
            - MB
          type: string
      type: object
    DtmfType:
      default: RFC 2833
      description: Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
      enum:
        - RFC 2833
        - Inband
        - SIP INFO
      example: Inband
      title: DTMF Type
      type: string
    Email:
      example:
        email: <Contact's Email>
        type: <Contact's Email Type>
      properties:
        email:
          type: string
        type:
          type: string
      required:
        - email
        - type
      title: Email
      type: object
    EmergencySettings:
      description: The emergency services settings for a phone number.
      example:
        emergency_address_id: "1315261609962112019"
        emergency_enabled: true
      properties:
        emergency_address_id:
          description: Identifies the address to be used with emergency services.
          format: int64
          type: string
        emergency_enabled:
          default: false
          description: Allows you to enable or disable emergency services on the phone number. In order to enable emergency services, you must also set an emergency_address_id.
          type: boolean
        emergency_status:
          default: disabled
          description: Represents the state of the number regarding emergency activation.
          enum:
            - disabled
            - active
            - provisioning
            - deprovisioning
          type: string
      type: object
    EncryptedMedia:
      description: Enable use of SRTP or ZRTP for encryption. Valid values are those listed or null. Cannot be set to non-null if the transport_portocol is TLS.
      enum:
        - SRTP
        - ZRTP
      example: SRTP
      nullable: true
      type: string
    EnqueueRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        max_size: 20
        max_wait_time_secs: 600
        queue: support
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        max_size:
          default: 100
          description: The maximum number of calls allowed in the queue at a given time. Can't be modified for an existing queue.
          example: 200
          type: integer
        max_wait_time_secs:
          description: The number of seconds after which the call will be removed from the queue.
          example: 600
          type: integer
        queue_name:
          description: The name of the queue the call should be put in. If a queue with a given name doesn't exist yet it will be created.
          example: tier_1_support
          type: string
      title: Enqueue Request
      type: object
    Error:
      properties:
        code:
          format: int
          type: string
        detail:
          type: string
        meta:
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              format: json-pointer
              type: string
          type: object
        title:
          type: string
      required:
        - code
        - title
    ErrorSource:
      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
    Errors:
      properties:
        errors:
          items:
            $ref: "#/components/schemas/Error"
          type: array
    ExternalMessageDetailRecordDto:
      properties:
        cld:
          description: The destination number for a call, or the callee
          example: "+1555123456"
          type: string
        cli:
          description: The number associated with the person initiating the call, or the caller
          example: "+1555123456"
          type: string
        cost:
          $ref: "#/components/schemas/MessageCost"
        country_iso:
          description: Cld number ISO country code.
          example: US
          type: string
        created_at:
          description: Message sent time
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        direction:
          $ref: "#/components/schemas/Direction"
        errors:
          description: Error returned by the gateway in case sending of message failed.
          example: US
          items:
            description: Error returned by the gateway in case sending of message failed.
            example: "40001"
            type: string
          properties:
            empty:
              type: boolean
          type: array
        id:
          description: Message id
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        mcc:
          description: Mobile country code.
          example: "204"
          type: string
        message_type:
          $ref: "#/components/schemas/MessageType"
        mnc:
          description: Mobile network code.
          example: "01"
          type: string
        normalized_carrier:
          description: Cld carrier.
          example: T-Mobile
          type: string
        outbound_profile_id:
          description: Configured profile id. New profiles can be created and configured on Telnyx portal
          example: 30ef55db-c4a2-4c4a-9804-a68077973d07
          type: string
        outbound_profile_name:
          description: Configured profile name. New profiles can be created and configured on Telnyx portal
          example: configured-profile-name
          type: string
        parts:
          description: Number of parts this message has. Max number of character is 160. If message contains more characters then that it will be broken down in multiple parts
          example: 2
          type: integer
        pass_through_fee:
          $ref: "#/components/schemas/PassThroughFee"
        product:
          $ref: "#/components/schemas/Product"
        rate:
          $ref: "#/components/schemas/MessageRate"
        record_type:
          default: message_detail_record
          example: message_detail_record
          type: string
        status:
          $ref: "#/components/schemas/MessageStatus"
        tags:
          description: User tag.
          example: tag1
          type: string
      type: object
    ExternalWdrDetailRecordDto:
      properties:
        cost:
          $ref: "#/components/schemas/WirelessCost"
        created_at:
          description: Record created time
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        downlink_data:
          $ref: "#/components/schemas/DownlinkData"
        duration_seconds:
          description: Session duration in seconds.
          example: 1
          type: number
        id:
          description: WDR id
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        imsi:
          description: International mobile subscriber identity
          example: "123"
          type: string
        mcc:
          description: Mobile country code.
          example: "204"
          type: string
        mnc:
          description: Mobile network code.
          example: "01"
          type: string
        phone_number:
          description: Phone number
          example: "+12345678910"
          type: string
        rate:
          $ref: "#/components/schemas/WirelessRate"
        record_type:
          example: wdr
          type: string
        sim_card_id:
          description: Sim card unique identifier
          example: 877f80a6-e5b2-4687-9a04-88076265720f
          type: string
        sim_group_id:
          description: Sim group unique identifier
          example: f05a189f-7c46-4531-ac56-1460dc465a42
          type: string
        sim_group_name:
          description: Defined sim group name
          example: sim name
          type: string
        uplink_data:
          $ref: "#/components/schemas/UplinkData"
      type: object
    ExternalWdrGetDetailResponse:
      properties:
        data:
          items:
            $ref: "#/components/schemas/ExternalWdrDetailRecordDto"
          type: array
        meta:
          $ref: "#/components/schemas/PaginationMeta"
      type: object
    Fax:
      example:
        connection_id: c-1
        created_at: 2020-05-05T09:59:12
        direction: outbound
        from: "+123"
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        media_url: http://www.example.com/fax.pdf
        quality: high
        record_type: fax
        status: queued
        store_media: true
        stored_media_url: https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51
        to: "+456"
        updated_at: 2020-05-05T09:59:12
        webhook_failover_url: ""
        webhook_url: http://www.example.com/webhooks
      properties:
        connection_id:
          description: The connection ID to send the fax with.
          example: "234423"
          type: string
        created_at:
          description: ISO 8601 timestamp when resource was created
          format: datetime
          type: string
        direction:
          description: The direction of the fax.
          enum:
            - inbound
            - outbound
          example: outbound
          type: string
        from:
          description: The phone number, in E.164 format, the fax will be sent from.
          example: "+13125790015"
          type: string
        id:
          description: Identifies the fax.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        media_name:
          description: The media_name of a file used for the fax's media.
          example: my_media_uploaded_to_media_storage_api
          type: string
        media_url:
          description: The URL to the PDF used for the fax's media. If media_name was supplied, this is omitted.
          example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
          type: string
        quality:
          default: high
          description: The quality of the fax. Can be normal, high, very_high
          example: high
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - fax
          example: fax
          type: string
        status:
          description: Status of the fax
          enum:
            - queued
            - media.processed
            - sending
            - delivered
            - failed
            - initiated
            - receiving
            - media.processing
            - received
          example: queued
          type: string
        store_media:
          description: Should fax media be stored on temporary URL.
          type: boolean
        stored_media_url:
          description: If store_media was set to true, this is a link to temporary location. Link expires after 7 days.
          type: string
        to:
          description: The phone number, in E.164 format, the fax will be sent to or SIP URI
          example: "+13127367276"
          type: string
        updated_at:
          description: ISO 8601 timestamp when resource was updated
          format: datetime
          type: string
        webhook_failover_url:
          description: Optional failover URL that will receive fax webhooks if webhook_url doesn't return a 2XX response
          type: string
        webhook_url:
          description: URL that will receive fax webhooks
          type: string
      type: object
    FaxApplication:
      example:
        active: false
        anchorsite_override: Amsterdam, Netherlands
        application_name: fax-router
        created_at: 2018-02-02T22:25:27.521Z
        id: "1293384261075731499"
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        record_type: fax_application
        updated_at: 2018-02-02T22:25:27.521Z
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          $ref: "#/components/schemas/ConnectionActive"
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        application_name:
          $ref: "#/components/schemas/ApplicationName"
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        id:
          $ref: "#/components/schemas/IntId"
        inbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            sip_subdomain:
              default: null
              description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
              example: example
              type: string
            sip_subdomain_receive_settings:
              default: from_anyone
              description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
              enum:
                - only_my_connections
                - from_anyone
              example: only_my_connections
              type: string
          type: object
        outbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            outbound_voice_profile_id:
              $ref: "#/components/schemas/OutboundVoiceProfileId"
          type: object
        record_type:
          description: Identifies the type of the resource.
          example: fax_application
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
        webhook_event_failover_url:
          $ref: "#/components/schemas/WebhookEventFailoverUrl"
        webhook_event_url:
          $ref: "#/components/schemas/WebhookEventUrl"
        webhook_timeout_secs:
          $ref: "#/components/schemas/WebhookTimeoutSecs"
      title: Fax Application
      type: object
    FaxDelivered:
      example:
        data:
          event_type: fax.delivered
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: 2020-05-05T13:08:22.039204Z
          payload:
            call_duration_secs: 25
            connection_id: "234423"
            direction: outbound
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: "+17733372107"
            original_media_url: http://www.example.com/fax.pdf
            page_count: 2
            status: delivered
            to: "+15107882622"
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - fax.delivered
          example: fax.delivered
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            call_duration_secs:
              description: The duration of the call in seconds.
              example: 25
              type: integer
            connection_id:
              description: The ID of the connection that was used to send the fax.
              example: "234423"
              type: string
            direction:
              description: The direction of the fax.
              enum:
                - inbound
                - outbound
              example: outbound
              type: string
            fax_id:
              description: Identifies the fax.
              example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
            from:
              description: The phone number, in E.164 format, the fax will be sent from.
              example: "+13125790015"
              type: string
            media_name:
              description: The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization
              example: my_media_uploaded_to_media_storage_api
              type: string
            original_media_url:
              description: The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted
              example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
              type: string
            page_count:
              description: Number of transferred pages
              example: 2
              type: integer
            status:
              description: The status of the fax.
              enum:
                - delivered
              example: delivered
              type: string
            to:
              description: The phone number, in E.164 format, the fax will be sent to or SIP URI
              example: "+13127367276"
              type: string
            user_id:
              description: Identifier of the user to whom the fax belongs
              example: yfff7c54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      type: object
    FaxFailed:
      example:
        data:
          event_type: fax.failed
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: 2020-05-05T13:08:22.039204Z
          payload:
            connection_id: "234423"
            direction: outbound
            failure_reason: rejected
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: "+17733372107"
            original_media_url: http://www.example.com/fax.pdf
            status: failed
            to: "+15107882622"
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - fax.failed
          example: fax.failed
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            connection_id:
              description: The ID of the connection that was used to send the fax.
              example: "234423"
              type: string
            direction:
              description: The direction of the fax.
              enum:
                - inbound
                - outbound
              example: outbound
              type: string
            failure_reason:
              description: Cause of the sending failure
              enum:
                - rejected
              type: string
            fax_id:
              description: Identifies the fax.
              example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
            from:
              description: The phone number, in E.164 format, the fax will be sent from.
              example: "+13125790015"
              type: string
            media_name:
              description: The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization
              example: my_media_uploaded_to_media_storage_api
              type: string
            original_media_url:
              description: The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted
              example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
              type: string
            status:
              description: The status of the fax.
              enum:
                - failed
              example: failed
              type: string
            to:
              description: The phone number, in E.164 format, the fax will be sent to or SIP URI
              example: "+13127367276"
              type: string
            user_id:
              description: Identifier of the user to whom the fax belongs
              example: yfff7c54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      type: object
    FaxMediaProcessed:
      example:
        data:
          event_type: fax.media.processed
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: 2020-05-05T13:08:22.039204Z
          payload:
            connection_id: "234423"
            direction: outbound
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: "+17733372107"
            original_media_url: http://www.example.com/fax.pdf
            status: media.processed
            to: "+15107882622"
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - fax.media.processed
          example: fax.media.processed
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            connection_id:
              description: The ID of the connection that was used to send the fax.
              example: "234423"
              type: string
            direction:
              description: The direction of the fax.
              enum:
                - inbound
                - outbound
              example: outbound
              type: string
            fax_id:
              description: Identifies the fax.
              example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
            from:
              description: The phone number, in E.164 format, the fax will be sent from.
              example: "+13125790015"
              type: string
            media_name:
              description: The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization
              example: my_media_uploaded_to_media_storage_api
              type: string
            original_media_url:
              description: The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted
              example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
              type: string
            status:
              description: The status of the fax.
              enum:
                - media.processed
              example: media.processed
              type: string
            to:
              description: The phone number, in E.164 format, the fax will be sent to or SIP URI
              example: "+13127367276"
              type: string
            user_id:
              description: Identifier of the user to whom the fax belongs
              example: yfff7c54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      type: object
    FaxQueued:
      example:
        data:
          event_type: fax.queued
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: 2020-05-05T13:08:22.039204Z
          payload:
            connection_id: "234423"
            direction: outbound
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: "+17733372107"
            original_media_url: http://www.example.com/fax.pdf
            status: queued
            to: "+15107882622"
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - fax.queued
          example: fax.queued
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            connection_id:
              description: The ID of the connection that was used to send the fax.
              example: "234423"
              type: string
            direction:
              description: The direction of the fax.
              enum:
                - inbound
                - outbound
              example: outbound
              type: string
            fax_id:
              description: Identifies the fax.
              example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
            from:
              description: The phone number, in E.164 format, the fax will be sent from.
              example: "+13125790015"
              type: string
            media_name:
              description: The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization
              example: my_media_uploaded_to_media_storage_api
              type: string
            original_media_url:
              description: The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted
              example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
              type: string
            status:
              description: The status of the fax.
              enum:
                - queued
              example: queued
              type: string
            to:
              description: The phone number, in E.164 format, the fax will be sent to or SIP URI
              example: "+13127367276"
              type: string
            user_id:
              description: Identifier of the user to whom the fax belongs
              example: yfff7c54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      type: object
    FaxSendingStarted:
      example:
        data:
          event_type: fax.sending.started
          id: 95479a2e-b947-470a-a88f-2da6dd07ae0f
          occurred_at: 2020-05-05T13:08:22.039204Z
          payload:
            connection_id: "234423"
            direction: outbound
            fax_id: f8338808-3dc6-4f2b-942a-5d1f39255784
            from: "+17733372107"
            original_media_url: http://www.example.com/fax.pdf
            status: sending
            to: "+15107882622"
            user_id: 19a75cea-02c6-4b9a-84fa-c9bc8341feb8
          record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - fax.sending.started
          example: fax.sending.started
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        payload:
          properties:
            connection_id:
              description: The ID of the connection that was used to send the fax.
              example: "234423"
              type: string
            direction:
              description: The direction of the fax.
              enum:
                - inbound
                - outbound
              example: outbound
              type: string
            fax_id:
              description: Identifies the fax.
              example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
            from:
              description: The phone number, in E.164 format, the fax will be sent from.
              example: "+13125790015"
              type: string
            media_name:
              description: The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization
              example: my_media_uploaded_to_media_storage_api
              type: string
            original_media_url:
              description: The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted
              example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
              type: string
            status:
              description: The status of the fax.
              enum:
                - sending
              example: sending
              type: string
            to:
              description: The phone number, in E.164 format, the fax will be sent to or SIP URI
              example: "+13127367276"
              type: string
            user_id:
              description: Identifier of the user to whom the fax belongs
              example: yfff7c54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      type: object
    Feature:
      example:
        name: sms
      properties:
        name:
          example: sms
          type: string
    Filter:
      properties:
        billing_group:
          example: adfaa016-f921-4b6c-97bb-e4c1dad231c5
          type: string
        cld:
          example: "+13129457420"
          type: string
        cld_filter:
          enum:
            - contains
            - starts_with
            - ends_with
          type: string
        cli:
          example: "+13129457420"
          type: string
        cli_filter:
          enum:
            - contains
            - starts_with
            - ends_with
          type: string
        filter_type:
          enum:
            - and
            - or
          type: string
        tags_list:
          example: tag1
          type: string
      type: object
    FirstCommandTimeout:
      default: false
      description: Specifies whether calls to phone numbers associated with this connection should hangup after timing out.
      example: true
      title: First Command Timeout
      type: boolean
    FirstCommandTimeoutSecs:
      default: 30
      description: Specifies how many seconds to wait before timing out a dial command.
      example: 10
      title: First Command Timeout Secs
      type: integer
    Fqdn:
      example:
        connection_id: "1516447646313612565"
        created_at: 2018-02-02T22:25:27.521Z
        dns_record_type: a
        fqdn: example.com
        id: "1293384261075731499"
        port: 5060
        record_type: fqdn
        updated_at: 2018-02-02T22:25:27.521Z
      properties:
        connection_id:
          description: ID of the FQDN connection to which this FQDN is attached.
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        dns_record_type:
          description: The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.
          example: a
          type: string
        fqdn:
          description: FQDN represented by this resource.
          example: example.com
          type: string
        id:
          description: Identifies the resource.
          example: "1293384261075731499"
          format: int64
          type: string
        port:
          default: 5060
          description: Port to use when connecting to this FQDN.
          example: 5060
          type: integer
        record_type:
          description: Identifies the type of the resource.
          example: fqdn
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
      title: Fqdn
      type: object
    FqdnConnection:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: string
        created_at: 2018-02-02T22:25:27.521Z
        default_on_hold_comfort_noise_enabled: true
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        id: "1293384261075731499"
        inbound:
          ani_number_format: +E.164
          channel_limit: 10
          codecs:
            - G722
          default_routing_method: sequential
          dnis_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          sip_region: US
          sip_subdomain: string
          sip_subdomain_receive_settings: only_my_connections
          timeout_1xx_secs: 10
          timeout_2xx_secs: 10
        onnet_t38_passthrough_enabled: true
        record_type: fqdn_connection
        rtcp_settings:
          capture_enabled: true
          port: rtcp-mux
          report_frequency_secs: 10
        transport_protocol: UDP
        updated_at: 2018-02-02T22:25:27.521Z
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          description: Defaults to true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        default_on_hold_comfort_noise_enabled:
          default: true
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        id:
          description: Identifies the resource.
          example: "1293384261075731499"
          format: int64
          type: string
        inbound:
          $ref: "#/components/schemas/InboundFqdn"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer that the sender and receiver negotiate T38 directly when both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call according to each leg's settings.
          type: boolean
        record_type:
          description: Identifies the type of the resource.
          example: fqdn_connection
          type: string
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        transport_protocol:
          $ref: "#/components/schemas/FqdnConnectionTransportProtocol"
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      required:
        - connection_name
      title: FQDN Connection
      type: object
    FqdnConnectionTransportProtocol:
      default: UDP
      description: One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.
      enum:
        - UDP
        - TCP
        - TLS
      type: string
    GatherUsingAudioRequest:
      example:
        audio_url: http://example.com/message.wav
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        inter_digit_timeout_millis: 10000
        invalid_audio_url: http://example.com/message.wav
        maximum_digits: 10
        minimum_digits: 1
        terminating_digit: "#"
        timeout_millis: 10000
        valid_digits: "123"
      properties:
        audio_url:
          description: The URL of a file to be played back at the beginning of each prompt. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request.
          example: http://example.com/message.wav
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        inter_digit_timeout_millis:
          default: 5000
          description: The number of milliseconds to wait for input between digits.
          example: 10000
          format: int32
          type: integer
        invalid_audio_url:
          description: The URL of a file to play when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. The URL can point to either a WAV or MP3 file. invalid_media_name and invalid_audio_url cannot be used together in one request.
          example: http://example.com/invalid.wav
          type: string
        invalid_media_name:
          description: The media_name of a file to be played back when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.
          example: my_media_uploaded_to_media_storage_api
          type: string
        maximum_digits:
          default: 128
          description: The maximum number of digits to fetch. This parameter has a maximum value of 128.
          example: 10
          format: int32
          type: integer
        maximum_tries:
          default: 3
          description: The maximum number of times the file should be played if there is no input from the user on the call.
          example: 3
          format: int32
          type: integer
        media_name:
          description: The media_name of a file to be played back at the beginning of each prompt. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.
          example: my_media_uploaded_to_media_storage_api
          type: string
        minimum_digits:
          default: 1
          description: The minimum number of digits to fetch. This parameter has a minimum value of 1.
          example: 1
          format: int32
          type: integer
        terminating_digit:
          default: "#"
          description: The digit used to terminate input if fewer than `maximum_digits` digits have been gathered.
          example: "#"
          type: string
        timeout_millis:
          default: 60000
          description: The number of milliseconds to wait for a DTMF response after file playback ends before a replaying the sound file.
          example: 60000
          format: int32
          type: integer
        valid_digits:
          default: 0123456789#*
          description: A list of all digits accepted as valid.
          example: "123"
          type: string
      title: Gather Using Audio Request
      type: object
    GatherUsingSpeakRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        inter_digit_timeout_millis: 10000
        invalid_payload: say this on call
        language: arb
        maximum_digits: 10
        minimum_digits: 1
        payload: say this on call
        payload_type: text
        service_level: premium
        terminating_digit: "#"
        valid_digits: "123"
        voice: male
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        inter_digit_timeout_millis:
          default: 5000
          description: The number of milliseconds to wait for input between digits.
          example: 10000
          format: int32
          type: integer
        invalid_payload:
          description: The text or SSML to be converted into speech when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. There is a 5,000 character limit.
          example: Say this on the call
          type: string
        language:
          description: The language you want spoken.
          enum:
            - arb
            - cmn-CN
            - cy-GB
            - da-DK
            - de-DE
            - en-AU
            - en-GB
            - en-GB-WLS
            - en-IN
            - en-US
            - es-ES
            - es-MX
            - es-US
            - fr-CA
            - fr-FR
            - hi-IN
            - is-IS
            - it-IT
            - ja-JP
            - ko-KR
            - nb-NO
            - nl-NL
            - pl-PL
            - pt-BR
            - pt-PT
            - ro-RO
            - ru-RU
            - sv-SE
            - tr-TR
          example: en-US
          type: string
        maximum_digits:
          default: 128
          description: The maximum number of digits to fetch. This parameter has a maximum value of 128.
          example: 10
          format: int32
          type: integer
        maximum_tries:
          default: 3
          description: The maximum number of times that a file should be played back if there is no input from the user on the call.
          example: 3
          format: int32
          type: integer
        minimum_digits:
          default: 1
          description: The minimum number of digits to fetch. This parameter has a minimum value of 1.
          example: 1
          format: int32
          type: integer
        payload:
          description: The text or SSML to be converted into speech. There is a 5,000 character limit.
          example: Say this on the call
          type: string
        payload_type:
          default: text
          description: The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).
          enum:
            - text
            - ssml
          example: ssml
          type: string
        service_level:
          default: premium
          description: This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed.
          enum:
            - basic
            - premium
          example: premium
          type: string
        terminating_digit:
          default: "#"
          description: The digit used to terminate input if fewer than `maximum_digits` digits have been gathered.
          example: "#"
          type: string
        timeout_millis:
          default: 60000
          description: The number of milliseconds to wait for a DTMF response after speak ends before a replaying the sound file.
          example: 60000
          format: int32
          type: integer
        valid_digits:
          default: 0123456789#*
          description: A list of all digits accepted as valid.
          example: "123"
          type: string
        voice:
          description: The gender of the voice used to speak back the text.
          enum:
            - male
            - female
          example: female
          type: string
      required:
        - voice
        - language
        - payload
      title: Gather Using Speak Request
      type: object
    HangupRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      title: Hangup Request
      type: object
    HostedNumber:
      example:
        - id: bf6307bd-884d-4c1f-b6ea-c62b8c495d3c
          phone_number: "+18665550001"
          record_type: messaging_hosted_number
          status: successful
      properties:
        id:
          description: Identifies the type of resource.
          format: uuid
          readOnly: true
          type: string
        phone_number:
          description: The messaging hosted phone number (+E.164 format)
          format: +E.164
          type: string
        record_type:
          example: messaging_hosted_number
          type: string
        status:
          enum:
            - deleted
            - failed
            - pending
            - successful
          type: string
      type: object
    Hsm:
      description: The containing element for the message content — Indicates that the message is highly structured. Parameters contained within provide the structure.
      example:
        element_name: hello_world
        language:
          code: en
          policy: deterministic
        localizable_params:
          - default: "1234"
        namespace: business_a_namespace
      properties:
        element_name:
          description: The element name that indicates which template to use within the namespace
          type: string
        language:
          $ref: "#/components/schemas/Language"
        localizable_params:
          description: This field is an array of values to apply to variables in the template
          items:
            $ref: "#/components/schemas/LocalizableParam"
          type: array
        namespace:
          description: The namespace that will be used
          type: string
      required:
        - namespace
        - element_name
        - language
        - localizable_params
      title: Hsm
      type: object
    Image:
      description: The media object containing an image
      example:
        caption: My cool media!
        id: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68
      properties:
        caption:
          description: Describes the specified media.
          example: My cool media!
          type: string
        id:
          description: The media object ID returned when the media is successfully uploaded to the media endpoint.
          example: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68
          type: string
        link:
          description: The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both.
          example: http://www.example.com/file
          type: string
      title: Image
      type: object
    ImmutableListString:
      description: Error returned by the gateway in case sending of message failed.
      example: US
      items:
        description: Error returned by the gateway in case sending of message failed.
        example: US
        type: string
      properties:
        empty:
          type: boolean
      type: array
    ImmutableSetLong:
      example: "[1234567890L, 9876543210L]"
      items:
        format: int64
        type: integer
      properties:
        empty:
          type: boolean
      type: array
    InboundFqdn:
      example:
        ani_number_format: +E.164
        channel_limit: 10
        codecs:
          - G722
        default_routing_method: sequential
        dnis_number_format: +e164
        generate_ringback_tone: true
        isup_headers_enabled: true
        prack_enabled: true
        privacy_zone_enabled: true
        sip_compact_headers_enabled: true
        sip_region: US
        sip_subdomain: test
        sip_subdomain_receive_settings: only_my_connections
        timeout_1xx_secs: 10
        timeout_2xx_secs: 20
      properties:
        ani_number_format:
          default: E.164-national
          description: This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.
          enum:
            - +E.164
            - E.164
            - +E.164-national
            - E.164-national
          type: string
        channel_limit:
          default: null
          description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
          nullable: true
          type: integer
        codecs:
          default:
            - G722
            - G711U
            - G711A
            - G729
            - OPUS
            - H.264
          description: "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP."
          items:
            type: string
          type: array
        default_routing_method:
          default: null
          description: Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or null, other values are not allowed.
          enum:
            - sequential
            - round-robin
          nullable: true
          type: string
        dnis_number_format:
          default: e164
          enum:
            - +e164
            - e164
            - national
            - sip_username
          type: string
        generate_ringback_tone:
          default: false
          description: Generate ringback tone through 183 session progress message with early media.
          type: boolean
        isup_headers_enabled:
          default: false
          description: When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)
          type: boolean
        prack_enabled:
          default: false
          description: Enable PRACK messages as defined in RFC3262.
          type: boolean
        privacy_zone_enabled:
          default: false
          description: By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.
          type: boolean
        sip_compact_headers_enabled:
          default: true
          description: Defaults to true.
          type: boolean
        sip_region:
          default: US
          description: Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used.
          enum:
            - US
            - Europe
            - Australia
          type: string
        sip_subdomain:
          default: null
          description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
          nullable: true
          type: string
        sip_subdomain_receive_settings:
          default: from_anyone
          description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
          enum:
            - only_my_connections
            - from_anyone
          type: string
        timeout_1xx_secs:
          default: 3
          description: Time(sec) before aborting if connection is not made.
          maximum: 120
          minimum: 1
          type: integer
        timeout_2xx_secs:
          default: 90
          description: "Time(sec) before aborting if call is unanswered (min: 1, max: 600)."
          type: integer
      title: Inbound FQDN
      type: object
    InboundIp:
      example:
        ani_number_format: +E.164
        channel_limit: 10
        codecs: G722
        default_primary_ip_id: 192.168.0.0
        default_routing_method: sequential
        default_secondary_ip_id: 192.168.0.0
        default_tertiary_ip_id: 192.168.0.0
        dns_number_format: +e164
        generate_ringback_tone: true
        isup_headers_enabled: true
        prack_enabled: true
        privacy_zone_enabled: true
        sip_compact_headers_enabled: true
        sip_region: US
        sip_subdomain: test
        sip_subdomain_receive_settings: only_my_connections
        timeout_1xx_secs: 10
        timeout_2xx_secs: 20
      properties:
        ani_number_format:
          default: E.164-national
          description: This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.
          enum:
            - +E.164
            - E.164
            - +E.164-national
            - E.164-national
          type: string
        channel_limit:
          default: null
          description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
          example: 10
          type: integer
        codecs:
          default:
            - G722
            - G711U
            - G711A
            - G729
            - OPUS
            - H.264
          description: "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP."
          items:
            type: string
          type: array
        default_primary_ip_id:
          description: |-
            The default primary IP to use for the number. Only settable if the connection is
                          of IP authentication type. Value must be the ID of an authorized IP set on the connection.
          example: 192.168.0.0
          type: string
        default_routing_method:
          description: Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed.
          enum:
            - sequential
            - round-robin
          type: string
        default_secondary_ip_id:
          description: |-
            The default secondary IP to use for the number. Only settable if the connection is
                          of IP authentication type. Value must be the ID of an authorized IP set on the connection.
          example: 192.168.0.0
          type: string
        default_tertiary_ip_id:
          description: |-
            The default tertiary IP to use for the number. Only settable if the connection is
                          of IP authentication type. Value must be the ID of an authorized IP set on the connection.
          example: 192.168.0.0
          type: string
        dnis_number_format:
          default: e164
          enum:
            - +e164
            - e164
            - national
            - sip_username
          type: string
        generate_ringback_tone:
          default: false
          description: Generate ringback tone through 183 session progress message with early media.
          type: boolean
        isup_headers_enabled:
          default: false
          description: When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)
          type: boolean
        prack_enabled:
          default: false
          description: Enable PRACK messages as defined in RFC3262.
          type: boolean
        privacy_zone_enabled:
          default: false
          description: By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.
          type: boolean
        sip_compact_headers_enabled:
          default: true
          description: Defaults to true.
          type: boolean
        sip_region:
          default: US
          description: Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used.
          enum:
            - US
            - Europe
            - Australia
          type: string
        sip_subdomain:
          description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
          type: string
        sip_subdomain_receive_settings:
          description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
          enum:
            - only_my_connections
            - from_anyone
          type: string
        timeout_1xx_secs:
          default: 3
          description: Time(sec) before aborting if connection is not made.
          maximum: 120
          minimum: 1
          type: integer
        timeout_2xx_secs:
          default: 90
          description: "Time(sec) before aborting if call is unanswered (min: 1, max: 600)."
          type: integer
      title: Inbound Ip
      type: object
    InboundMessage:
      example:
        event_type: message.received
        id: bf6307bd-884d-4c1f-b6ea-c62b8c495d3c
        occurred_at: date-time
        payload:
          completed_at: null
          cost: null
          direction: inbound
          encoding: GSM-7
          errors: []
          from:
            carrier: T-MOBILE USA, INC.
            line_type: Wireless
            phone_number: "+18665550001"
          id: 7ee4241c-f127-47e5-9c34-3aac291f8058
          media: []
          messaging_profile_id: 0f512bda-ae1e-4597-8e11-e5f5686b97d3
          organization_id: b448f9cc-a842-4784-98e9-03c1a5872950
          parts: 1
          received_at: 2019-01-23T18:10:02.574Z
          record_type: message
          sent_at: null
          subject: From Telnyx!
          tags:
            - Greetings
          text: Hello, World!
          to:
            - carrier: TELNYX LLC
              line_type: VoIP
              phone_number: "+18445550001"
              status: delivered
          type: SMS
          valid_until: null
          webhook_failover_url: https://backup.example.com/hooks
          webhook_url: https://www.example.com/hooks
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - message.received
          example: message.received
          type: string
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          type: string
        payload:
          $ref: "#/components/schemas/InboundMessagePayload"
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      type: object
    InboundMessageEvent:
      properties:
        data:
          $ref: "#/components/schemas/InboundMessage"
      type: object
    InboundMessagePayload:
      example:
        completed_at: null
        cost: null
        direction: inbound
        encoding: GSM-7
        errors: []
        from:
          carrier: T-MOBILE USA, INC.
          line_type: Wireless
          phone_number: "+18665550001"
          status: delivered
        id: 7ee4241c-f127-47e5-9c34-3aac291f8058
        media: []
        messaging_profile_id: 0f512bda-ae1e-4597-8e11-e5f5686b97d3
        organization_id: b448f9cc-a842-4784-98e9-03c1a5872950
        parts: 1
        received_at: 2019-01-23T18:10:02.574Z
        record_type: message
        sent_at: null
        subject: From Telnyx!
        tags:
          - Greetings
        text: Hello, World!
        to:
          - carrier: TELNYX LLC
            line_type: VoIP
            phone_number: "+18445550001"
            status: delivered
        type: SMS
        valid_until: null
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: https://www.example.com/hooks
      properties:
        cc:
          items:
            properties:
              carrier:
                description: The carrier of the receiver.
                type: string
              line_type:
                description: The line-type of the receiver.
                enum:
                  - Wireline
                  - Wireless
                  - VoWiFi
                  - VoIP
                  - Pre-Paid Wireless
                  - ""
                type: string
              phone_number:
                description: Receiving address (+E.164 formatted phone number or short code).
                format: address
                type: string
              status:
                enum:
                  - queued
                  - sending
                  - sent
                  - delivered
                  - sending_failed
                  - delivery_failed
                  - delivery_unconfirmed
                type: string
            type: object
          type: array
        completed_at:
          description: Not used for inbound messages.
          format: date-time
          nullable: true
          type: string
        cost:
          nullable: true
          properties:
            amount:
              description: The amount deducted from your account.
              format: decimal
              type: string
            currency:
              description: The ISO 4217 currency identifier.
              format: iso4217
              type: string
          type: object
        direction:
          description: The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.
          enum:
            - inbound
          example: inbound
          type: string
        encoding:
          description: Encoding scheme used for the message body.
          type: string
        errors:
          description: These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.
          items:
            $ref: "#/components/schemas/Error"
          type: array
        from:
          properties:
            carrier:
              description: The carrier of the sender.
              type: string
            line_type:
              description: The line-type of the sender.
              enum:
                - Wireline
                - Wireless
                - VoWiFi
                - VoIP
                - Pre-Paid Wireless
                - ""
              type: string
            phone_number:
              description: Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).
              format: address
              type: string
            status:
              enum:
                - received
                - delivered
              type: string
          type: object
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        media:
          items:
            properties:
              content_type:
                description: The MIME type of the requested media.
                format: mime-type
                type: string
              hash_sha256:
                description: The SHA256 hash of the requested media.
                maxLength: 32
                minLength: 32
                type: string
              size:
                description: The size of the requested media.
                type: integer
              url:
                description: The url of the media requested to be sent.
                format: url
                type: string
            type: object
          type: array
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          type: string
        parts:
          description: Number of parts into which the message's body must be split.
          maximum: 10
          minimum: 1
          type: integer
        received_at:
          description: ISO 8601 formatted date indicating when the message request was received.
          format: date-time
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - message
          example: message
          type: string
        sent_at:
          description: Not used for inbound messages.
          format: date-time
          nullable: true
          type: string
        tags:
          description: Tags associated with the resource.
          items:
            type: string
          type: array
        text:
          description: |-
            Message body (i.e., content) as a non-empty string.

            **Required for SMS**
          type: string
        to:
          items:
            properties:
              carrier:
                description: The carrier of the receiver.
                type: string
              line_type:
                description: The line-type of the receiver.
                enum:
                  - Wireline
                  - Wireless
                  - VoWiFi
                  - VoIP
                  - Pre-Paid Wireless
                  - ""
                type: string
              phone_number:
                description: Receiving address (+E.164 formatted phone number or short code).
                format: address
                type: string
              status:
                enum:
                  - queued
                  - sending
                  - sent
                  - delivered
                  - sending_failed
                  - delivery_failed
                  - delivery_unconfirmed
                  - webhook_delivered
                type: string
            type: object
          type: array
        type:
          description: The type of message. This value can be either 'sms' or 'mms'.
          enum:
            - SMS
            - MMS
          type: string
        valid_until:
          description: Not used for inbound messages.
          format: date-time
          nullable: true
          type: string
        webhook_failover_url:
          description: The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
          format: url
          nullable: true
          type: string
        webhook_url:
          description: The URL where webhooks related to this message will be sent.
          format: url
          nullable: true
          type: string
    IntId:
      description: Uniquely identifies the resource.
      example: "1293384261075731499"
      format: int64
      title: Int ID
      type: string
    InventoryCoverage:
      example:
        count: 3
        coverage_type: number
        group: "318"
        group_type: npa
        number_range: 1
        number_type: did
        phone_number_type: local
        record_type: inventory_coverage_group
      properties:
        count:
          example: 3
          type: integer
        coverage_type:
          enum:
            - number
            - block
          example: number
          type: string
        group:
          example: "318"
          type: string
        group_type:
          example: npa
          type: string
        number_range:
          example: 1
          type: integer
        number_type:
          enum:
            - did
            - toll-free
          example: did
          type: string
        phone_number_type:
          enum:
            - local
            - toll_free
            - national
            - landline
            - shared_cost
            - mobile
          example: local
          type: string
        record_type:
          example: inventory_coverage_group
          type: string
      type: object
    InventoryCoverageMetadata:
      example:
        total_results: 25
      properties:
        total_results:
          example: 25
          type: integer
      type: object
    Ip:
      example:
        connection_id: "3456789987654"
        created_at: 2018-02-02T22:25:27.521Z
        id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        ip_address: 192.168.0.0
        port: 5060
        record_type: ip
        updated_at: 2018-02-02T22:25:27.521Z
      properties:
        connection_id:
          description: ID of the IP Connection to which this IP should be attached.
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        id:
          description: Identifies the type of resource.
          example: "1293384261075731499"
          format: int64
          type: string
        ip_address:
          description: IP adddress represented by this resource.
          example: 192.168.0.0
          type: string
        port:
          default: 5060
          description: Port to use when connecting to this IP.
          example: 5060
          type: integer
        record_type:
          description: Identifies the type of the resource.
          example: ip
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
      title: Ip
      type: object
    IpConnection:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: string
        created_at: 2018-02-02T22:25:27.521Z
        default_on_hold_comfort_noise_enabled: true
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        inbound:
          ani_number_format: +E.164
          channel_limit: 10
          codecs:
            - G722
          default_primary_ip_id: 192.0.2.1
          default_routing_method: sequential
          default_secondary_ip_id: 198.51.100.1
          default_tertiary_ip_id: 203.0.113.1
          dnis_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          sip_region: US
          sip_subdomain: string
          sip_subdomain_receive_settings: only_my_connections
          timeout_1xx_secs: 10
          timeout_2xx_secs: 10
        onnet_t38_passthrough_enabled: true
        outbound:
          ani_override: string
          ani_override_type: always
          call_parking_enabled: true
          channel_limit: 10
          generate_ringback_tone: true
          instant_ringback_enabled: true
          ip_authentication_method: token
          ip_authentication_token: string
          localization: string
          outbound_voice_profile_id: "1293384261075731499"
          t38_reinvite_source: telnyx
          tech_prefix: string
        record_type: ip_connection
        rtcp_settings:
          capture_enabled: true
          port: rtcp-mux
          report_frequency_secs: 10
        transport_protocol: UDP
        updated_at: 2018-02-02T22:25:27.521Z
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          description: Defaults to true
          example: true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          example: string
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        default_on_hold_comfort_noise_enabled:
          default: true
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          example: true
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          example: true
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        id:
          description: Identifies the type of resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: int64
          type: string
        inbound:
          $ref: "#/components/schemas/InboundIp"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
          example: false
          type: boolean
        outbound:
          $ref: "#/components/schemas/OutboundIp"
        record_type:
          description: Identifies the type of the resource.
          example: ip_connection
          type: string
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        transport_protocol:
          default: UDP
          description: One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.
          enum:
            - UDP
            - TCP
            - TLS
          example: UDP
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      title: Ip Connection
      type: object
    JoinConferenceRequest:
      example:
        beep_enabled: always
        call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        end_conference_on_exit: true
        hold: true
        hold_audio_url: http://www.example.com/audio.wav
        mute: true
        start_conference_on_enter: true
        supervisor_role: whisper
        whisper_call_control_ids:
          - v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ
          - v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw
      properties:
        beep_enabled:
          description: Whether a beep sound should be played when the participant joins and/or leaves the conference. Can be used to override the conference-level setting.
          enum:
            - always
            - never
            - on_enter
            - on_exit
          example: on_exit
          type: string
        call_control_id:
          description: Unique identifier and token for controlling the call
          example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        end_conference_on_exit:
          description: Whether the conference should end and all remaining participants be hung up after the participant leaves the conference. Defaults to "false".
          example: true
          type: boolean
        hold:
          description: Whether the participant should be put on hold immediately after joining the conference. Defaults to "false".
          example: true
          type: boolean
        hold_audio_url:
          description: The URL of a file to be played to the participant when they are put on hold after joining the conference. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when "start_conference_on_create" is set to "false". This property takes effect only if "hold" is set to "true".
          example: http://example.com/message.wav
          type: string
        hold_media_name:
          description: The media_name of a file to be played to the participant when they are put on hold after joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when "start_conference_on_create" is set to "false". This property takes effect only if "hold" is set to "true".
          example: my_media_uploaded_to_media_storage_api
          type: string
        mute:
          description: Whether the participant should be muted immediately after joining the conference. Defaults to "false".
          example: true
          type: boolean
        soft_end_conference_on_exit:
          description: Whether the conference should end after the participant leaves the conference. NOTE this doesn't hang up the other participants. Defaults to "false".
          example: true
          type: boolean
        start_conference_on_enter:
          description: Whether the conference should be started after the participant joins the conference. Defaults to "false".
          example: true
          type: boolean
        supervisor_role:
          description: Sets the joining participant as a supervisor for the conference. A conference can have multiple supervisors. "barge" means the supervisor enters the conference as a normal participant. This is the same as "none". "monitor" means the supervisor is muted but can hear all participants. "whisper" means that only the specified "whisper_call_control_ids" can hear the supervisor. Defaults to "none".
          enum:
            - barge
            - monitor
            - none
            - whisper
          example: whisper
          type: string
        whisper_call_control_ids:
          description: Array of unique call_control_ids the joining supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only.
          example:
            - v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ
            - v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw
          items:
            type: string
          type: array
      required:
        - call_control_id
      title: Join Conference Request
      type: object
    Language:
      example:
        code: en
        policy: deterministic
      properties:
        code:
          description: The code of the language or locale to use — Accepts both language and language_locale formats (e.g., en and en_US).
          type: string
        policy:
          description: The language policy the message should follow
          enum:
            - fallback
            - deterministic
          type: string
      required:
        - policy
        - code
      title: Language
      type: object
    LeaveConferenceRequest:
      example:
        beep_enabled: never
        call_control_id: c46e06d7-b78f-4b13-96b6-c576af9640ff
      properties:
        beep_enabled:
          description: Whether a beep sound should be played when the participant leaves the conference. Can be used to override the conference-level setting.
          enum:
            - always
            - never
            - on_enter
            - on_exit
          example: on_exit
          type: string
        call_control_id:
          description: Unique identifier and token for controlling the call
          example: f91269aa-61d1-417f-97b3-10e020e8bc47
          type: string
        command_id:
          description: Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      required:
        - call_control_id
      title: Leave Conference Request
      type: object
    LeaveQueueRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      title: Leave Queue Request
      type: object
    LedgerBillingGroupReport:
      example:
        created_at: 2019-10-15T10:07:15.527Z
        id: f5586561-8ff0-4291-a0ac-84fe544797bd
        organization_id: f5586561-8ff0-4291-a0ac-84fe544797bd
        record_type: ledger_billing_group_report
        report_url: https://example.com
        updated_at: 2019-10-15T10:07:15.527Z
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          type: string
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        organization_id:
          description: Uniquely identifies the organization that owns the resource.
          format: uuid
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - ledger_billing_group_report
          example: ledger_billing_group_report
          type: string
        report_url:
          description: External url of the ledger billing group report, if the status is complete
          format: string
          nullable: true
          type: string
        status:
          description: Status of the ledger billing group report
          enum:
            - pending
            - complete
            - failed
            - deleted
          format: string
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          format: date-time
          type: string
      type: object
    ListVerificationsResponse:
      properties:
        data:
          items:
            $ref: "#/components/schemas/Verification"
          type: array
        meta:
          $ref: "#/components/schemas/Meta"
      required:
        - data
        - meta
      title: ListVerificationsResponse
      type: object
    ListVerifyProfilesResponse:
      description: A paginated list of Verify profiles
      properties:
        data:
          items:
            $ref: "#/components/schemas/VerifyProfileResponse"
          type: array
        meta:
          $ref: "#/components/schemas/Meta"
      required:
        - data
        - meta
      title: ListVerifyProfilesResponse
      type: object
    LocalizableParam:
      example:
        default: <param value>
      properties:
        currency:
          $ref: "#/components/schemas/Currency"
        date_time:
          $ref: "#/components/schemas/DateTimeObject"
        default:
          description: Default text if localization fails
          type: string
      required:
        - default
      title: LocalizableParam
      type: object
    Location:
      example:
        address: <Location's Address>
        latitude: <Latitude>
        longitude: <Longitude>
        name: <Location Name>
      properties:
        address:
          description: Address of the location. Only displayed if name is present.
          type: string
        latitude:
          description: Latitude of the location
          type: string
        longitude:
          description: Longitude of the location
          type: string
        name:
          description: Name of the location
          type: string
      required:
        - longitude
        - latitude
        - name
        - address
      title: Location
      type: object
    Loopcount:
      oneOf:
        - type: string
        - type: integer
    ManagedAccount:
      properties:
        api_key:
          description: The managed account's V2 API access key
          example: KEY0174227C1D16D1B180A8FF742AD37F70_1bA4vlJKHpZcJGaSXaadFu
          type: string
        api_token:
          description: The managed account's V1 API token
          example: x6oexQNHTs-fZ7-QsDMOeg
          type: string
        api_user:
          description: The manager account's email, which serves as the V1 API user identifier
          example: managed_account@example.com
          type: string
        balance:
          $ref: "#/components/schemas/ManagedAccountBalance"
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        email:
          description: The managed account's email.
          example: user@example.com
          format: email
          type: string
        id:
          description: Uniquely identifies the managed account.
          example: f65ceda4-6522-4ad6-aede-98de83385123
          format: UUID
          type: string
        manager_account_id:
          description: The ID of the manager account associated with the managed account.
          example: f65ceda4-6522-4ad6-aede-98de83385123
          type: string
        organization_name:
          description: The organization the managed account is associated with.
          example: Example Company LLC
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - managed_account
          example: managed_account
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
      required:
        - record_type
        - id
        - email
        - api_key
        - api_user
        - api_token
        - manager_account_id
        - created_at
        - updated_at
      title: ManagedAccount
      type: object
    ManagedAccountBalance:
      example:
        available_credit: "400.00"
        balance: "300.00"
        credit_limit: "100.00"
        currency: USD
        record_type: balance
      properties:
        available_credit:
          description: Available amount to spend (balance + credit limit)
          example: "400.00"
          format: decimal
          type: string
        balance:
          description: The account's current balance.
          example: "300.00"
          format: decimal
          type: string
        credit_limit:
          description: The account's credit limit.
          example: "100.00"
          format: decimal
          type: string
        currency:
          description: The ISO 4217 currency identifier.
          example: USD
          format: iso4217
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - balance
          example: balance
          type: string
      type: object
    MarkMessageAsReadRequestBody:
      example:
        status: read
        whatsapp_user_id: "15125551212"
      properties:
        status:
          default: read
          type: string
        whatsapp_user_id:
          description: The user's WhatsApp ID.
          example: "15125551212"
          type: string
      required:
        - whatsapp_user_id
        - status
      title: Mark Message As Read Request Body
      type: object
    MdrDeleteDetailReportResponse:
      properties:
        data:
          $ref: "#/components/schemas/MdrDetailReportResponse"
      type: object
    MdrDeleteUsageReportsResponse:
      properties:
        data:
          $ref: "#/components/schemas/MdrUsageReportResponse"
      type: object
    MdrDetailReportResponse:
      properties:
        connections:
          items:
            format: int64
            type: integer
          type: array
        created_at:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        directions:
          items:
            enum:
              - INBOUND
              - OUTBOUND
            type: string
          type: array
        end_date:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        filters:
          items:
            $ref: "#/components/schemas/Filter"
          type: array
        id:
          description: Identifies the resource
          format: uuid
          type: string
        profiles:
          example: My profile
          type: string
        record_type:
          example: mdr_report
          type: string
        record_types:
          items:
            enum:
              - INCOMPLETE
              - COMPLETED
              - ERRORS
            type: string
          type: array
        report_name:
          example: report_name_8hvb45Gu
          type: string
        report_url:
          example: http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv
          type: string
        start_date:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        status:
          enum:
            - PENDING
            - COMPLETE
            - FAILED
            - EXPIRED
          type: string
        updated_at:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
      type: object
    MdrDetailResponse:
      properties:
        cld:
          description: The destination number for a call, or the callee
          example: "+1555123456"
          type: string
        cli:
          description: The number associated with the person initiating the call, or the caller
          example: "+1555123456"
          type: string
        cost:
          description: Final cost. Cost is calculated as rate * parts
          example: "0.1"
          type: string
        created_at:
          description: Message sent time
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        currency:
          description: Currency of the rate and cost
          enum:
            - AUD
            - CAD
            - EUR
            - GBP
            - USD
          example: USD
          type: string
        direction:
          description: Direction of message - inbound or outbound.
          example: outbound
          type: string
        id:
          description: Id of message detail record
          example: 99b637f3-07fd-45ac-b9ca-b87208c24650
          type: string
        message_type:
          description: Type of message
          enum:
            - SMS
            - MMS
          example: SMS
          type: string
        parts:
          description: Number of parts this message has. Max number of character is 160. If message contains more characters then that it will be broken down in multiple parts
          example: 2
          type: number
        profile_name:
          description: Configured profile name. New profiles can be created and configured on Telnyx portal
          example: configured-profile-name
          type: string
        rate:
          description: Rate applied to the message
          example: "0.05"
          type: string
        record_type:
          example: mdr_report
          type: string
        status:
          description: Message status
          enum:
            - GW_TIMEOUT
            - DELIVERED
            - DLR_UNCONFIRMED
            - DLR_TIMEOUT
            - RECEIVED
            - GW_REJECT
            - FAILED
          example: DELIVERED
          type: string
      type: object
    MdrGetDetailReportByIdResponse:
      properties:
        data:
          $ref: "#/components/schemas/MdrDetailReportResponse"
      type: object
    MdrGetDetailReportResponse:
      properties:
        data:
          items:
            $ref: "#/components/schemas/MdrDetailReportResponse"
          type: array
        meta:
          $ref: "#/components/schemas/PaginationMeta"
      type: object
    MdrGetDetailResponse:
      properties:
        data:
          items:
            $ref: "#/components/schemas/MdrDetailResponse"
          type: array
        meta:
          $ref: "#/components/schemas/PaginationMeta"
      type: object
    MdrGetSyncUsageReportResponse:
      properties:
        data:
          $ref: "#/components/schemas/MdrUsageReportResponse"
      type: object
    MdrGetUsageReportsByIdResponse:
      properties:
        data:
          $ref: "#/components/schemas/MdrUsageReportResponse"
      type: object
    MdrGetUsageReportsResponse:
      properties:
        data:
          items:
            $ref: "#/components/schemas/MdrUsageReportResponse"
          type: array
        meta:
          $ref: "#/components/schemas/PaginationMeta"
      type: object
    MdrMessageBodyResponse:
      properties:
        data:
          $ref: "#/components/schemas/MessageBody"
      type: object
    MdrPostDetailReportRequest:
      properties:
        connections:
          items:
            format: int64
            type: integer
          type: array
        directions:
          items:
            enum:
              - INBOUND
              - OUTBOUND
            type: string
          type: array
        end_date:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        filters:
          items:
            $ref: "#/components/schemas/Filter"
          type: array
        include_message_body:
          example: true
          type: boolean
        profiles:
          example: My profile
          type: string
        record_types:
          items:
            enum:
              - INCOMPLETE
              - COMPLETED
              - ERRORS
            type: string
          type: array
        report_name:
          type: string
        start_date:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
      required:
        - end_date
        - start_date
      type: object
    MdrPostDetailReportResponse:
      properties:
        data:
          $ref: "#/components/schemas/MdrDetailReportResponse"
      type: object
    MdrPostUsageReportRequest:
      properties:
        aggregation_type:
          enum:
            - NO_AGGREGATION
            - PROFILE
            - TAGS
          type: string
        end_date:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        profiles:
          example: My profile
          type: string
        start_date:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
      required:
        - aggregation_type
        - end_date
        - start_date
      type: object
    MdrPostUsageReportsResponse:
      properties:
        data:
          $ref: "#/components/schemas/MdrUsageReportResponse"
      type: object
    MdrUsageRecord:
      properties:
        carrier_passthrough_fee:
          example: "0"
          type: string
        connection:
          example: all
          type: string
        cost:
          example: "0"
          type: string
        currency:
          example: USD
          type: string
        delivered:
          example: "0"
          type: string
        direction:
          example: outbound
          type: string
        message_type:
          example: SMS
          type: string
        parts:
          example: "0"
          type: string
        product:
          example: outbound
          type: string
        profile_id:
          example: All
          type: string
        received:
          example: "0"
          type: string
        sent:
          example: "0"
          type: string
        tags:
          example: All
          type: string
        tn_type:
          example: TF
          type: string
      type: object
    MdrUsageReportResponse:
      properties:
        aggregation_type:
          enum:
            - NO_AGGREGATION
            - PROFILE
            - TAGS
          type: string
        connections:
          items:
            format: int64
            type: integer
          type: array
        created_at:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        end_date:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        id:
          description: Identifies the resource
          format: uuid
          type: string
        profiles:
          example: My profile
          type: string
        record_type:
          example: mdr_usage_report
          type: string
        report_url:
          example: http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv
          type: string
        result:
          items:
            $ref: "#/components/schemas/MdrUsageRecord"
          type: array
        start_date:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
        status:
          enum:
            - PENDING
            - COMPLETE
            - FAILED
            - EXPIRED
          type: string
        updated_at:
          example: 2020-07-01T00:00:00-06:00
          format: date-time
          type: string
      type: object
    MediaFeatures:
      description: The media features settings for a phone number.
      example:
        accept_any_rtp_packets_enabled: true
        media_handling_mode: default
        rtp_auto_adjust_enabled: true
        t38_fax_gateway_enabled: true
      properties:
        accept_any_rtp_packets_enabled:
          default: false
          description: When enabled, Telnyx will accept RTP packets from any customer-side IP address and port, not just those to which Telnyx is sending RTP.
          type: boolean
        media_handling_mode:
          default: default
          description: "Controls how media is handled for the phone number. default: media routed through Telnyx with transcode support. proxy: media routed through Telnyx with no transcode support."
          enum:
            - default
            - proxy
          type: string
        rtp_auto_adjust_enabled:
          default: true
          description: When RTP Auto-Adjust is enabled, the destination RTP address port will be automatically changed to match the source of the incoming RTP packets.
          type: boolean
        t38_fax_gateway_enabled:
          default: false
          description: Controls whether Telnyx will accept a T.38 re-INVITE for this phone number. Note that Telnyx will not send a T.38 re-INVITE; this option only controls whether one will be accepted.
          type: boolean
      type: object
    MediaRequestBody:
      description: ""
      properties:
        media_content_type:
          description: The content-type of the uplaoded media.
          type: string
        upload_file:
          description: The media to store with WhatsApp.
          format: binary
          type: string
        whatsapp_user_id:
          description: The user's WhatsApp ID.
          type: string
      required:
        - whatsapp_user_id
        - media_content_type
        - upload_file
      title: Media Request Body
      type: object
    MediaResource:
      example:
        created_at: 2019-01-23T18:10:02.574Z
        expires_at: 2020-01-23T18:10:02.574Z
        media_name: f5586561-8ff0-4291-a0ac-84fe544797bd
        updated_at: 2019-01-23T18:10:02.574Z
      properties:
        created_at:
          description: ISO 8601 formatted date of when the media resource was created
          example: 2019-01-23T18:10:02.574Z
          type: string
        expires_at:
          description: ISO 8601 formatted date of when the media resource will expire and be deleted.
          example: 2020-01-23T18:10:02.574Z
          type: string
        media_name:
          description: Uniquely identifies a media resource.
          type: string
        updated_at:
          description: ISO 8601 formatted date of when the media resource was last updated
          example: 2019-01-23T18:10:02.574Z
          type: string
      title: Media Resource
      type: object
    Message:
      description: ""
      example:
        id: gBEGkYiEB1VXAglK1ZEqA1YKPrU
        record_type: whatsapp_message_id
      properties:
        id:
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - whatsapp_message_id
          readOnly: true
          type: string
      title: Message
      type: object
    MessageBody:
      properties:
        message_body:
          description: Text of the message. This is available only for last 7 days
          example: This is message text
          type: string
        record_type:
          default: message_body
          example: message_body
          type: string
      type: object
    MessageCost:
      properties:
        amount:
          description: Final cost. Cost is calculated as rate * parts
          example: 0.1
          type: number
        currency:
          $ref: "#/components/schemas/Currency"
      type: object
    MessageDetailRecord:
      properties:
        carrier:
          description: Country-specific carrier used to send or receive the message
          example: T-Mobile USA
          type: string
        carrier_fee:
          description: Fee charged by certain carriers in order to deliver certain message types. Telnyx passes this fee on to the customer according to our pricing table
          example: "0.003"
          type: string
        cld:
          description: The recipient of the message (to parameter in the Messaging API)
          example: "+1555123456"
          type: string
        cli:
          description: The sender of the message (from parameter in the Messaging API). For Alphanumeric ID messages, this is the sender ID value
          example: "+1555123456"
          type: string
        completed_at:
          description: Message completion time
          example: 2020-07-01T00:00:00Z
          format: date-time
          type: string
        cost:
          description: Amount, in the user currency, for the Telnyx billing cost
          example: "0.003"
          type: string
        country_code:
          description: Two-letter representation of the country of the cld property using the ISO 3166-1 alpha-2 format
          example: US
          type: string
        created_at:
          description: Message creation time
          example: 2020-07-01T00:00:00Z
          format: date-time
          type: string
        currency:
          description: Telnyx account currency used to describe monetary values, including billing cost
          example: USD
          type: string
        delivery_status:
          description: Final webhook delivery status
          example: "success: webhook succeeded"
          type: string
        delivery_status_failover_url:
          description: Failover customer-provided URL which Telnyx posts delivery status webhooks to
          example: https://api.example.com/sms/telnyx/inbound
          type: string
        delivery_status_webhook_url:
          description: Primary customer-provided URL which Telnyx posts delivery status webhooks to
          example: https://api.example.com/sms/telnyx/inbound
          type: string
        direction:
          description: Logical direction of the message from the Telnyx customer's perspective. It's inbound when the Telnyx customer receives the message, or outbound otherwise
          enum:
            - inbound
            - outbound
          example: outbound
          type: string
        errors:
          description: Telnyx API error codes returned by the Telnyx gateway
          items:
            example: "40001"
            type: string
          type: array
        fteu:
          description: Indicates whether this is a Free-To-End-User (FTEU) short code message
          example: false
          type: boolean
        mcc:
          description: Mobile country code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID
          example: "204"
          type: string
        message_type:
          description: "Describes the Messaging service used to send the message. Available services are: Short Message Service (SMS), Multimedia Messaging Service (MMS), and Rich Communication Services (RCS)"
          enum:
            - SMS
            - MMS
            - RCS
          example: SMS
          type: string
        mnc:
          description: Mobile network code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID
          example: "01"
          type: string
        on_net:
          description: Indicates whether both sender and recipient numbers are Telnyx-managed
          example: true
          type: boolean
        parts:
          description: Number of message parts. The message is broken down in multiple parts when its length surpasses the limit of 160 characters
          example: 2
          type: integer
        profile_id:
          description: Unique identifier of the Messaging Profile used to send or receive the message
          example: 30ef55db-c4a2-4c4a-9804-a68077973d07
          type: string
        profile_name:
          description: Name of the Messaging Profile used to send or receive the message
          example: My Messaging Profile
          type: string
        rate:
          description: Currency amount per billing unit used to calculate the Telnyx billing cost
          example: "0.003"
          type: string
        record_type:
          default: message_detail_record
          description: Identifies the record schema
          example: message_detail_record
          type: string
        sent_at:
          description: Time when the message was sent
          example: 2020-07-01T00:00:00Z
          format: date-time
          type: string
        source_country_code:
          description: Two-letter representation of the country of the cli property using the ISO 3166-1 alpha-2 format
          example: US
          type: string
        status:
          description: Final status of the message after the delivery attempt
          enum:
            - gw_timeout
            - delivered
            - dlr_unconfirmed
            - dlr_timeout
            - received
            - gw_reject
            - failed
          example: delivered
          type: string
        tags:
          description: Comma-separated tags assigned to the Telnyx number associated with the message
          example: tag1,tag2,tag3
          type: string
        updated_at:
          description: Message updated time
          example: 2020-07-01T00:00:00Z
          format: date-time
          type: string
        user_id:
          description: Identifier of the Telnyx account who owns the message
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
        uuid:
          description: Unique identifier of the message
          example: 3ca7bd3d-7d82-4e07-9df4-009123068320
          type: string
      required:
        - record_type
      type: object
    MessageRate:
      properties:
        amount:
          description: Rate applied to the message
          example: 0.1
          type: number
        currency:
          $ref: "#/components/schemas/Currency"
      type: object
    MessageStatus:
      description: Message status
      enum:
        - GW_TIMEOUT
        - DELIVERED
        - DLR_UNCONFIRMED
        - DLR_TIMEOUT
        - RECEIVED
        - GW_REJECT
        - FAILED
      example: DELIVERED
      type: string
    MessageType:
      default: text
      description: type of the message
      enum:
        - audio
        - contacts
        - document
        - hsm
        - image
        - location
        - template
        - text
        - video
        - voice
        - unknown
      title: Message Type
      type: string
    MessagingFeatureSet:
      description: |
        The set of features available for a specific messaging use case (SMS or MMS). Features
        can vary depending on the characteristics the phone number, as well as its current
        product configuration.
      example:
        domestic_two_way: true
        international_inbound: false
        international_outbound: true
      nullable: true
      properties:
        domestic_two_way:
          description: Send messages to and receive messages from numbers in the same country.
          type: boolean
        international_inbound:
          description: Receive messages from numbers in other countries.
          type: boolean
        international_outbound:
          description: Send messages to numbers in other countries.
          type: boolean
      required:
        - domestic_two_way
        - international_inbound
        - international_outbound
      type: object
    MessagingHostedNumberOrder:
      example:
        id: 86f58db9-0fe3-4adc-9d1f-46e66e6e9323
        messaging_profile_id: dc8f39ac-953d-4520-b93b-786ae87db0da
        phone_numbers:
          - id: bf6307bd-884d-4c1f-b6ea-c62b8c495d3c
            phone_number: "+18665550001"
            record_type: messaging_hosted_number
            status: pending
          - id: 464bd54e-a328-4b11-a131-28e6793cb6f2
            phone_number: "+18665550002"
            record_type: messaging_hosted_number
            status: pending
        record_type: messaging_hosted_number_order
        status: pending
      properties:
        id:
          description: Resource unique identifier.
          format: uuid
          readOnly: true
          type: string
        messaging_profile_id:
          description: Automatically associate the number with this messaging profile ID when the order is complete.
          nullable: true
          type: string
        phone_numbers:
          items:
            $ref: "#/components/schemas/HostedNumber"
          type: array
        record_type:
          description: Identifies the type of the resource.
          example: messaging_hosted_number_order
          readOnly: true
          type: string
        status:
          enum:
            - failed
            - pending
            - successful
          type: string
      type: object
    MessagingProfile:
      example:
        created_at: 2019-01-23T18:10:02.574Z
        enabled: true
        id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        name: Profile for Messages
        number_pool_settings:
          geomatch: false
          long_code_weight: 2
          skip_unhealthy: false
          sticky_sender: true
          toll_free_weight: 10
        record_type: messaging_profile
        updated_at: 2019-01-23T18:10:02.574Z
        url_shortener_settings:
          domain: example.ex
          prefix: cmpny
          replace_blacklist_only: true
          send_webhooks: false
        v1_secret: rP1VamejkU2v0qIUxntqLW2c
        webhook_api_version: "2"
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: https://www.example.com/hooks
        whitelisted_destinations:
          - US
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          readOnly: true
          type: string
        enabled:
          description: Specifies whether the messaging profile is enabled or not.
          type: boolean
        id:
          description: Identifies the type of resource.
          format: uuid
          readOnly: true
          type: string
        name:
          description: A user friendly name for the messaging profile.
          type: string
        number_pool_settings:
          $ref: "#/components/schemas/NumberPoolSettings"
        record_type:
          description: Identifies the type of the resource.
          enum:
            - messaging_profile
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          format: date-time
          readOnly: true
          type: string
        url_shortener_settings:
          $ref: "#/components/schemas/UrlShortenerSettings"
        v1_secret:
          description: Secret used to authenticate with v1 endpoints.
          type: string
        webhook_api_version:
          description: Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.
          enum:
            - "1"
            - "2"
            - 2010-04-01
          type: string
        webhook_failover_url:
          description: The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.
          format: url
          nullable: true
          type: string
        webhook_url:
          description: The URL where webhooks related to this messaging profile will be sent.
          format: url
          nullable: true
          type: string
        whitelisted_destinations:
          description: Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `["*"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes.
          items:
            description: ISO 3166-1 alpha-2 country code.
            pattern: ^[A-Z]{2}$
            type: string
          nullable: true
          type: array
      type: object
    MessagingProfileDetailedMetric:
      properties:
        metrics:
          items:
            $ref: "#/components/schemas/MessagingProfileMessageTypeMetrics"
          type: array
        timestamp:
          description: The timestamp of the aggregated data.
          example: 2019-01-23T18:10:02.574Z
          readOnly: true
          type: string
      type: object
    MessagingProfileDetailedMetrics:
      example:
        detailed:
          - metrics:
              - delivered: 990
                errors: 0.01
                label: longcode
                received: 750
                sent: 1000
            timestamp: 2019-01-23T18:10:02.574Z
        overview:
          inbound:
            received: 850
          messaging_profile_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          outbound:
            delivered: 990
            errors: 0.01
            sent: 1000
          phone_numbers: 250
          record_type: messaging_profile_metrics
      properties:
        detailed:
          items:
            $ref: "#/components/schemas/MessagingProfileDetailedMetric"
          type: array
        overview:
          $ref: "#/components/schemas/MessagingProfileHighLevelMetrics"
      type: object
    MessagingProfileHighLevelMetrics:
      example:
        inbound:
          received: 850
        messaging_profile_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        outbound:
          delivered: 990
          errors: 0.01
          sent: 1000
        phone_numbers: 250
        record_type: messaging_profile_metrics
      properties:
        inbound:
          properties:
            received:
              description: The number of inbound messages received.
              readOnly: true
              type: number
          type: object
        messaging_profile_id:
          description: Identifies the type of resource.
          format: uuid
          readOnly: true
          type: string
        outbound:
          properties:
            delivered:
              description: The number of outbound messages successfully delivered.
              readOnly: true
              type: number
            error_ratio:
              description: The ratio of messages sent that resulted in errors.
              readOnly: true
              type: number
            sent:
              description: The number of outbound messages sent.
              readOnly: true
              type: number
          type: object
        phone_numbers:
          description: The number of phone numbers associated with the messaging profile.
          readOnly: true
          type: number
        record_type:
          description: Identifies the type of the resource.
          enum:
            - messaging_profile_metrics
          example: messaging_profile_metrics
          readOnly: true
          type: string
      type: object
    MessagingProfileMessageTypeMetrics:
      example:
        delivered: 990
        errors: 0.01
        label: longcode
        received: 750
        sent: 1000
      properties:
        delivered:
          description: The number of outbound messages successfully delivered.
          readOnly: true
          type: number
        label:
          description: The metric type.
          readOnly: true
          type: string
        outbound_error_ratio:
          description: The ratio of outbound messages sent that resulted in errors.
          readOnly: true
          type: number
        received:
          description: The number of inbound messages received.
          readOnly: true
          type: number
        sent:
          description: The number of outbound messages sent.
          readOnly: true
          type: number
      type: object
    MessagingUrlDomain:
      example:
        id: 464bd54e-a328-4b11-a131-28e6793cb6f2
        record_type: messaging_url_domain
        url_domain: http://example.com
        use_case: test
      properties:
        id:
          type: string
        record_type:
          type: string
        url_domain:
          type: string
        use_case:
          type: string
      type: object
    Meta:
      properties:
        page_number:
          example: 2
          type: integer
        page_size:
          example: 25
          type: integer
        total_pages:
          example: 3
          type: integer
        total_results:
          example: 55
          type: integer
      type: object
    Metadata:
      properties:
        page_number:
          description: Current Page based on pagination settings (included when defaults are used.)
          example: 3
          format: double
          type: number
        page_size:
          description: Number of results to return per page based on pagination settings (included when defaults are used.)
          example: 1
          format: double
          type: number
        total_pages:
          description: Total number of pages based on pagination settings
          example: 13
          format: double
          type: number
        total_results:
          description: Total number of results
          example: 13
          format: double
          type: number
      title: Metadata
      type: object
    MobileOperatorNetwork:
      properties:
        country_code:
          description: The mobile operator two-character (ISO 3166-1 alpha-2) origin country code.
          example: US
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        mcc:
          description: |-
            MCC stands for Mobile Country Code. It's a three decimal digit that identifies a country.<br/><br/>
            This code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.
          example: "310"
          type: string
        mnc:
          description: |-
            MNC stands for Mobile Network Code. It's a two to three decimal digits that identify a network.<br/><br/>
             This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.
          example: "410"
          type: string
        name:
          description: The operator network name.
          example: AT&T Mobility (USACG)
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: mobile_operator_network
          readOnly: true
          type: string
        tadig:
          description: TADIG stands for Transferred Account Data Interchange Group. The TADIG code is a unique identifier for network operators in GSM mobile networks.
          example: USACG
          type: string
      title: MobileOperatorNetwork
      type: object
    MobileOperatorNetworkPreferencesRequest:
      description: ""
      properties:
        mobile_operator_network_id:
          description: The mobile operator network resource identification UUID.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        priority:
          description: It determines what is the priority of a specific operator network that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.
          example: 0
          type: integer
      type: object
    MobileOperatorNetworkPreferencesResponse:
      description: ""
      properties:
        mobile_operator_network_id:
          description: The mobile operator network resource identification UUID.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        mobile_operator_network_name:
          description: The mobile operator network resource name.
          example: AT&T Mobility (USACG)
          type: string
        priority:
          description: It determines what is the priority of a specific operator network that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.
          example: 0
          type: integer
      type: object
    MobileOperatorNetworksPreferencesRequest:
      description: A list of mobile operator networks and the priority that should be applied when the SIM is connecting to the network.
      items:
        $ref: "#/components/schemas/MobileOperatorNetworkPreferencesRequest"
      type: array
    MobileOperatorNetworksPreferencesResponse:
      description: A list of mobile operator networks and the priority that should be applied when the SIM is connecting to the network.
      items:
        $ref: "#/components/schemas/MobileOperatorNetworkPreferencesResponse"
      type: array
    Money:
      properties:
        amount:
          example: "0.06"
          type: string
        currency:
          enum:
            - AUD
            - CAD
            - EUR
            - GBP
            - USD
          type: string
      type: object
    Name:
      description: Full contact name
      example:
        first_name: John
        formatted_name: John Smith
        last_name: Smith
      properties:
        first_name:
          description: First name
          type: string
        formatted_name:
          description: Full name as it normally appears
          type: string
        last_name:
          description: Last name
          type: string
        prefix:
          description: Name preffix
          type: string
        suffix:
          description: Name suffix
          type: string
      required:
        - formatted_name
      title: Name
      type: object
    NewBillingGroup:
      example:
        name: string
      properties:
        name:
          description: A name for the billing group
          type: string
    NewLedgerBillingGroupReport:
      example:
        month: 10
        year: 2019
      properties:
        month:
          description: Month of the ledger billing group report
          example: 10
          type: integer
        year:
          description: Year of the ledger billing group report
          example: 2019
          type: integer
    NotificationChannel:
      description: A Notification Channel
      properties:
        channel_destination:
          description: The destination associated with the channel type.
          example: "+13125550000"
          type: string
        channel_type_id:
          description: A Channel Type ID
          enum:
            - sms
            - voice
            - email
            - webhook
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
        id:
          description: A UUID.
          example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
          readOnly: true
          type: string
        notification_profile_id:
          description: A UUID reference to the associated Notification Profile.
          example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
    NotificationEvent:
      description: An object representing the available notifications.
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          type: string
        enabled:
          example: true
          type: boolean
        id:
          description: A UUID.
          example: d5c395cd-9864-4609-b5e2-3f9fd4ce201a
          readOnly: true
          type: string
        name:
          description: A human readable name.
          example: Emergency Number Dialed
          type: string
        notification_category:
          example: Calls
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          type: string
    NotificationEventCondition:
      properties:
        allow_multiple_channels:
          description: Dictates whether a notification channel id needs to be provided when creating a notficiation setting.
          example: false
          type: boolean
        associated_record_type:
          enum:
            - account
            - phone_number
          example: phone_number
          type: string
        asynchronous:
          description: Dictates whether a notification setting will take effect immediately.
          example: true
          type: boolean
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          type: string
        description:
          example: When emergency number dialed from phone number X
          type: string
        enabled:
          example: true
          type: boolean
        id:
          description: A UUID.
          example: 70c7c5cb-dce2-4124-accb-870d39dbe852
          readOnly: true
          type: string
        name:
          example: from phone number
          type: string
        notification_event_id:
          example: d5c395cd-9864-4609-b5e2-3f9fd4ce201a
          type: string
        parameters:
          items:
            properties:
              data_type:
                example: string
                type: string
              name:
                example: phone_number
                type: string
              optional:
                example: false
                type: boolean
            type: object
          type: array
        supported_channels:
          description: Dictates the supported notification channel types that can be emitted.
          example:
            - webhook
            - sms
            - email
            - voice
          items:
            type: string
          type: array
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          type: string
    NotificationProfile:
      description: A Collection of Notification Channels
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
        id:
          description: A UUID.
          example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
          readOnly: true
          type: string
        name:
          description: A human readable name.
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
    NotificationSetting:
      properties:
        associated_record_type:
          example: phone_number
          readOnly: true
          type: string
        associated_record_type_value:
          example: "+13125550000"
          readOnly: true
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
        id:
          description: A UUID.
          example: 8eb5b5f9-5893-423c-9f15-b487713d44d4
          readOnly: true
          type: string
        notification_channel_id:
          description: A UUID reference to the associated Notification Channel.
          example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
          type: string
        notification_event_condition_id:
          description: A UUID reference to the associated Notification Event Condition.
          example: 70c7c5cb-dce2-4124-accb-870d39dbe852
          type: string
        notification_profile_id:
          description: A UUID reference to the associated Notification Profile.
          example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a
          type: string
        parameters:
          items:
            properties:
              name:
                example: phone_number
                type: string
              value:
                example: "+13125550000"
                type: string
            type: object
          type: array
        status:
          description: Most preferences apply immediately; however, other may needs to propagate.
          enum:
            - enabled
            - enable-received
            - enable-pending
            - enable-submtited
            - delete-received
            - delete-pending
            - delete-submitted
            - deleted
          example: enable-received
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          example: 2019-10-15T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
    NumberBlockOrder:
      example:
        connection_id: "346789098765567"
        created_at: 2018-01-01T00:00:00.000000Z
        customer_reference: MY REF 001
        id: 12ade33a-21c0-473b-b055-b3c836e1c292
        messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600
        phone_numbers_count: 10
        range: 10
        record_type: number_block_order
        requirements_met: true
        starting_number: "+19705555000"
        status: pending
        updated_at: 2018-01-01T00:00:00.000000Z
      properties:
        connection_id:
          description: Identifies the connection associated to all numbers in the phone number block.
          example: "346789098765567"
          type: string
        created_at:
          description: An ISO 8901 datetime string denoting when the number order was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        messaging_profile_id:
          description: Identifies the messaging profile associated to all numbers in the phone number block.
          example: abc85f64-5717-4562-b3fc-2c9600
          type: string
        phone_numbers_count:
          description: The count of phone numbers in the number order.
          example: 1
          readOnly: true
          type: integer
        range:
          description: The phone number range included in the block.
          example: 10
          type: integer
        record_type:
          example: number_block_order
          readOnly: true
          type: string
        requirements_met:
          description: True if all requirements are met for every phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        starting_number:
          description: Starting phone number block
          example: "+19705555000"
          format: e164_phone_number
          type: string
        status:
          description: The status of the order.
          enum:
            - pending
            - success
            - failure
          example: success
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the number order was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
    NumberHealthMetrics:
      description: |
        High level health metrics about the number and it's messaging sending patterns.
      example:
        inbound_outbound_ratio: 1
        message_count: 10
        spam_ratio: 10
        success_ratio: 2
      nullable: false
      properties:
        inbound_outbound_ratio:
          description: The ratio of messages received to the number of messages sent.
          format: float
          type: number
        message_count:
          description: The number of messages analyzed for the health metrics.
          type: integer
        spam_ratio:
          description: The ratio of messages blocked for spam to the number of messages attempted.
          format: float
          type: number
        success_ratio:
          description: The ratio of messages sucessfully delivered to the number of messages attempted.
          format: float
          type: number
      required:
        - message_count
        - inbound_outbound_ratio
        - success_ratio
        - spam_ratio
      type: object
    NumberLookupRecord:
      properties:
        caller_name:
          $ref: "#/components/schemas/CallerName"
        carrier:
          $ref: "#/components/schemas/Carrier"
        country_code:
          description: Region code that matches the specific country calling code
          example: US
          type: string
        fraud:
          description: Unused
          example: null
          type: string
        national_format:
          description: Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found
          example: (0312) 945-7420
          type: string
        phone_number:
          description: E164-formatted phone number
          example: "+13129457420"
          type: string
        portability:
          $ref: "#/components/schemas/Portability"
        record_type:
          description: Identifies the type of record
          example: number_lookup
          type: string
      title: NumberLookup
      type: object
    NumberOrder:
      properties:
        billing_group_id:
          description: Identifies the messaging profile associated with the phone number.
          example: abc85f64-5717-4562-b3fc-2c9600
          type: string
        connection_id:
          description: Identifies the connection associated with this phone number.
          example: "346789098765567"
          type: string
        created_at:
          description: An ISO 8901 datetime string denoting when the number order was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        messaging_profile_id:
          description: Identifies the messaging profile associated with the phone number.
          example: abc85f64-5717-4562-b3fc-2c9600
          type: string
        phone_numbers_count:
          description: The count of phone numbers in the number order.
          example: 1
          readOnly: true
          type: integer
        record_type:
          example: number_order
          readOnly: true
          type: string
        requirements_met:
          description: True if all requirements are met for every phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        status:
          description: The status of the order.
          enum:
            - pending
            - success
            - failure
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the number order was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
    NumberOrderBlockEvent:
      properties:
        data:
          $ref: "#/components/schemas/NumberBlockOrder"
      title: Number Order Event
      type: object
    NumberOrderDocument:
      example:
        created_at: 2018-01-01T00:00:00.000000Z
        customer_reference: MY REF 001
        file_id: 1e3c5822-0362-4702-8e46-5a129f0d3976
        id: 387d1e31-a218-4375-8151-103f2d5e2d2c
        record_type: number_order_document
        requirement_type: address_proof
        requirements_id: 36aaf27d-986b-493c-bd1b-de16af2e4292
      properties:
        created_at:
          description: An ISO 8901 datetime string denoting when the number order document was uploaded.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        file_id:
          description: The id of the file to associate as a number order document.
          example: 1e3c5822-0362-4702-8e46-5a129f0d3976
          type: string
        id:
          example: 387d1e31-a218-4375-8151-103f2d5e2d2c
          format: uuid
          readOnly: true
          type: string
        record_type:
          example: number_order_document
          readOnly: true
          type: string
        requirement_type:
          enum:
            - address_proof
            - identification
            - reg_form
          readOnly: true
          type: string
        requirements_id:
          description: Unique id for a requirement.
          example: 36aaf27d-986b-493c-bd1b-de16af2e4292
          type: string
    NumberOrderPhoneNumber:
      properties:
        country_code:
          example: US
          type: string
        id:
          example: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
          format: uuid
          readOnly: true
          type: string
        order_request_id:
          example: dc8e4d67-33a0-4cbb-af74-7b58f05bd495
          format: uuid
          type: string
        phone_number:
          example: "+19705555098"
          format: e164_phone_number
          type: string
        phone_number_type:
          enum:
            - local
            - toll-free
            - mobile
            - national
            - shared-cost
          example: local
          type: string
        record_type:
          example: number_order_phone_number
          readOnly: true
          type: string
        regulatory_requirements:
          items:
            $ref: "#/components/schemas/PhoneNumberRegulatoryRequirement"
          type: array
        requirements_met:
          description: True if all requirements are met for a phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        status:
          description: The status of the phone number in the order.
          enum:
            - pending
            - success
            - failure
          readOnly: true
          type: string
        sub_number_order_id:
          example: dc8e4d67-33a0-4cbb-af74-7b58f05bd496
          format: uuid
          type: string
    NumberOrderWithPhoneNumbers:
      allOf:
        - $ref: "#/components/schemas/NumberOrder"
        - properties:
            phone_numbers:
              items:
                $ref: "#/components/schemas/PhoneNumber"
              type: array
          type: object
    NumberOrdered:
      properties:
        event_type:
          description: The type of event being delivered.
          example: number_order.complete
          type: string
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          type: string
        payload:
          $ref: "#/components/schemas/NumberOrder"
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Number Order Event Data
      type: object
    NumberOrderedEvent:
      properties:
        data:
          $ref: "#/components/schemas/NumberOrdered"
      title: Number Order Event
      type: object
    NumberPoolSettings:
      description: |
        Number Pool allows you to send messages from a pool of numbers of different types, assigning
        weights to each type. The pool consists of all the long code and toll free numbers
        assigned to the messaging profile.

        To disable this feature, set the object field to `null`.
      example:
        geomatch: false
        long_code_weight: 1
        skip_unhealthy: true
        sticky_sender: false
        toll_free_weight: 10
      nullable: true
      properties:
        geomatch:
          default: false
          description: |
            If set to true, Number Pool will try to choose a sending number with the same area code as the destination
            number. If there are no such numbers available, a nunber with a different area code will be chosen. Currently
            only NANP numbers are supported.
          type: boolean
        long_code_weight:
          description: |
            Defines the probability weight for a Long Code number to be selected when sending a message.
            The higher the weight the higher the probability. The sum of the weights for all number types
            does not necessarily need to add to 100.  Weight must be a non-negative number, and when equal
            to zero it will remove the number type from the pool.
          example: 1
          type: number
        skip_unhealthy:
          description: |
            If set to true all unhealthy numbers will be automatically excluded from the pool.
            Health metrics per number are calculated on a regular basis, taking into account the deliverability
            rate and the amount of messages marked as spam by upstream carriers.
            Numbers with a deliverability rate below 25% or spam ratio over 75% will be considered unhealthy.
          example: true
          type: boolean
        sticky_sender:
          default: false
          description: |
            If set to true, Number Pool will try to choose the same sending number for all messages to a particular
            recipient. If the sending number becomes unhealthy and `skip_unhealthy` is set to true, a new
            number will be chosen.
          type: boolean
        toll_free_weight:
          description: |
            Defines the probability weight for a Toll Free number to be selected when sending a message.
            The higher the weight the higher the probability. The sum of the weights for all number types
            does not necessarily need to add to 100. Weight must be a non-negative number, and when equal
            to zero it will remove the number type from the pool.
          example: 10
          type: number
      required:
        - toll_free_weight
        - long_code_weight
        - skip_unhealthy
      type: object
    NumberReservation:
      example:
        created_at: 2018-01-01T00:00:00.000000Z
        customer_reference: MY REF 001
        id: 12ade33a-21c0-473b-b055-b3c836e1c292
        phone_numbers:
          - created_at: 2018-01-01T00:00:00.000000Z
            errors: ""
            expired_at: 2018-01-01T00:00:00.000000Z
            id: 12ade33a-21c0-473b-b055-b3c836e1c292
            phone_number: "+19705555098"
            record_type: reserved_phone_number
            status: pending
            updated_at: 2018-01-01T00:00:00.000000Z
        record_type: number_reservation
        status: pending
        updated_at: 2018-01-01T00:00:00.000000Z
      properties:
        created_at:
          description: An ISO 8901 datetime string denoting when the numbers reservation was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        phone_numbers:
          items:
            $ref: "#/components/schemas/ReservedPhoneNumber"
          type: array
        record_type:
          example: number_reservation
          readOnly: true
          type: string
        status:
          description: The status of the entire reservation.
          enum:
            - pending
            - success
            - failure
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the number reservation was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
    Organization:
      description: Contact organization information
      example:
        company: WhatsApp
        department: Design
        title: Manager
      properties:
        company:
          description: Name of the contact's company
          type: string
        department:
          description: Name of the contact's department
          type: string
        title:
          description: Contact's business title
          type: string
      required:
        - company
      title: Organization
      type: object
    OutboundCallRecording:
      example:
        call_recording_caller_phone_numbers:
          - "+19705555098"
        call_recording_channels: dual
        call_recording_format: mp3
        call_recording_type: by_caller_phone_number
      properties:
        call_recording_caller_phone_numbers:
          description: When call_recording_type is 'by_caller_phone_number', only outbound calls using one of these numbers will be recorded. Numbers must be specified in E164 format.
          example:
            - "+19705555098"
          items:
            type: string
          type: array
        call_recording_channels:
          default: single
          description: When using 'dual' channels, the final audio file will be a stereo recording with the first leg on channel A, and the rest on channel B.
          enum:
            - single
            - dual
          example: dual
          type: string
        call_recording_format:
          default: wav
          description: The audio file format for calls being recorded.
          enum:
            - wav
            - mp3
          example: mp3
          type: string
        call_recording_type:
          description: Specifies which calls are recorded.
          enum:
            - all
            - none
            - by_caller_phone_number
          type: string
      type: object
    OutboundIp:
      example:
        ani_override: string
        ani_override_type: always
        call_parking_enabled: true
        channel_limit: 10
        generate_ringback_tone: true
        instant_ringback_enabled: true
        ip_authentication_method: token
        ip_authentication_token: string
        localization: string
        outbound_voice_profile_id: "1293384261075731499"
        t38_reinvite_source: telnyx
        tech_prefix: string
      properties:
        ani_override:
          default: ""
          description: Set a phone number as the ani_override value to override caller id number on outbound calls.
          type: string
        ani_override_type:
          default: always
          description: Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.
          enum:
            - always
            - normal
            - emergency
          type: string
        call_parking_enabled:
          default: false
          description: Forces all SIP calls originated on this connection to be "parked" instead of "bridged" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next.
          type: boolean
        channel_limit:
          default: null
          description: When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
          type: integer
        generate_ringback_tone:
          default: false
          description: Generate ringback tone through 183 session progress message with early media.
          type: boolean
        instant_ringback_enabled:
          default: true
          description: When set, ringback will not wait for indication before sending ringback tone to calling party.
          type: boolean
        ip_authentication_method:
          default: tech-prefixp-charge-info
          enum:
            - tech-prefixp-charge-info
            - token
          example: tech-prefixp-charge-info
          type: string
        ip_authentication_token:
          default: null
          type: string
        localization:
          default: null
          description: A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.
          type: string
        outbound_voice_profile_id:
          $ref: "#/components/schemas/OutboundVoiceProfileId"
        t38_reinvite_source:
          default: telnyx
          description: This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite.
          enum:
            - telnyx
            - customer
            - disabled
            - passthru
            - caller-passthru
            - callee-passthru
          type: string
        tech_prefix:
          default: ""
          description: Numerical chars only, exactly 4 characters.
          type: string
      title: Outband Ip
      type: object
    OutboundMessage:
      example:
        event_type: message.sent
        id: 86f58db9-0fe3-4adc-9d1f-46e66e6e9323
        occurred_at: date-time
        payload:
          completed_at: null
          cost: null
          direction: outbound
          encoding: GSM-7
          errors: []
          from:
            carrier: TELNYX LLC
            line_type: VoIP
            phone_number: "+18445550001"
          id: 40385f64-5717-4562-b3fc-2c963f66afa6
          media:
            - content_type: null
              sha256: null
              size: null
              url: https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png
          messaging_profile_id: 4000eba1-a0c0-4563-9925-b25e842a7cb6
          organization_id: b448f9cc-a842-4784-98e9-03c1a5872950
          parts: 1
          received_at: 2019-01-23T18:10:02.574Z
          record_type: message
          sent_at: null
          subject: From Telnyx!
          tags:
            - Greetings
          text: Hello, World!
          to:
            - carrier: T-MOBILE USA, INC.
              line_type: Wireless
              phone_number: "+18665550001"
              status: queued
          type: MMS
          valid_until: null
          webhook_failover_url: https://backup.example.com/hooks
          webhook_url: https://www.example.com/hooks
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - message.sent
            - message.finalized
          example: message.sent
          type: string
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          type: string
        payload:
          $ref: "#/components/schemas/OutboundMessagePayload"
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
    OutboundMessageEvent:
      properties:
        data:
          $ref: "#/components/schemas/OutboundMessage"
        meta:
          properties:
            attempt:
              description: Number of attempts to deliver the webhook event.
              example: 1
              type: integer
            delivered_to:
              description: The webhook URL the event was delivered to.
              example: https://www.example.com/hooks
              format: url
              type: string
          type: object
      type: object
    OutboundMessagePayload:
      example:
        completed_at: null
        cost: null
        direction: outbound
        encoding: GSM-7
        errors: []
        from:
          carrier: TELNYX LLC
          line_type: VoIP
          phone_number: "+18445550001"
        id: 40385f64-5717-4562-b3fc-2c963f66afa6
        media:
          - content_type: null
            sha256: null
            size: null
            url: https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png
        messaging_profile_id: 4000eba1-a0c0-4563-9925-b25e842a7cb6
        organization_id: b448f9cc-a842-4784-98e9-03c1a5872950
        parts: 1
        received_at: 2019-01-23T18:10:02.574Z
        record_type: message
        sent_at: null
        subject: From Telnyx!
        tags:
          - Greetings
        text: Hello, World!
        to:
          - carrier: T-MOBILE USA, INC.
            line_type: Wireless
            phone_number: "+18665550001"
            status: queued
        type: MMS
        valid_until: null
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: https://www.example.com/hooks
      properties:
        completed_at:
          description: ISO 8601 formatted date indicating when the message was finalized.
          format: date-time
          type: string
        cost:
          nullable: true
          properties:
            amount:
              description: The amount deducted from your account.
              format: decimal
              type: string
            currency:
              description: The ISO 4217 currency identifier.
              format: iso4217
              type: string
          type: object
        direction:
          description: The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you.
          enum:
            - outbound
          example: outbound
          type: string
        encoding:
          description: Encoding scheme used for the message body.
          type: string
        errors:
          description: These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.
          items:
            $ref: "#/components/schemas/Error"
          type: array
        from:
          properties:
            carrier:
              description: The carrier of the receiver.
              type: string
            line_type:
              description: The line-type of the receiver.
              enum:
                - Wireline
                - Wireless
                - VoWiFi
                - VoIP
                - Pre-Paid Wireless
                - ""
              type: string
            phone_number:
              description: Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).
              format: address
              type: string
          type: object
        id:
          description: Identifies the type of resource.
          format: uuid
          type: string
        media:
          items:
            properties:
              content_type:
                description: The MIME type of the requested media.
                format: mime-type
                nullable: true
                type: string
              sha256:
                description: The SHA256 hash of the requested media.
                nullable: true
                type: string
              size:
                description: The size of the requested media.
                nullable: true
                type: integer
              url:
                description: The url of the media requested to be sent.
                format: url
                type: string
            type: object
          type: array
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          type: string
        organization_id:
          description: The id of the organization the messaging profile belongs to.
          format: uuid
          type: string
        parts:
          description: Number of parts into which the message's body must be split.
          maximum: 10
          minimum: 1
          type: integer
        received_at:
          description: ISO 8601 formatted date indicating when the message request was received.
          format: date-time
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - message
          example: message
          type: string
        sent_at:
          description: ISO 8601 formatted date indicating when the message was sent.
          format: date-time
          type: string
        subject:
          description: Subject of multimedia message
          nullable: true
          type: string
        tags:
          description: Tags associated with the resource.
          items:
            type: string
          type: array
        text:
          description: |-
            Message body (i.e., content) as a non-empty string.

            **Required for SMS**
          type: string
        to:
          items:
            properties:
              carrier:
                description: The carrier of the receiver.
                type: string
              line_type:
                description: The line-type of the receiver.
                enum:
                  - Wireline
                  - Wireless
                  - VoWiFi
                  - VoIP
                  - Pre-Paid Wireless
                  - ""
                type: string
              phone_number:
                description: Receiving address (+E.164 formatted phone number or short code).
                format: address
                type: string
              status:
                description: The delivery status of the message.
                enum:
                  - queued
                  - sending
                  - sent
                  - expired
                  - sending_failed
                  - delivery_unconfirmed
                  - delivered
                  - delivery_failed
                type: string
            type: object
          type: array
        type:
          description: The type of message.
          enum:
            - SMS
            - MMS
          type: string
        valid_until:
          description: Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled
          format: date-time
          nullable: true
          type: string
        webhook_failover_url:
          description: The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.
          format: url
          nullable: true
          type: string
        webhook_url:
          description: The URL where webhooks related to this message will be sent.
          format: url
          nullable: true
          type: string
      type: object
    OutboundVoiceProfile:
      example:
        billing_group_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        call_recording:
          call_recording_caller_phone_numbers:
            - "+19705555098"
          call_recording_channels: dual
          call_recording_format: mp3
          call_recording_type: by_caller_phone_number
        concurrent_call_limit: 10
        connections_count: 12
        created_at: 2018-02-02T22:25:27.521Z
        daily_spend_limit: "100.00"
        daily_spend_limit_enabled: true
        enabled: true
        id: "1293384261075731499"
        max_destination_rate: 10
        name: office
        record_type: outbound_voice_profile
        service_plan: global
        tags:
          - office-profile
        traffic_type: conversational
        updated_at: 2018-02-02T22:25:27.521Z
        usage_payment_method: rate-deck
        whitelisted_destinations:
          - US
          - BR
          - AU
      properties:
        billing_group_id:
          default: null
          description: The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          nullable: true
          type: string
        call_recording:
          $ref: "#/components/schemas/OutboundCallRecording"
        concurrent_call_limit:
          description: Must be no more than your global concurrent call limit. Null means no limit.
          example: 10
          nullable: true
          type: integer
        connections_count:
          description: Amount of connections associated with this outbound voice profile.
          example: 12
          type: integer
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        daily_spend_limit:
          description: The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.
          example: "100.00"
          type: string
        daily_spend_limit_enabled:
          default: false
          description: Specifies whether to enforce the daily_spend_limit on this outbound voice profile.
          example: true
          type: boolean
        enabled:
          default: true
          description: Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.
          example: true
          type: boolean
        id:
          description: Identifies the resource.
          example: "1293384261075731499"
          format: int64
          type: string
        max_destination_rate:
          description: Maximum rate (price per minute) for a Destination to be allowed when making outbound calls.
          type: number
        name:
          description: A user-supplied name to help with organization.
          example: office
          minLength: 3
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: outbound_voice_profile
          type: string
        service_plan:
          $ref: "#/components/schemas/ServicePlan"
        tags:
          example:
            - office-profile
          items:
            type: string
          type: array
        traffic_type:
          $ref: "#/components/schemas/TrafficType"
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
        usage_payment_method:
          $ref: "#/components/schemas/UsagePaymentMethod"
        whitelisted_destinations:
          default:
            - US
            - CA
          description: The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.
          example:
            - US
            - BR
            - AU
          items:
            type: string
          type: array
      required:
        - name
      title: Outbound Voice Profile
      type: object
    OutboundVoiceProfileId:
      description: Identifies the associated outbound voice profile.
      example: "1293384261075731499"
      format: int64
      title: Outbound Voice Profile ID
      type: string
    PaginationMeta:
      properties:
        page_number:
          example: 2
          type: integer
        page_size:
          example: 25
          type: integer
        total_pages:
          example: 3
          type: integer
        total_results:
          example: 55
          type: integer
      type: object
    PaginationMetaSimple:
      properties:
        page_number:
          example: 2
          type: integer
        page_size:
          example: 25
          type: integer
        total_pages:
          example: 3
          type: integer
        total_results:
          example: 55
          type: integer
      type: object
    Participant:
      example:
        call_control_id: v2:v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ
        call_leg_id: 3a15df2d-c801-4729-adf5-b56dd42e2abb
        conference:
          id: 41b9acd4-f4da-4ff5-a85c-e07e90b53f46
          name: "1"
        created_at: 2019-01-23T18:10:02.574Z
        end_conference_on_exit: true
        id: dfadada7-af74-47bc-83a4-554275f55f5c
        muted: false
        on_hold: true
        record_type: participant
        soft_end_conference_on_exit: true
        status: joining
        updated_at: 2019-01-23T18:10:02.574Z
        whisper_call_control_ids:
          - v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ
          - v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw
      properties:
        call_control_id:
          description: Call Control ID associated with the partiipant of the conference
          example: v2:v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ
          type: string
        call_leg_id:
          description: Uniquely identifies the call leg associated with the participant
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: string
        conference:
          description: Info about the conference that the participant is in
          properties:
            id:
              description: Uniquely identifies the conference
              example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              type: string
            name:
              description: Name of the conference
              example: All hands meeting
              type: string
          type: object
        created_at:
          description: ISO 8601 formatted date of when the participant was created
          example: 2019-01-23T18:10:02.574Z
          type: string
        end_conference_on_exit:
          description: Whether the conference will end and all remaining participants be hung up after the participant leaves the conference.
          example: true
          type: boolean
        id:
          description: Uniquely identifies the participant
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: string
        muted:
          description: Whether the participant is muted.
          example: true
          type: boolean
        on_hold:
          description: Whether the participant is put on_hold.
          example: true
          type: boolean
        record_type:
          enum:
            - participant
          example: participant
          type: string
        soft_end_conference_on_exit:
          description: Whether the conference will end after the participant leaves the conference.
          example: true
          type: boolean
        status:
          description: The status of the participant with respect to the lifecycle within the conference
          enum:
            - joining
            - joined
            - left
          example: joining
          type: string
        updated_at:
          description: ISO 8601 formatted date of when the participant was last updated
          example: 2019-01-23T18:10:02.574Z
          type: string
        whisper_call_control_ids:
          description: Array of unique call_control_ids the participant can whisper to..
          example:
            - v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ
            - v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw
          items:
            type: string
          type: array
      required:
        - record_type
        - id
        - call_leg_id
        - call_control_id
        - conference
        - whisper_call_control_ids
        - created_at
        - updated_at
        - end_conference_on_exit
        - soft_end_conference_on_exit
        - status
        - muted
        - on_hold
      title: Participant
      type: object
    PassThroughFee:
      properties:
        amount:
          description: Normalized carrier pass through fee
          example: 0.1
          type: number
        currency:
          $ref: "#/components/schemas/Currency"
      type: object
    PauseRecordingRequest:
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      title: Pause Recording Request
      type: object
    Phone:
      example:
        id: "16505551234"
        phone: +1 (650) 555-1234
        type: WORK
      properties:
        id:
          description: WhatsApp ID
          type: string
        phone:
          type: string
        type:
          description: "Standard Values: CELL, MAIN, IPHONE, HOME, WORK"
          type: string
      title: Phone Number
      type: object
    PhoneNumber:
      example:
        id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
        phone_number: "+19705555098"
        record_type: number_order_phone_number
        regulatory_group_id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
        regulatory_requirements:
          - field_type: address
            field_value: 45f45a04-b4be-4592-95b1-9306b9db2b21
            record_type: phone_number_regulatory_requirement
            requirement_id: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
        requirements_met: true
        status: success
      properties:
        id:
          example: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
          format: uuid
          readOnly: true
          type: string
        phone_number:
          example: "+19705555098"
          format: e164_phone_number
          type: string
        record_type:
          example: number_order_phone_number
          readOnly: true
          type: string
        regulatory_group_id:
          example: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
          readOnly: true
          type: string
        regulatory_requirements:
          items:
            $ref: "#/components/schemas/PhoneNumberRegulatoryRequirement"
          type: array
        requirements_met:
          description: True if all requirements are met for a phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        status:
          description: The status of the phone number in the order.
          enum:
            - pending
            - success
            - failure
          readOnly: true
          type: string
    PhoneNumberBlocksJob:
      example:
        created_at: 2020-10-23T18:10:00.000Z
        etc: 2020-10-30T18:10:00.000Z
        failed_operations: []
        id: 42587e44-3a3e-46de-9255-0c9a7a1d1ec7
        record_type: phone_numbers_job
        status: pending
        successful_operations: []
        type: delete_phone_number_block
        updated_at: 2020-10-23T18:10:01.000Z
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          readOnly: true
          type: string
        etc:
          description: ISO 8601 formatted date indicating when the estimated time of completion of the background job.
          format: date-time
          readOnly: true
          type: string
        failed_operations:
          items:
            $ref: "#/components/schemas/PhoneNumberBlocksJobFailedOperation"
          readOnly: true
          type: array
        id:
          description: Identifies the resource.
          example: 42587e44-3a3e-46de-9255-0c9a7a1d1ec7
          format: uuid
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: phone_number_block_job
          readOnly: true
          type: string
        status:
          default: pending
          description: Indicates the completion status of the background operation.
          enum:
            - pending
            - in_progress
            - completed
            - failed
          example: pending
          readOnly: true
          type: string
        successful_operations:
          items:
            $ref: "#/components/schemas/PhoneNumberBlocksJobSuccessfulOperation"
            description: The phone numbers successfully updated.
          readOnly: true
          type: array
        type:
          description: Identifies the type of the background job.
          enum:
            - delete_phone_number_block
          example: delete_phone_number_block
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          readOnly: true
          type: string
      type: object
    PhoneNumberBlocksJobDeletePhoneNumberBlockRequest:
      example:
        phone_number_block_id: f3946371-7199-4261-9c3d-81a0d7935146
      properties:
        phone_number_block_id:
          type: string
      required:
        - phone_number_block_id
      type: object
    PhoneNumberBlocksJobFailedOperation:
      properties:
        errors:
          items:
            $ref: "#/components/schemas/Error"
          type: array
        id:
          description: The phone number's ID
          format: int64
          type: string
        phone_number:
          description: The phone number in e164 format.
          format: e164
          type: string
    PhoneNumberBlocksJobSuccessfulOperation:
      properties:
        id:
          description: The phone number's ID
          format: int64
          type: string
        phone_number:
          description: The phone number in e164 format.
          format: e164
          type: string
    PhoneNumberDeletedDetailed:
      example:
        billing_group_id: 86f58db9-0fe3-4adc-9d1f-46e66e6e9323
        call_forwarding_enabled: true
        call_recording_enabled: true
        caller_id_name_enabled: true
        cnam_listing_enabled: true
        connection_id: "1293384261075731499"
        connection_name: connection-name
        created_at: 2019-10-23T18:10:00.000Z
        customer_reference: customer-reference
        emergency_address_id: "1315261609962112019"
        emergency_enabled: true
        external_pin: "1234"
        id: "1293384261075731499"
        messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
        messaging_profile_name: regional-customers
        number_level_routing: disabled
        phone_number: "+19705555098"
        phone_number_type: longcode
        purchased_at: 2019-10-23T18:10:00.000Z
        record_type: phone_number
        status: deleted
        t38_fax_gateway_enabled: true
        tags:
          - tag_1
          - tag_2
        updated_at: 2019-10-24T18:10:00.000Z
      properties:
        billing_group_id:
          description: Identifies the billing group associated with the phone number.
          type: string
        call_forwarding_enabled:
          default: true
          description: Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.
          readOnly: true
          type: boolean
        call_recording_enabled:
          description: Indicates whether call recording is enabled for this number.
          readOnly: true
          type: boolean
        caller_id_name_enabled:
          description: Indicates whether caller ID is enabled for this number.
          readOnly: true
          type: boolean
        cnam_listing_enabled:
          description: Indicates whether a CNAM listing is enabled for this number.
          readOnly: true
          type: boolean
        connection_id:
          description: Identifies the connection associated with the phone number.
          type: string
        connection_name:
          description: The user-assigned name of the connection to be associated with this phone number.
          readOnly: true
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the time it took to activate after the purchase.
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        emergency_address_id:
          description: Identifies the emergency address associated with the phone number.
          format: int64
          readOnly: true
          type: string
        emergency_enabled:
          description: Indicates whether emergency services are enabled for this number.
          readOnly: true
          type: boolean
        external_pin:
          description: If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.
          type: string
        id:
          $ref: "#/components/schemas/IntId"
        messaging_profile_id:
          description: Identifies the messaging profile associated with the phone number.
          type: string
        messaging_profile_name:
          description: The name of the messaging profile associated with the phone number.
          example: regional-customers
          type: string
        number_level_routing:
          default: enabled
          description: Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level.
          enum:
            - enabled
            - disabled
          type: string
        phone_number:
          description: The +E.164-formatted phone number associated with this record.
          readOnly: true
          type: string
        phone_number_type:
          description: The phone number's type.
          enum:
            - longcode
            - tollfree
          readOnly: true
          type: string
        purchased_at:
          description: ISO 8601 formatted date indicating the time the request was made to purchase the number.
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: phone_number
          readOnly: true
          type: string
        status:
          description: The phone number's current status.
          enum:
            - purchase-pending
            - purchase-failed
            - port-pending
            - port-failed
            - active
            - deleted
            - emergency-only
            - ported-out
            - port-out-pending
          readOnly: true
          type: string
        t38_fax_gateway_enabled:
          description: Indicates whether T38 Fax Gateway for inbound calls to this number.
          readOnly: true
          type: boolean
        tags:
          description: A list of user-assigned tags to help manage the phone number.
          items:
            type: string
          type: array
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          readOnly: true
          type: string
      type: object
    PhoneNumberDetailed:
      example:
        billing_group_id: 86f58db9-0fe3-4adc-9d1f-46e66e6e9323
        call_forwarding_enabled: true
        call_recording_enabled: true
        caller_id_name_enabled: true
        cnam_listing_enabled: true
        connection_id: "1293384261075731499"
        connection_name: connection-name
        created_at: 2019-10-23T18:10:00.000Z
        customer_reference: customer-reference
        emergency_address_id: "1315261609962112019"
        emergency_enabled: true
        external_pin: "1234"
        id: "1293384261075731499"
        messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
        messaging_profile_name: regional-customers
        number_level_routing: disabled
        phone_number: "+19705555098"
        phone_number_type: longcode
        purchased_at: 2019-10-23T18:10:00.000Z
        record_type: phone_number
        status: active
        t38_fax_gateway_enabled: true
        tags:
          - tag_1
          - tag_2
        updated_at: 2019-10-24T18:10:00.000Z
      properties:
        billing_group_id:
          description: Identifies the billing group associated with the phone number.
          type: string
        call_forwarding_enabled:
          default: true
          description: Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.
          readOnly: true
          type: boolean
        call_recording_enabled:
          description: Indicates whether call recording is enabled for this number.
          readOnly: true
          type: boolean
        caller_id_name_enabled:
          description: Indicates whether caller ID is enabled for this number.
          readOnly: true
          type: boolean
        cnam_listing_enabled:
          description: Indicates whether a CNAM listing is enabled for this number.
          readOnly: true
          type: boolean
        connection_id:
          description: Identifies the connection associated with the phone number.
          type: string
        connection_name:
          description: The user-assigned name of the connection to be associated with this phone number.
          readOnly: true
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        emergency_address_id:
          description: Identifies the emergency address associated with the phone number.
          format: int64
          readOnly: true
          type: string
        emergency_enabled:
          description: Indicates whether emergency services are enabled for this number.
          readOnly: true
          type: boolean
        external_pin:
          description: If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.
          type: string
        id:
          $ref: "#/components/schemas/IntId"
        messaging_profile_id:
          description: Identifies the messaging profile associated with the phone number.
          type: string
        messaging_profile_name:
          description: The name of the messaging profile associated with the phone number.
          example: regional-customers
          type: string
        number_level_routing:
          default: enabled
          description: Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level.
          enum:
            - enabled
            - disabled
          type: string
        phone_number:
          description: The +E.164-formatted phone number associated with this record.
          readOnly: true
          type: string
        phone_number_type:
          description: The phone number's type.
          enum:
            - longcode
            - tollfree
          readOnly: true
          type: string
        purchased_at:
          description: ISO 8601 formatted date indicating when the resource was purchased.
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: phone_number
          readOnly: true
          type: string
        status:
          description: The phone number's current status.
          enum:
            - purchase-pending
            - purchase-failed
            - port-pending
            - port-failed
            - active
            - deleted
            - emergency-only
            - ported-out
            - port-out-pending
          readOnly: true
          type: string
        t38_fax_gateway_enabled:
          description: Indicates whether T38 Fax Gateway for inbound calls to this number.
          readOnly: true
          type: boolean
        tags:
          description: A list of user-assigned tags to help manage the phone number.
          items:
            type: string
          type: array
      type: object
    PhoneNumberEnableEmergencyRequest:
      example:
        emergency_address_id: "53829456729313"
        emergency_enabled: true
      properties:
        emergency_address_id:
          description: Identifies the address to be used with emergency services.
          format: int64
          type: string
        emergency_enabled:
          description: Indicates whether to enable emergency services on this number.
          type: boolean
      required:
        - emergency_enabled
        - emergency_address_id
      type: object
    PhoneNumberRegulatoryRequirement:
      allOf:
        - $ref: "#/components/schemas/SubNumberOrderRegulatoryRequirement"
        - properties:
            field_value:
              description: The value of the requirement, this could be an id to a resource or a string value.
              example: 45f45a04-b4be-4592-95b1-9306b9db2b21
              type: string
          type: object
    PhoneNumberWithMessagingSettings:
      example:
        country_code: US
        created_at: 2019-01-23T18:10:02.574Z
        eligible_messaging_products:
          - A2P
        features:
          mms: null
          sms:
            domestic_two_way: true
            international_inbound: true
            international_outbound: true
        health:
          inbound_outbound_ratio: 0.43
          message_count: 122
          spam_ratio: 0.06
          success_ratio: 0.94
        id: "1293384261075731499"
        messaging_product: A2P
        messaging_profile_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        phone_number: "+18005550001"
        record_type: messaging_settings
        traffic_type: A2P
        type: toll-free
        updated_at: 2019-01-23T18:10:02.574Z
      properties:
        country_code:
          description: ISO 3166-1 alpha-2 country code.
          example: US
          pattern: ^[A-Z]{2}$
          readOnly: true
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          readOnly: true
          type: string
        eligible_messaging_products:
          description: The messaging products that this number can be registered to use
          items:
            type: string
          readOnly: true
          type: array
        features:
          properties:
            mms:
              $ref: "#/components/schemas/MessagingFeatureSet"
            sms:
              $ref: "#/components/schemas/MessagingFeatureSet"
          readOnly: true
          type: object
        health:
          $ref: "#/components/schemas/NumberHealthMetrics"
        id:
          description: Identifies the type of resource.
          readOnly: true
          type: string
        messaging_product:
          description: The messaging product that the number is registered to use
          example: P2P
          type: string
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          nullable: true
          type: string
        phone_number:
          description: +E.164 formatted phone number.
          format: e164
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - messaging_phone_number
            - messaging_settings
          example: messaging_settings
          readOnly: true
          type: string
        traffic_type:
          description: The messaging traffic or use case for which the number is currently configured.
          example: P2P
          readOnly: true
          type: string
        type:
          description: The type of the phone number
          enum:
            - long-code
            - toll-free
            - short-code
            - longcode
            - tollfree
            - shortcode
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          format: date-time
          readOnly: true
          type: string
      type: object
    PhoneNumberWithVoiceSettings:
      example:
        call_forwarding:
          call_forwarding_enabled: true
          forwarding_type: always
          forwards_to: "+13035559123"
        call_recording:
          inbound_call_recording_channels: single
          inbound_call_recording_enabled: true
          inbound_call_recording_format: wav
        cnam_listing:
          cnam_listing_details: example
          cnam_listing_enabled: true
        connection_id: 1d0e6cb8-8668-462e-94c6-49ae0f0ed48b
        customer_reference: customer-reference
        emergency:
          emergency_address_id: "1315261609962112019"
          emergency_enabled: true
        id: "1293384261075731499"
        media_features:
          accept_any_rtp_packets_enabled: true
          media_handling_mode: default
          rtp_auto_adjust_enabled: true
          t38_fax_gateway_enabled: true
        record_type: voice_settings
        tech_prefix_enabled: false
        translated_number: "+13035559999"
        usage_payment_method: pay-per-minute
      properties:
        call_forwarding:
          $ref: "#/components/schemas/CallForwarding"
        call_recording:
          $ref: "#/components/schemas/CallRecording"
        cnam_listing:
          $ref: "#/components/schemas/CnamListing"
        connection_id:
          description: Identifies the connection associated with this phone number.
          example: 1d0e6cb8-8668-462e-94c6-49ae0f0ed48b
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        emergency:
          $ref: "#/components/schemas/EmergencySettings"
        id:
          description: Identifies the type of resource.
          example: "1293384261075731499"
          readOnly: true
          type: string
        media_features:
          $ref: "#/components/schemas/MediaFeatures"
        phone_number:
          description: The phone number in +E164 format.
          example: "+13035551234"
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: voice_settings
          readOnly: true
          type: string
        tech_prefix_enabled:
          default: false
          description: Controls whether a tech prefix is enabled for this phone number.
          example: false
          type: boolean
        translated_number:
          default: ""
          description: This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed.
          example: "+13035559999"
          type: string
        usage_payment_method:
          default: pay-per-minute
          description: Controls whether a number is billed per minute or uses your concurrent channels.
          enum:
            - pay-per-minute
            - channel
          example: pay-per-minute
          type: string
      type: object
    PhoneNumbersBulkUpdateError:
      properties:
        errors:
          items:
            $ref: "#/components/schemas/Error"
          type: array
        phone_number:
          description: The phone number in e164 format.
          format: e164
          type: string
    PhoneNumbersJob:
      example:
        created_at: 2020-10-23T18:10:00.000Z
        etc: 2020-10-30T18:10:00.000Z
        failed_operations:
          - errors:
              - code: "10015"
                detail: The field is invalid.
                source: /emergency_address_id
                title: Bad Request
            id: "3388768018273"
            phone_number: "+19705551234"
        id: 42587e44-3a3e-46de-9255-0c9a7a1d1ec7
        pending_operations:
          - id: "2637816387126861837"
            phone_number: "+19705555099"
        record_type: phone_numbers_job
        status: pending
        successful_operations:
          - id: "2637816387126861836"
            phone_number: "+19705555098"
          - id: "33081887126861836"
            phone_number: "+19715555098"
        type: update_emergency_settings
        updated_at: 2020-10-23T18:10:01.000Z
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          readOnly: true
          type: string
        etc:
          description: ISO 8601 formatted date indicating when the estimated time of completion of the background job.
          format: date-time
          readOnly: true
          type: string
        failed_operations:
          items:
            $ref: "#/components/schemas/PhoneNumbersJobFailedOperation"
          readOnly: true
          type: array
        id:
          description: Identifies the resource.
          example: 42587e44-3a3e-46de-9255-0c9a7a1d1ec7
          format: uuid
          readOnly: true
          type: string
        pending_operations:
          items:
            $ref: "#/components/schemas/PhoneNumbersJobPendingOperation"
            description: The phone numbers pending confirmation on update results. Entries in this list are transient, and will be moved to either successful_operations or failed_operations once the processing is done.
          readOnly: true
          type: array
        record_type:
          description: Identifies the type of the resource.
          example: phone_numbers_job
          readOnly: true
          type: string
        status:
          default: pending
          description: Indicates the completion status of the background update.
          enum:
            - pending
            - in_progress
            - completed
            - failed
            - expired
          example: pending
          readOnly: true
          type: string
        successful_operations:
          items:
            $ref: "#/components/schemas/PhoneNumbersJobSuccessfulOperation"
            description: The phone numbers successfully updated.
          readOnly: true
          type: array
        type:
          description: Identifies the type of the background job.
          enum:
            - update_emergency_settings
            - delete_phone_numbers
            - update_phone_numbers
          example: update_emergency_settings
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          readOnly: true
          type: string
      type: object
    PhoneNumbersJobDeletePhoneNumbersRequest:
      example:
        phone_numbers:
          - "+19705555098"
          - "+19715555098"
          - "32873127836"
      properties:
        phone_numbers:
          items:
            description: The phone numbers or IDs to be updated.
            type: string
          type: array
      required:
        - phone_numbers
      type: object
    PhoneNumbersJobFailedOperation:
      properties:
        errors:
          items:
            $ref: "#/components/schemas/Error"
          type: array
        id:
          description: The phone number's ID
          format: int64
          type: string
        phone_number:
          description: The phone number in e164 format.
          format: e164
          type: string
    PhoneNumbersJobPendingOperation:
      properties:
        id:
          description: The phone number's ID
          format: int64
          type: string
        phone_number:
          description: The phone number in e164 format.
          format: e164
          type: string
    PhoneNumbersJobSuccessfulOperation:
      properties:
        id:
          description: The phone number's ID
          format: int64
          type: string
        phone_number:
          description: The phone number in e164 format.
          format: e164
          type: string
    PhoneNumbersJobUpdateEmergencySettingsRequest:
      example:
        emergency_address_id: "53829456729313"
        emergency_enabled: true
        phone_numbers:
          - "+19705555098"
          - "+19715555098"
          - "32873127836"
      properties:
        emergency_address_id:
          description: Identifies the address to be used with emergency services.
          format: int64
          type: string
        emergency_enabled:
          description: Indicates whether to enable emergency services on this number.
          type: boolean
        phone_numbers:
          items:
            description: The phone numbers or IDs to be updated.
            type: string
          type: array
      required:
        - emergency_enabled
        - emergency_address_id
        - phone_numbers
      type: object
    PhoneNumbersJobUpdatePhoneNumbersRequest:
      example:
        billing_group_id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
        connection_id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
        customer_reference: customer-reference
        external_pin: "123456"
        phone_numbers:
          - "1583466971586889004"
          - "+13127367254"
        tags:
          - tag
      properties:
        billing_group_id:
          description: Identifies the billing group associated with the phone number.
          type: string
        connection_id:
          description: Identifies the connection associated with the phone number.
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        external_pin:
          description: If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.
          type: string
        phone_numbers:
          description: Array of phone number ids and/or phone numbers in E164 format to update
          items:
            type: string
          type: array
        tags:
          description: A list of user-assigned tags to help organize phone numbers.
          items:
            type: string
          type: array
      required:
        - phone_numbers
      type: object
    PlayAudioUrlRequest:
      example:
        audio_url: http://www.example.com/sounds/greeting.wav
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        loop: infinity
        overlay: true
        stop: current
        target_legs: self
      properties:
        audio_url:
          description: The URL of a file to be played back on the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request.
          example: http://example.com/message.wav
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        loop:
          $ref: "#/components/schemas/Loopcount"
          default: 1
          description: The number of times the audio file should be played. If supplied, the value must be an integer between 1 and 100, or the special string `infinity` for an endless loop.
          example: infinity
        media_name:
          description: The media_name of a file to be played back on the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.
          example: my_media_uploaded_to_media_storage_api
          type: string
        overlay:
          default: false
          description: "When enabled, audio will be mixed on top of any other audio that is actively being played back. Note that `overlay: true` will only work if there is another audio file already being played on the call."
          example: true
          type: boolean
        stop:
          default: all
          description: When specified, it stops the current audio being played.  Specify `current` to stop the current audio being played, and to play the next file in the queue. Specify `all` to stop the current audio file being played and to also clear all audio files from the queue.
          example: current
          type: string
        target_legs:
          default: self
          description: Specifies the leg or legs on which audio will be played. If supplied, the value must be either `self`, `opposite` or `both`.
          example: self
          type: string
      title: Play Audio URL Request
      type: object
    PlaybackStopRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        stop: all
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        stop:
          default: all
          description: Use `current` to stop only the current audio or `all` to stop all audios in the queue.
          example: current
          type: string
      title: Playback Stop Request
      type: object
    Portability:
      properties:
        altspid:
          description: Alternative SPID (Service Provider ID). Often used when a carrier is using a number from another carrier
          example: 073H
          type: string
        altspid_carrier_name:
          description: Alternative service provider name
          example: Telnyx/4
          type: string
        altspid_carrier_type:
          description: Alternative service provider type
          example: "3"
          type: string
        city:
          description: City name extracted from the locality in the Local Exchange Routing Guide (LERG) database
          example: WAUKEGAN
          type: string
        line_type:
          description: Type of number
          example: voip
          type: string
        lrn:
          description: Local Routing Number, if assigned to the requested phone number
          example: "2245701999"
          type: string
        ocn:
          description: Operating Company Name (OCN) as per the Local Exchange Routing Guide (LERG) database
          example: 073H
          type: string
        ported_date:
          description: ISO-formatted date when the requested phone number has been ported
          example: 2017-10-20
          type: string
        ported_status:
          description: Indicates whether or not the requested phone number has been ported
          enum:
            - Y
            - N
            - ""
          example: Y
          type: string
        spid:
          description: SPID (Service Provider ID)
          example: 073H
          type: string
        spid_carrier_name:
          description: Service provider name
          example: Telnyx/4
          type: string
        spid_carrier_type:
          description: Service provider type
          example: "3"
          type: string
        state:
          example: Illinois
          type: string
      type: object
    PortabilityCheckDetails:
      properties:
        fast_portable:
          description: Indicates whether this phone number is FastPort eligible
          example: true
          readOnly: true
          type: boolean
        not_portable_reason:
          description: If this phone number is not portable, explains why. Empty string if the number is portable.
          example: No coverage
          readOnly: true
          type: string
        phone_number:
          description: The +E.164 formatted phone number this result is about
          example: "+13125550123"
          readOnly: true
          type: string
        portable:
          description: Indicates whether this phone number is portable
          example: true
          readOnly: true
          type: boolean
        record_type:
          description: Identifies the type of the resource.
          example: portability_check_result
          readOnly: true
          type: string
      type: object
    PortabilityStatus:
      description: Specifies whether Telnyx is able to confirm portability this number in the United States & Canada. International phone numbers are provisional by default.
      enum:
        - pending
        - confirmed
        - provisional
      example: confirmed
      type: string
    PortingEndUser:
      properties:
        admin:
          $ref: "#/components/schemas/PortingOrderEndUserAdmin"
        location:
          $ref: "#/components/schemas/PortingOrderEndUserLocation"
      type: object
    PortingOrder:
      properties:
        activation_settings:
          $ref: "#/components/schemas/PortingOrderActivationSettings"
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2021-03-19T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
        end_user:
          $ref: "#/components/schemas/PortingEndUser"
        id:
          description: Uniquely identifies this porting order
          example: f1486bae-f067-460c-ad43-73a92848f902
          format: uuid
          readOnly: true
          type: string
        misc:
          $ref: "#/components/schemas/PortingOrderMisc"
        old_service_provider_ocn:
          description: Identifies the old service provider
          example: Unreal Communications
          readOnly: true
          type: string
        phone_number_configuration:
          $ref: "#/components/schemas/PortingOrderPhoneNumberConfiguration"
        porting_phone_numbers_count:
          description: Count of phone numbers associated with this porting order
          example: 1
          readOnly: true
          type: integer
        record_type:
          description: Identifies the type of the resource.
          example: porting_order
          readOnly: true
          type: string
        requirements:
          description: List of documentation requirements for porting numbers.
          items:
            $ref: "#/components/schemas/PortingOrderRequirement"
          type: array
        status:
          $ref: "#/components/schemas/PortingOrderStatus"
        support_key:
          description: A key to reference this porting order when contacting Telnyx customer support
          example: 123abc
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2021-03-19T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
        user_feedback:
          $ref: "#/components/schemas/PortingOrderUserFeedback"
        user_reference:
          description: A customer-specified reference number for customer bookkeeping purposes
          example: Acct 123abc
          type: string
        webhook_url:
          example: https://example.com/porting_webhooks
          format: uri
          type: string
      type: object
    PortingOrderActivationSettings:
      properties:
        activation_status:
          $ref: "#/components/schemas/ActivationStatus"
        fast_port_eligible:
          description: Indicates whether this porting order is eligible for FastPort
          example: true
          readOnly: true
          type: boolean
        foc_datetime_actual:
          description: ISO 8601 formatted Date/Time of the FOC date
          example: 2021-03-19T10:07:15.527Z
          format: date-time
          type: string
        foc_datetime_requested:
          description: ISO 8601 formatted Date/Time requested for the FOC date
          example: 2021-03-19T10:07:15.527Z
          format: date-time
          type: string
      type: object
    PortingOrderEndUserAdmin:
      properties:
        account_number:
          description: The authorized person's account number with the current service provider
          example: 123abc
          type: string
        auth_person_name:
          description: Name of person authorizing the porting order
          example: Porter McPortersen II
          type: string
        billing_phone_number:
          description: Billing phone number associated with these phone numbers
          example: 13035551234
          type: string
        business_identifier:
          description: European business identification number. Applicable only in the European Union
          example: abc123
          type: string
        entity_name:
          description: Person Name or Company name requesting the port
          example: Porter McPortersen
          type: string
        pin_passcode:
          description: PIN/passcode possibly required by the old service provider for extra verification
          example: 1234
          type: string
        tax_identifier:
          description: European tax identification number. Applicable only in the European Union
          example: 1234abcd
          type: string
      type: object
    PortingOrderEndUserLocation:
      properties:
        administrative_area:
          description: State, province, or similar of billing address
          example: IL
          type: string
        country_code:
          description: ISO3166-1 alpha-2 country code of billing address
          example: US
          type: string
        extended_address:
          description: Second line of billing address
          example: Suite 504
          type: string
        locality:
          description: City or municipality of billing address
          example: Chicago
          type: string
        postal_code:
          description: Postal Code of billing address
          example: 60654
          type: string
        street_address:
          description: First line of billing address
          example: 311 W. Superior St
          type: string
      type: object
    PortingOrderMisc:
      properties:
        new_billing_phone_number:
          description: New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account.
          type: string
        remaining_numbers_action:
          $ref: "#/components/schemas/RemainingNumbersAction"
        type:
          $ref: "#/components/schemas/PortingOrderType"
      type: object
    PortingOrderPhoneNumberConfiguration:
      properties:
        connection_id:
          description: identifies the connection to set on the numbers when ported
          example: f1486bae-f067-460c-ad43-73a92848f902
          type: string
        emergency_address_id:
          description: identifies the emergency address to set on the numbers when ported
          example: f1486bae-f067-460c-ad43-73a92848f902
          type: string
        messaging_profile_id:
          description: identifies the messaging profile to set on the numbers when ported
          example: f1486bae-f067-460c-ad43-73a92848f901
          type: string
        tags:
          example:
            - abc
            - "123"
          items:
            description: Tag to set on the numbers when ported
            type: string
          type: array
      type: object
    PortingOrderRequirement:
      properties:
        field_type:
          description: Type of value expected on field_value field
          enum:
            - document
          example: document
          type: string
        field_value:
          description: identifies the document that satisfies this requirement
          example: 9787fb5f-cbe5-4de4-b765-3303774ee9fe
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: porting_requirement
          type: string
        requirement_type_id:
          description: Identifies the requirement type that meets this requirement
          example: 59b0762a-b274-4f76-ac32-4d5cf0272e66
          type: string
      type: object
    PortingOrderStatus:
      description: Porting order status
      properties:
        details:
          description: A list of 0 or more details about this porting order's status
          items:
            $ref: "#/components/schemas/PortingOrdersExceptionType"
          type: array
        value:
          description: The current status of the porting order
          enum:
            - draft
            - in-process
            - submitted
            - exception
            - foc-date-confirmed
            - ported
            - canceled
            - cancel-pending
          example: ported
          type: string
      type: object
    PortingOrderType:
      description: A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.
      enum:
        - full
        - partial
      example: full
      type: string
    PortingOrderUserFeedback:
      properties:
        user_comment:
          description: A comment related to the customer rating.
          example: I loved my experience porting numbers with Telnyx
          type: string
        user_rating:
          description: Once an order is ported, cancellation is requested or the request is canceled, the user may rate their experience
          example: 5
          type: integer
      type: object
    PortingOrdersActivationJob:
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2021-03-19T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
        id:
          description: Uniquely identifies this activation job
          example: f1486bae-f067-460c-ad43-73a92848f902
          format: uuid
          readOnly: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: porting_activation_job
          readOnly: true
          type: string
        status:
          description: Specifies the status of this activation job
          enum:
            - created
            - in-process
            - completed
            - failed
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2021-03-19T10:07:15.527Z
          format: date-time
          readOnly: true
          type: string
      type: object
    PortingOrdersComment:
      properties:
        body:
          description: Body of comment
          example: Great experience so far
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          example: 2021-03-19T10:07:15.527Z
          format: date-time
          type: string
        id:
          example: f1486bae-f067-460c-ad43-73a92848f902
          format: uuid
          type: string
        porting_order_id:
          example: f1486bae-f067-460c-ad43-73a92848f902
          format: uuid
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: porting_comment
          type: string
        user_type:
          description: Indicates whether this comment was created by a Telnyx Admin, user, or system
          enum:
            - admin
            - user
            - system
          example: user
          type: string
      type: object
    PortingOrdersExceptionType:
      properties:
        code:
          description: Identifier of an exception type
          enum:
            - ACCOUNT_NUMBER_MISMATCH
            - AUTH_PERSON_MISMATCH
            - BTN_ATN_MISMATCH
            - ENTITY_NAME_MISMATCH
            - FOC_EXPIRED
            - FOC_REJECTED
            - LOCATION_MISMATCH
            - LSR_PENDING
            - MAIN_BTN_PORTING
            - OSP_IRRESPONSIVE
            - OTHER
            - PASSCODE_PIN_INVALID
            - PHONE_NUMBER_HAS_SPECIAL_FEATURE
            - PHONE_NUMBER_MISMATCH
            - PHONE_NUMBER_NOT_PORTABLE
            - PORT_TYPE_INCORRECT
            - PORTING_ORDER_SPLIT_REQUIRED
            - PORTING_ORDER_SPLIT_REQUIRED
            - POSTAL_CODE_MISMATCH
            - RATE_CENTER_NOT_PORTABLE
            - SV_CONFLICT
            - SV_UNKNOWN_FAILURE
          example: ENTITY_NAME_MISMATCH
          type: string
        description:
          description: Description of an exception type
          example: Entity name does not match that on the CSR
          type: string
      type: object
    PortoutComment:
      example:
        body: This is a comment
        created_at: 2018-02-02T22:25:27.521Z
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        portout_id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        record_type: portout
        user_id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
      properties:
        body:
          description: Comment body
          example: This is a comment
          type: string
        created_at:
          description: Comment creation timestamp in ISO 8601 format
          example: 2018-02-02T22:25:27.521Z
          type: string
        id:
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          type: string
        portout_id:
          default: null
          description: Identifies the associated port request
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: portout
          readOnly: true
          type: string
        user_id:
          description: Identifies the user who created the comment. Will be null if created by Telnyx Admin
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          type: string
      required:
        - id
        - body
        - user_id
        - created_at
    PortoutDetails:
      example:
        carrier_name: test
        created_at: 2018-02-02T22:25:27.521Z
        foc_date: 2018-02-02T22:25:27.521Z
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        phone_numbers:
          - "+35312345678"
        record_type: portout
        requested_foc_date: 2018-02-02T22:25:27.521Z
        spid: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        status: pending
        updated_at: 2018-02-02T22:25:27.521Z
      properties:
        carrier_name:
          description: Carrier the number will be ported out to
          example: test
          type: string
        created_at:
          description: ISO 8601 formatted date of when the portout was created
          example: 2018-02-02T22:25:27.521Z
          type: string
        foc_date:
          description: ISO 8601 formatted Date/Time of the FOC date
          example: 2018-02-02T22:25:27.521Z
          type: string
        id:
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          type: string
        phone_numbers:
          description: Phone numbers associated with this portout
          example:
            - "+35312345678"
          items:
            description: E164 formatted phone number
            type: string
          type: array
        record_type:
          description: Identifies the type of the resource.
          example: portout
          readOnly: true
          type: string
        requested_foc_date:
          description: ISO 8601 formatted Date/Time of the user requested FOC date
          example: 2018-02-02T22:25:27.521Z
          type: string
        spid:
          description: New service provider spid
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          type: string
        status:
          description: Status of portout request
          enum:
            - pending
            - authorized
            - ported
            - rejected
            - rejected-pending
            - canceled
          example: rejected
          type: string
        updated_at:
          description: ISO 8601 formatted date of when the portout was last updated
          example: 2018-02-02T22:25:27.521Z
          type: string
      type: object
    PrivateWirelessGateway:
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        ip_range:
          default: null
          description: IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.
          example: 100.64.1.0/24
          readOnly: true
          type: string
        name:
          description: The private wireless gateway name.
          example: My private wireless gateway
          type: string
        network_id:
          description: The identification of the related network resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        record_type:
          example: private_wireless_gateway
          readOnly: true
          type: string
        region_code:
          default: ashburn-va
          description: The geographical region where the Private Wireless Gateway is deployed to.
          example: ashburn-va
          type: string
        status:
          $ref: "#/components/schemas/PrivateWirelessGatewayStatus"
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      type: object
    PrivateWirelessGatewayRequest:
      example:
        name: My private wireless gateway
        network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
      properties:
        name:
          description: The private wireless gateway name.
          example: My private wireless gateway
          type: string
        network_id:
          description: The identification of the related network resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
      type: object
    PrivateWirelessGatewayStatus:
      description: The current status or failure details of the Private Wireless Gateway.
      properties:
        error_code:
          default: null
          description: This attribute is an <a href="https://developers.telnyx.com/docs/api/v2/overview#errors">error code</a> related to the failure reason.
          example: null
          readOnly: true
          type: string
        error_description:
          default: null
          description: This attribute provides a human-readable explanation of why a failure happened.
          example: null
          readOnly: true
          type: string
        value:
          default: provisioning
          description: |-
            The current status or failure details of the Private Wireless Gateway. <ul>
             <li><code>provisioning</code> - the Private Wireless Gateway is being provisioned.</li>
             <li><code>provisioned</code> - the Private Wireless Gateway was provisioned and able to receive connections.</li>
             <li><code>failed</code> - the provisioning had failed for a reason and it requires an intervention.</li>
             <li><code>decommissioning</code> - the Private Wireless Gateway is being removed from the network.</li>
             </ul>
             Transitioning between the provisioning and provisioned states may take some time.
          enum:
            - provisioning
            - provisioned
            - failed
            - decommissioning
          example: provisioned
          readOnly: true
          type: string
      type: object
    Product:
      description: Used product
      enum:
        - LONG_CODE
        - SHORT_CODE
        - SHORT_CODE_FTEU
        - TOLL_FREE
        - ALPHANUMERIC_ID
        - RCS
      example: LONG_CODE
      type: string
    Queue:
      example:
        average_wait_time_secs: 175
        created_at: 2019-01-23T18:10:02.574Z
        current_size: 20
        id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        max_size: 50
        name: support
        record_type: queue
        updated_at: 2019-01-23T18:10:02.574Z
      properties:
        average_wait_time_secs:
          description: The average time that the calls currently in the queue have spent waiting, given in seconds.
          example: 175
          type: integer
        created_at:
          description: ISO 8601 formatted date of when the queue was created
          example: 2019-01-23T18:10:02.574Z
          type: string
        current_size:
          description: The number of calls currently in the queue
          example: 20
          type: integer
        id:
          description: Uniquely identifies the queue
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: string
        max_size:
          description: The maximum number of calls allowed in the queue
          example: 50
          type: integer
        name:
          description: Name of the queue
          example: support
          type: string
        record_type:
          enum:
            - queue
          example: queue
          type: string
        updated_at:
          description: ISO 8601 formatted date of when the queue was last updated
          example: 2019-01-23T18:10:02.574Z
          type: string
      required:
        - record_type
        - id
        - name
        - current_size
        - max_size
        - average_wait_time_secs
        - created_at
        - updated_at
      title: Queue
      type: object
    QueueCall:
      example:
        call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
        call_leg_id: 2dc6fc34-f9e0-11ea-b68e-02420a0f7768
        call_session_id: 2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768
        connection_id: 7267xxxxxxxxxxxxxx
        enqueued_at: 2019-01-23T18:10:02.574Z
        from: "+18005550101"
        queue_id: ae1626cc-6f42-11ea-becd-02420a0f8b69
        queue_position: 3
        record_type: queue_call
        to: "+18005550102"
        wait_time_secs: 145
      properties:
        call_control_id:
          description: Unique identifier and token for controlling the call.
          example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
          type: string
        call_leg_id:
          description: ID that is unique to the call and can be used to correlate webhook events
          example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
          type: string
        call_session_id:
          description: ID that is unique to the call session and can be used to correlate webhook events
          example: 428c31b6-7af4-4bcb-b68e-5013ef9657c1
          type: string
        connection_id:
          description: Telnyx connection ID used in the call.
          example: 7267xxxxxxxxxxxxxx
          type: string
        enqueued_at:
          description: ISO 8601 formatted date of when the call was put in the queue
          example: 2019-01-23T18:10:02.574Z
          type: string
        from:
          description: Number or SIP URI placing the call.
          example: "+35319605860"
          type: string
        queue_id:
          description: Unique identifier of the queue the call is in.
          example: ae1626cc-6f42-11ea-becd-02420a0f8b69
          type: string
        queue_position:
          description: Current position of the call in the queue
          example: 3
          type: integer
        record_type:
          enum:
            - queue_call
          example: queue_call
          type: string
        to:
          description: Destination number or SIP URI of the call.
          example: "+13129457420"
          type: string
        wait_time_secs:
          description: The time the call has been waiting in the queue, given in seconds
          example: 272
          type: integer
      required:
        - call_control_id
        - call_leg_id
        - call_session_id
        - is_alive
        - record_type
        - connection_id
        - from
        - to
        - enqueued_at
        - wait_time_secs
        - queue_position
        - queue_id
      title: QueueCall
      type: object
    ReadComment:
      allOf:
        - $ref: "#/components/schemas/Comment"
        - properties:
            read_at:
              description: An ISO 8901 datetime string for when the comment was read.
              example: 2018-01-01T00:00:00.000000Z
              format: datetime
              readOnly: true
              type: string
          type: object
    Recording:
      example:
        call_leg_id: 11111111-5717-4562-b3fc-2c963f66afa6
        call_session_id: 22222222-5717-4562-b3fc-2c963f66afa6
        channels: single
        conference_id: 41b9acd4-f4da-4ff5-a85c-e07e90b53f46
        created_at: 2019-03-29T13:10:00Z
        download_urls:
          mp3: https://s3.amazonaws.com/some/path
        duration_millis: 50000
        id: dfadada7-af74-47bc-83a4-554275f55f5c
        record_type: recording
        recording_ended_at: 2019-03-29T12:10:00Z
        recording_started_at: 2019-03-29T11:10:00Z
        source: conference
        status: completed
        updated_at: 2019-03-29T14:10:00Z
      properties:
        call_leg_id:
          description: If a call recording, uniquely identifies the recorded call leg
          example: 11111111-5717-4562-b3fc-2c963f66afa6
          type: string
        call_session_id:
          description: If a call recording, uniquely identifies the recorded call session
          example: 22222222-5717-4562-b3fc-2c963f66afa6
          type: string
        channels:
          description: When `dual`, final audio file has the first leg on channel A, and the rest on channel B.
          enum:
            - single
            - dual
          example: single
          type: string
        conference_id:
          description: If a conference recording, uniquely identifies the recorded conference
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: string
        created_at:
          description: ISO 8601 formatted date of when the recording was created
          example: 2019-01-23T18:10:02.574Z
          type: string
        download_urls:
          description: The links to download the recording files
          properties:
            mp3:
              description: Link to download the recording in mp3 format
              type: string
            wav:
              description: Link to download the recording in wav format
              type: string
          type: object
        duration_millis:
          description: The duration of the recording in milliseconds
          example: 60000
          format: int32
          type: integer
        id:
          description: Uniquely identifies the recording
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
          type: string
        record_type:
          enum:
            - recording
          example: recording
          type: string
        recording_ended_at:
          description: ISO 8601 formatted date of when the recording ended
          example: 2019-01-23T18:10:02.574Z
          type: string
        recording_started_at:
          description: ISO 8601 formatted date of when the recording started
          example: 2019-01-23T18:10:02.574Z
          type: string
        source:
          description: The kind of event that led to this recording being created
          enum:
            - conference
            - call
          example: conference
          type: string
        status:
          description: The status of the recording. Only resources for `completed` recordings are currently supported
          enum:
            - completed
          example: completed
          type: string
        updated_at:
          description: ISO 8601 formatted date of when the recording was last updated
          example: 2019-01-23T18:10:02.574Z
          type: string
      required:
        - record_type
        - id
        - created_at
        - updated_at
        - recording_started_at
        - recording_ended_at
        - duration_millis
        - status
        - channels
        - source
        - download_urls
      title: Recording
      type: object
    ReferRequest:
      example:
        sip_address: sip:username@sip.non-telnyx-address.com
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        custom_headers:
          description: Custom headers to be added to the SIP INVITE.
          example:
            - name: head_1
              value: val_1
            - name: head_2
              value: val_2
          items:
            $ref: "#/components/schemas/CustomSipHeader"
          type: array
        sip_address:
          description: The SIP URI to which the call will be referred to.
          example: sip:username@sip.non-telnyx-address.com
          type: string
        sip_auth_password:
          description: SIP Authentication password used for SIP challenges.
          type: string
        sip_auth_username:
          description: SIP Authentication username used for SIP challenges.
          type: string
      required:
        - sip_address
      title: Refer request
      type: object
    RefreshRoomClientTokenRequest:
      properties:
        refresh_token:
          example: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ
          format: jwt
          type: string
        token_ttl_secs:
          default: 600
          description: The time to live in seconds of the Client Token, after that time the Client Token is invalid and can't be used to join a Room.
          example: 600
          maximum: 3600
          minimum: 10
          type: integer
      required:
        - refresh_token
      type: object
    RegionInformation:
      example:
        region_name: US
        region_type: country_code
      properties:
        region_name:
          example: US
          type: string
        region_type:
          enum:
            - country_code
            - rate_center
            - state
            - location
          example: country_code
          type: string
    RejectRequest:
      example:
        cause: USER_BUSY
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
      properties:
        cause:
          description: Cause for call rejection.
          enum:
            - CALL_REJECTED
            - USER_BUSY
          example: USER_BUSY
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      required:
        - cause
      title: Reject Request
      type: object
    RemainingNumbersAction:
      description: Remaining numbers can be either kept with their current service provider or disconnected. 'new_billing_telephone_number' is required when 'remaining_numbers_action' is 'keep'.
      enum:
        - keep
        - disconnect
      example: disconnect
      type: string
    ReplacedLinkClick:
      example:
        message_id: 7ee4241c-f127-47e5-9c34-3aac291f8058
        record_type: link_clicked
        time_clicked: 2019-04-01T14:45:45.450Z
        to: "18445550001"
        url: https://telnyx.com
      properties:
        message_id:
          description: The message ID associated with the clicked link.
          format: uuid
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: link_clicked
          type: string
        time_clicked:
          description: ISO 8601 formatted date indicating when the message request was received.
          format: date-time
          type: string
        to:
          description: Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).
          format: address
          type: string
        url:
          description: The original link that was sent in the message.
          example: link_clicked
          type: string
      type: object
    ReplacedLinkClickEvent:
      properties:
        data:
          $ref: "#/components/schemas/ReplacedLinkClick"
      type: object
    ReservedPhoneNumber:
      example:
        created_at: 2018-01-01T00:00:00.000000Z
        expired_at: 2018-01-01T00:00:00.000000Z
        id: 12ade33a-21c0-473b-b055-b3c836e1c292
        phone_number: "+19705555098"
        record_type: reserved_phone_number
        status: pending
        updated_at: 2018-01-01T00:00:00.000000Z
      properties:
        created_at:
          description: An ISO 8901 datetime string denoting when the individual number reservation was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        expired_at:
          description: An ISO 8901 datetime string for when the individual number reservation is going to expire
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        phone_number:
          example: "+19705555098"
          format: e164_phone_number
          type: string
        record_type:
          example: reserved_phone_number
          readOnly: true
          type: string
        status:
          description: The status of the phone number's reservation.
          enum:
            - pending
            - success
            - failure
          example: success
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the the individual number reservation was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
    ResumeRecordingRequest:
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      title: Pause Recording Request
      type: object
    RetrieveVerificationResponse:
      properties:
        data:
          $ref: "#/components/schemas/Verification"
      required:
        - data
      title: RetrieveVerificationResponse
      type: object
    Room:
      example:
        active_session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e74
        created_at: 2021-04-16T09:46:20.954863Z
        id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
        max_participants: 50
        record_type: room
        sessions:
          - active: true
            created_at: 2021-04-16T09:46:20.954863Z
            id: 7b61621f-62e0-4aad-ab11-9fd19e272e74
            participants: []
            record_type: room_session
            room_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
            updated_at: 2021-04-16T10:24:55.962200Z
        unique_name: My Room
        updated_at: 2021-04-16T10:24:55.962200Z
      properties:
        active_session_id:
          description: The identifier of the active room session if any.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        created_at:
          description: ISO 8601 timestamp when the room was created.
          example: 2021-03-26T17:51:59.588408Z
          format: datetime
          type: string
        id:
          description: Identifies the room.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        max_participants:
          description: Maximum participants allowed in the room.
          example: 50
          type: integer
        record_type:
          example: room
          readOnly: true
          type: string
        sessions:
          items:
            $ref: "#/components/schemas/RoomSession"
          type: array
        unique_name:
          description: The unique (within the Telnyx account scope) name of the room.
          example: My room
          type: string
        updated_at:
          description: ISO 8601 timestamp when the room was updated.
          example: 2021-03-26T17:51:59.588408Z
          format: datetime
          type: string
      type: object
    RoomParticipant:
      example:
        context: Alice
        id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
        joined_at: 2021-04-16T09:46:20.954863Z
        left_at: 2021-04-16T10:24:55.962200Z
        record_type: room_participant
        session_id: 7b61621f-5fe4-4aad-ab11-9fd19e272e73
        updated_at: 2021-04-16T10:24:55.962200Z
      properties:
        context:
          description: Context provided to the given participant through the client SDK
          example: Alice
          type: string
        id:
          description: Identifies the room participant.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        joined_at:
          description: ISO 8601 timestamp when the participant joined the session.
          example: 2021-03-26T17:51:59.588408Z
          format: datetime
          type: string
        left_at:
          description: ISO 8601 timestamp when the participant left the session.
          example: 2021-03-26T17:51:59.588408Z
          format: datetime
          type: string
        record_type:
          example: room_participant
          readOnly: true
          type: string
        session_id:
          description: Identify the room session that participant is part of.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0
          format: uuid
          type: string
        updated_at:
          description: ISO 8601 timestamp when the participant was updated.
          example: 2021-03-26T17:51:59.588408Z
          format: datetime
          type: string
      type: object
    RoomSession:
      example:
        active: false
        created_at: 2021-04-16T09:46:20.954863Z
        ended_at: 2021-04-16T10:24:55.962200Z
        id: 7b61621f-62e0-4aad-ab11-9fd19e272e73
        participants: []
        record_type: room_session
        room_id: 7b61621f-5fe4-4aad-ab11-9fd19e272e73
        updated_at: 2021-04-16T10:24:55.962200Z
      properties:
        active:
          description: Shows if the room session is active or not.
          example: false
          type: boolean
        created_at:
          description: ISO 8601 timestamp when the room session was created.
          example: 2021-03-26T17:51:59.588408Z
          format: datetime
          type: string
        ended_at:
          description: ISO 8601 timestamp when the room session has ended.
          example: 2021-03-26T17:51:59.588408Z
          format: datetime
          type: string
        id:
          description: Identifies the room session.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        participants:
          items:
            $ref: "#/components/schemas/RoomParticipant"
          type: array
        record_type:
          example: room_session
          readOnly: true
          type: string
        room_id:
          description: Identify the room hosting that room session.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0
          format: uuid
          type: string
        updated_at:
          description: ISO 8601 timestamp when the room session was updated.
          example: 2021-03-26T17:51:59.588408Z
          format: datetime
          type: string
      type: object
    SIMCard:
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        iccid:
          description: |
            The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.
          example: "89310410106543789301"
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        imsi:
          description: |
            SIM cards are identified on their individual operator networks by a unique International Mobile Subscriber Identity (IMSI). <br/>
            Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber  Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home  Location Register (HLR) or the Visitor Location Register (VLR).
          example: 81932214823362980
          readOnly: true
          type: string
        ipv4:
          description: |
            The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.
          example: 192.168.0.0
          readOnly: true
          type: string
        ipv6:
          description: |
            The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.
          example: 2001:cdba:0000:0000:0000:0000:3257:9652
          readOnly: true
          type: string
        msisdn:
          description: |
            Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally. <br/>
            MSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.
          example: "+13109976224"
          readOnly: true
          type: string
        record_type:
          example: sim_card
          readOnly: true
          type: string
        sim_card_group_id:
          description: The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        status:
          description: |
            The current status of the SIM card. It will be one of the following: <br/>
            <ul>
             <li><code>registering</code> - the card is being registered</li>
             <li><code>enabling</code> - the card is being enabled</li>
             <li><code>enabled</code> - the card is enabled and ready for use</li>
             <li><code>disabling</code> - the card is being disabled</li>
             <li><code>disabled</code> - the card has been disabled and cannot be used</li>
             <li><code>data_limit_exceeded</code> - the card has exceeded its data consumption limit</li>
            </ul>
            Transitioning between the enabled and disabled states may take a period of time.
          enum:
            - registering
            - enabling
            - enabled
            - disabling
            - disabled
            - data_limit_exceeded
          example: enabled
          readOnly: true
          type: string
        tags:
          description: Searchable tags associated with the SIM card
          example:
            - personal
            - customers
            - active-customers
          items:
            type: string
          type: array
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: SIMCard
      type: object
    SIMCardGroup:
      properties:
        consumed_data:
          $ref: "#/components/schemas/ConsumedData"
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        data_limit:
          description: Upper limit on the amount of data the SIM cards, within the group, can use.
          example: 2048
          type: integer
        default:
          description: Indicates whether the SIM card group is the users default group.<br/>The default group is created for the user and can not be removed.
          example: true
          readOnly: true
          type: boolean
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        name:
          description: A user friendly name for the SIM card group.
          example: My Test Group
          type: string
        private_wireless_gateway_id:
          default: null
          description: The identification of the related Private Wireless Gateway resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: sim_card_group
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: SIMCardGroup
      type: object
    SIMCardGroupAction:
      description: This object represents a SIM card group action request. It allows tracking the current status of an operation that impacts the SIM card group and SIM card in it.
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        record_type:
          example: sim_card_group_action
          readOnly: true
          type: string
        settings:
          description: A JSON object representation of the action params.
          properties:
            private_wireless_gateway_id:
              description: The identification of the related Private Wireless Gateway resource.
              example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
              format: uuid
              type: string
          type: object
        sim_card_group_id:
          description: The SIM card group identification.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        status:
          enum:
            - in-progress
            - completed
            - failed
          example: in-progress
          type: string
        type:
          description: Represents the type of the operation requested.
          enum:
            - set_private_wireless_gateway
            - remove_private_wireless_gateway
          example: set_private_wireless_gateway
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: SIMCardGroupAction
      type: object
    SIMCardGroupCreate:
      properties:
        data_limit:
          description: Upper limit on the amount of data the SIM cards, within the group, can use.
          example: 2048
          type: integer
        name:
          description: A user friendly name for the SIM card group.
          example: My Test Group
          type: string
      required:
        - name
      title: SIMCardGroupCreate
      type: object
    SIMCardGroupPatch:
      properties:
        data_limit:
          description: Upper limit on the amount of data the SIM cards, within the group, can use.
          example: 2048
          type: integer
        name:
          description: A user friendly name for the SIM card group.
          example: My Test Group
          type: string
      title: SIMCardGroupPatch
      type: object
    SIMCardNetworkPreference:
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        mobile_operator_networks_preferences:
          $ref: "#/components/schemas/MobileOperatorNetworksPreferencesResponse"
        record_type:
          example: sim_card_network_preferences
          readOnly: true
          type: string
        sim_card_id:
          example: 6b14e151-8493-4fa1-8664-1cc4e6d14158
          format: uuid
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: SIMCardNetworkPreference
      type: object
    SIMCardNetworkPreferenceWithOTAUpdates:
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        mobile_operator_networks_preferences:
          $ref: "#/components/schemas/MobileOperatorNetworksPreferencesResponse"
        ota_updates:
          items:
            $ref: "#/components/schemas/CompleteOTAUpdate"
          type: array
        record_type:
          example: sim_card_network_preferences
          readOnly: true
          type: string
        sim_card_id:
          example: 6b14e151-8493-4fa1-8664-1cc4e6d14158
          format: uuid
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: SIMCardNetworkPreferenceWithOTAUpdates
      type: object
    SIMCardOrder:
      properties:
        cost:
          description: An object representing the total cost of the order.
          example:
            amount: "2.52"
            currency: USD
          properties:
            amount:
              description: A string representing the cost amount.
              example: "2.32"
              type: string
            currency:
              description: Filter by ISO 4217 currency string.
              example: USD
              format: currency
              type: string
          type: object
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was last created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        order_address:
          description: An object representing the address information from when the order was submitted.
          example:
            administrative_area: IL
            country_code: US
            extended_address: Suite 504
            id: "1293384261075731499"
            locality: Chicago
            postal_code: "60654"
            street_address: 311 W Superior St
          properties:
            administrative_area:
              description: State or province where the address is located.
              example: IL
              type: string
            country_code:
              description: The mobile operator two-character (ISO 3166-1 alpha-2) origin country code.
              example: US
              type: string
            extended_address:
              description: Supplemental field for address information.
              example: Suite 504
              type: string
            id:
              description: Uniquely identifies the address for the order.
              example: "1293384261075731499"
              format: int64
              type: string
            locality:
              description: The name of the city where the address is located.
              example: Chicago
              type: string
            postal_code:
              description: Postal code for the address.
              example: "60654"
              type: string
            street_address:
              description: The name of the street where the address is located.
              example: 311 W Superior St
              type: string
          readOnly: true
          type: object
        quantity:
          description: The amount of SIM cards requested in the SIM card order.
          example: 21
          minimum: 1
          type: integer
        record_type:
          description: Identifies the type of the resource.
          example: sim_card_order
          readOnly: true
          type: string
        status:
          description: The current status of the SIM Card order.<ul> <li><code>pending</code> - the order is waiting to be processed.</li> <li><code>processing</code> - the order is currently being processed.</li> <li><code>ready_to_ship</code> - the order is ready to be shipped to the specified <b>address</b>.</li> <li><code>shipped</code> - the order was shipped and is on its way to be delivered to the specified <b>address</b>.</li> <li><code>delivered</code> - the order was delivered to the specified <b>address</b>.</li> </ul>
          enum:
            - pending
            - processing
            - ready_to_ship
            - shipped
            - delivered
          example: pending
          type: string
        tracking_url:
          description: The URL used to get tracking information about the order.
          example: http://www.example.com/
          format: url
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was last updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: SIMCardOrder
      type: object
    SIMCardOrderPreview:
      properties:
        quantity:
          description: The amount of SIM cards requested in the SIM card order.
          example: 21
          type: integer
        record_type:
          description: Identifies the type of the resource.
          example: sim_card_order_preview
          readOnly: true
          type: string
        shipping_cost:
          properties:
            amount:
              description: A string representing the cost amount.
              example: "2.32"
              type: string
            currency:
              description: ISO 4217 currency string.
              example: USD
              format: currency
              type: string
          type: object
        sim_cards_cost:
          properties:
            amount:
              description: A string representing the cost amount.
              example: "2.32"
              type: string
            currency:
              description: ISO 4217 currency string.
              example: USD
              format: currency
              type: string
          type: object
        total_cost:
          properties:
            amount:
              description: A string representing the cost amount.
              example: "2.32"
              type: string
            currency:
              description: ISO 4217 currency string.
              example: USD
              format: currency
              type: string
          type: object
      title: SIMCardOrderPreview
      type: object
    SIMCardPublicIP:
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        ip:
          default: null
          description: The provisioned IP address. This attribute will only be available when underlying resource status is in a "provisioned" status.
          example: 192.168.0.0
          readOnly: true
          type: string
        record_type:
          example: sim_card_public_ip
          readOnly: true
          type: string
        sim_card_id:
          example: 6b14e151-8493-4fa1-8664-1cc4e6d14158
          format: uuid
          type: string
        status:
          $ref: "#/components/schemas/SIMCardPublicIPStatus"
        type:
          default: ipv4
          enum:
            - ipv4
          example: ipv4
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: SIMCardPublicIP
      type: object
    SIMCardPublicIPStatus:
      description: The current status or failure details of the SIM card's public IP.
      properties:
        error_code:
          default: null
          description: This attribute is an <a href="https://developers.telnyx.com/docs/api/v2/overview#errors">error code</a> related to the failure reason.
          example: null
          readOnly: true
          type: string
        error_description:
          default: null
          description: This attribute provides a human-readable explanation of why a failure happened.
          example: null
          readOnly: true
          type: string
        value:
          default: provisioning
          description: |-
            The current status or failure details of the SIM card's public IP. <ul>
             <li><code>provisioning</code> - the IP is being provisioned.</li>
             <li><code>provisioned</code> - the IP was provisioned and the SIM is reachable on the public internet.</li>
             <li><code>failed</code> - the provisioning had failed for a reason and it requires an intervention.</li>
             <li><code>decommissioning</code> - the public IP is being removed from the SIM card.</li>
             </ul>
             Transitioning between the provisioning and provisioned states may take some time.
          enum:
            - provisioning
            - provisioned
            - failed
            - decommissioning
          example: provisioned
          readOnly: true
          type: string
      type: object
    SIMCardRegistration:
      properties:
        registration_codes:
          example:
            - "0000000001"
            - "0000000002"
            - "0000000003"
          items:
            type: string
          type: array
        sim_card_group_id:
          description: The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        status:
          default: enabled
          description: Status on which the SIM card will be set after being successful registered.
          enum:
            - enabled
            - disabled
            - standby
          example: standby
          type: string
        tags:
          description: Searchable tags associated with the SIM card
          example:
            - personal
            - customers
            - active-customers
          items:
            type: string
          type: array
      required:
        - registration_codes
      title: SIMCardRegistration
      type: object
    SIMCardRegistrationCodeValidation:
      properties:
        invalid_detail:
          description: The validation message
          example: This code has already been used.
          nullable: true
          type: string
        record_type:
          example: sim_card_registration_code_validation
          type: string
        registration_code:
          description: The 10-digit SIM card registration code
          example: 123456789
          type: string
        valid:
          description: The attribute that denotes whether the code is valid or not
          example: false
          type: boolean
      type: object
    SIMCardRegistrationCodeValidations:
      properties:
        data:
          items:
            $ref: "#/components/schemas/SIMCardRegistrationCodeValidation"
          type: array
      type: object
    SendDTMFRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        digits: 1www2WABCDw9
        duration_millis: 500
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        digits:
          description: "DTMF digits to send. Valid digits are 0-9, A-D, *, and #. Pauses can be added using w (0.5s) and W (1s)."
          example: 1www2WABCDw9
          type: string
        duration_millis:
          default: 250
          description: Specifies for how many milliseconds each digit will be played in the audio stream. Ranges from 100 to 500ms
          example: 500
          format: int32
          type: integer
      required:
        - digits
      title: Send DTMF Request
      type: object
    SendFaxMultipartRequest:
      properties:
        connection_id:
          description: The connection ID to send the fax with.
          example: "234423"
          type: string
        contents:
          description: The file you want to upload. The maximum allowed size is 20 MB.
          format: binary
          type: string
        from:
          description: The phone number, in E.164 format, the fax will be sent from.
          example: "+13125790015"
          type: string
        quality:
          default: high
          description: The quality of the fax. Can be normal, high, very_high.
          example: high
          type: string
        store_media:
          default: false
          description: Should fax media be stored on temporary URL.
          type: boolean
        to:
          description: The phone number, in E.164 format, the fax will be sent to or SIP URI.
          example: "+13127367276"
          type: string
      required:
        - connection_id
        - contents
        - from
        - to
      title: Send fax multipart request
      type: object
    SendFaxRequest:
      properties:
        connection_id:
          description: The connection ID to send the fax with.
          example: "234423"
          type: string
        from:
          description: The phone number, in E.164 format, the fax will be sent from.
          example: "+13125790015"
          type: string
        media_name:
          description: The media_name of a file to be used for the fax's media. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. media_url and media_name can't be submitted together.
          example: my_media_uploaded_to_media_storage_api
          type: string
        media_url:
          description: The URL to the PDF used for the fax's media. media_url and media_name can't be submitted together.
          example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
          type: string
        quality:
          default: high
          description: The quality of the fax. Can be normal, high, very_high.
          example: high
          type: string
        store_media:
          default: false
          description: Should fax media be stored on temporary URL. It does not support media_name, they can't be submitted together.
          type: boolean
        to:
          description: The phone number, in E.164 format, the fax will be sent to or SIP URI.
          example: "+13127367276"
          type: string
      required:
        - connection_id
        - from
        - to
      title: Send fax request
      type: object
    ServicePlan:
      default: global
      description: Indicates the coverage of the termination regions. International and Global are the same but International may only be used for high volume/short duration Outbound Voice Profiles.
      enum:
        - us
        - international
        - global
      example: global
      type: string
    ShortCode:
      example:
        country_code: US
        created_at: 2019-01-23T18:10:02.574Z
        id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        messaging_profile_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        record_type: short_code
        short_code: "12345"
        updated_at: 2019-01-23T18:10:02.574Z
      properties:
        country_code:
          description: ISO 3166-1 alpha-2 country code.
          example: US
          pattern: ^[A-Z]{2}$
          readOnly: true
          type: string
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          readOnly: true
          type: string
        id:
          description: Identifies the type of resource.
          format: uuid
          readOnly: true
          type: string
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          nullable: true
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - short_code
          example: short_code
          readOnly: true
          type: string
        short_code:
          description: Short digit sequence used to address messages.
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          format: date-time
          readOnly: true
          type: string
      required:
        - messaging_profile_id
      type: object
    SimCardOrderCreate:
      properties:
        address_id:
          description: Uniquely identifies the address for the order.
          example: "1293384261075731499"
          format: int64
          type: string
        quantity:
          description: The amount of SIM cards to order.
          example: 23
          minimum: 1
          type: integer
      required:
        - address_id
        - quantity
      title: SimCardOrderCreate
      type: object
    SimpleSIMCard:
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        iccid:
          description: |
            The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.
          example: "89310410106543789301"
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        imsi:
          description: |
            SIM cards are identified on their individual operator networks by a unique International Mobile Subscriber Identity (IMSI). <br/>
            Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber  Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home  Location Register (HLR) or the Visitor Location Register (VLR).
          example: 81932214823362980
          readOnly: true
          type: string
        msisdn:
          description: |
            Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally. <br/>
            MSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.
          example: "+13109976224"
          readOnly: true
          type: string
        record_type:
          example: sim_card
          readOnly: true
          type: string
        sim_card_group_id:
          description: The group SIMCardGroup identification. This attribute can be <code>null</code> when it's present in an associated resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        status:
          description: |
            The current status of the SIM card. It will be one of the following: <br/>
            <ul>
             <li><code>registering</code> - the card is being registered</li>
             <li><code>enabling</code> - the card is being enabled</li>
             <li><code>enabled</code> - the card is enabled and ready for use</li>
             <li><code>disabling</code> - the card is being disabled</li>
             <li><code>disabled</code> - the card has been disabled and cannot be used</li>
             <li><code>data_limit_exceeded</code> - the card has exceeded its data consumption limit</li>
            </ul>
            Transitioning between the enabled and disabled states may take a period of time.
          enum:
            - registering
            - enabling
            - enabled
            - disabling
            - disabled
            - data_limit_exceeded
          example: enabled
          readOnly: true
          type: string
        tags:
          description: Searchable tags associated with the SIM card
          example:
            - personal
            - customers
            - active-customers
          items:
            type: string
          type: array
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: SIMCard
      type: object
    SimplifiedOTAUpdate:
      description: This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card. <br/><br/>
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        record_type:
          example: ota_update
          readOnly: true
          type: string
        sim_card_id:
          description: The identification UUID of the related SIM card resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        status:
          enum:
            - in-progress
            - completed
            - failed
          example: in-progress
          type: string
        type:
          description: Represents the type of the operation requested. This will relate directly to the source of the request.
          enum:
            - sim_card_network_preferences
          example: sim_card_network_preferences
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: OTAUpdate
      type: object
    SpeakRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        language: arb
        payload: Say this on the call
        payload_type: text
        service_level: basic
        stop: current
        voice: female
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        language:
          description: The language you want spoken.
          enum:
            - arb
            - cmn-CN
            - cy-GB
            - da-DK
            - de-DE
            - en-AU
            - en-GB
            - en-GB-WLS
            - en-IN
            - en-US
            - es-ES
            - es-MX
            - es-US
            - fr-CA
            - fr-FR
            - hi-IN
            - is-IS
            - it-IT
            - ja-JP
            - ko-KR
            - nb-NO
            - nl-NL
            - pl-PL
            - pt-BR
            - pt-PT
            - ro-RO
            - ru-RU
            - sv-SE
            - tr-TR
          example: en-US
          type: string
        payload:
          description: The text or SSML to be converted into speech. There is a 5,000 character limit.
          example: Say this on the call
          type: string
        payload_type:
          default: text
          description: The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).
          enum:
            - text
            - ssml
          example: ssml
          type: string
        service_level:
          default: premium
          description: This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed.
          enum:
            - basic
            - premium
          example: premium
          type: string
        stop:
          default: null
          description: When specified, it stops the current audio being played.  Specify `current` to stop the current audio being played, and to play the next file in the queue. Specify `all` to stop the current audio file being played and to also clear all audio files from the queue.
          example: current
          type: string
        voice:
          description: The gender of the voice used to speak back the text.
          enum:
            - male
            - female
          example: female
          type: string
      required:
        - payload
        - voice
        - language
      title: Speak Request
      type: object
    StartForkingRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        rx: 192.0.2.1:9000
        target: udp:192.0.2.1:9000
        tx: 192.0.2.1:9001
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        rx:
          description: The network target, <udp:ip_address:port>, where the call's incoming RTP media packets should be forwarded.
          example: 192.0.2.1:9000
          type: string
        stream_type:
          default: raw
          description: Optionally specify a media type to stream. If `decrpyted` selected, Telnyx will decrypt incoming SIP media before forking to the target. `rx` and `tx` are required fields if `decrypted` selected.
          enum:
            - raw
            - decrypted
          example: decrypted
          type: string
        target:
          description: The network target, <udp:ip_address:port>, where the call's RTP media packets should be forwarded. Both incoming and outgoing media packets will be delivered to the specified target, and information about the stream will be included in the encapsulation protocol header, including the direction (0 = inbound; 1 = outbound), leg (0 = A-leg; 1 = B-leg), and call_leg_id.
          example: udp:192.0.2.1:9000
          type: string
        tx:
          description: The network target, <udp:ip_address:port>, where the call's outgoing RTP media packets should be forwarded.
          example: 192.0.2.1:9001
          type: string
      title: Start Forking Request
      type: object
    StartRecordingRequest:
      example:
        channels: single
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        format: wav
        max_length: 0
        play_beep: true
      properties:
        channels:
          description: When `dual`, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.
          enum:
            - single
            - dual
          example: single
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        format:
          description: The audio file format used when storing the call recording. Can be either `mp3` or `wav`.
          enum:
            - wav
            - mp3
          example: mp3
          type: string
        max_length:
          default: 0
          description: Defines the maximum length for the recording in seconds. Minimum value is 0. Maximum value is 14400. Default is 0 (infinite)
          example: 100
          format: int32
          type: integer
        play_beep:
          description: If enabled, a beep sound will be played at the start of a recording.
          example: true
          type: boolean
      required:
        - format
        - channels
      title: Start Recording Request
      type: object
    StopForkingRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      title: Stop Forking Request
      type: object
    StopGatherRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      title: Stop Gather Request
      type: object
    StopRecordingRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      title: Stop Recording Request
      type: object
    SubNumberOrder:
      properties:
        country_code:
          example: US
          readOnly: true
          type: string
        created_at:
          description: An ISO 8901 datetime string denoting when the number order was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        order_request_id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c293
          format: uuid
          readOnly: true
          type: string
        phone_number_type:
          enum:
            - local
            - toll-free
            - mobile
            - national
            - shared-cost
          example: local
          type: string
        phone_numbers_count:
          description: The count of phone numbers in the number order.
          example: 1
          readOnly: true
          type: integer
        record_type:
          example: sub_number_order
          readOnly: true
          type: string
        regulatory_requirements:
          items:
            $ref: "#/components/schemas/SubNumberOrderRegulatoryRequirement"
          type: array
        requirements_met:
          description: True if all requirements are met for every phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        updated_at:
          description: An ISO 8901 datetime string for when the number order was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        user_id:
          example: d70873cd-7c98-401a-81b6-b1ae08246995
          format: uuid
          type: string
    SubNumberOrderRegulatoryRequirement:
      properties:
        field_type:
          enum:
            - textual
            - datetime
            - address
            - document
          example: address
          readOnly: true
          type: string
        record_type:
          example: phone_number_regulatory_requirement
          readOnly: true
          type: string
        requirement_id:
          description: Unique id for a requirement.
          example: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
          format: uuid
          type: string
    TelephonyCredential:
      example:
        created_at: 2020-06-18T21:32:38
        expired: "false"
        expires_at: 2042-06-18T21:32:38
        id: c215ade3-0d39-418e-94be-c5f780760199
        name: 2020-06-18 21:32:38.917732Z
        record_type: credential
        resource_id: connection:804252963366242252
        sip_password: a92dbcfb60184a8cb330b0acb2f7617b
        sip_username: gencrednCvHU5IYpSBPPsXI2iQsDX
        updated_at: 2020-06-18T21:32:38.000Z
        user_id: user-id
      properties:
        created_at:
          description: ISO-8601 formatted date indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          type: string
        expired:
          description: Defaults to false
          type: boolean
        expires_at:
          description: ISO-8601 formatted date indicating when the resource will expire.
          example: 2018-02-02T22:25:27.521Z
          type: string
        id:
          description: Identifies the resource.
          example: c215ade3-0d39-418e-94be-c5f780760199
          format: string
          type: string
        name:
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: credential
          type: string
        resource_id:
          description: Identifies the resource this credential is associated with.
          example: connection:1234567890
          type: string
        sip_password:
          description: The randomly generated SIP password for the credential.
          example: a92dbcfb60184a8cb330b0acb2f7617b
          type: string
        sip_username:
          description: The randomly generated SIP username for the credential.
          example: gencrednCvHU5IYpSBPPsXI2iQsDX
          type: string
        updated_at:
          description: ISO-8601 formatted date indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          type: string
      title: On-demand Credential
      type: object
    TelephonyCredentialCreateRequest:
      example:
        connection_id: "1234567890"
        name: My-new-credential
      properties:
        connection_id:
          description: Identifies the Credential Connection this credential is associated with.
          example: "1234567890"
          type: string
        expires_at:
          description: ISO-8601 formatted date indicating when the credential will expire.
          example: 2018-02-02T22:25:27.521Z
          type: string
        name:
          type: string
        tag:
          description: Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials.
          example: some_tag
          type: string
      required:
        - connection_id
      title: TelephonyCredentialCreateRequest
      type: object
    TelephonyCredentialUpdateRequest:
      example:
        connection_id: "987654321"
        name: My-new-updated-credential
      properties:
        connection_id:
          description: Identifies the Credential Connection this credential is associated with.
          example: "987654321"
          type: string
        expires_at:
          description: ISO-8601 formatted date indicating when the credential will expire.
          example: 2018-02-02T22:25:27.521Z
          type: string
        name:
          type: string
        tag:
          description: Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials.
          example: some_tag
          type: string
      title: TelephonyCredentialUpdateRequest
      type: object
    Template:
      properties:
        components:
          $ref: "#/components/schemas/TemplateComponents"
        language:
          $ref: "#/components/schemas/Language"
        name:
          description: Name of the template.
          type: string
        namespace:
          description: Namespace of the template. This must be the namespace associated with the WhatsApp business account that owns the phone number associated with the current WhatsApp Business API client or the message fails to send.
          type: string
      required:
        - namespace
        - name
        - language
      title: Template
      type: object
    TemplateComponents:
      items:
        description: ""
        properties:
          parameters:
            $ref: "#/components/schemas/TemplateParameters"
          type:
            description: Describes the component type.
            enum:
              - header
              - body
              - footer
            type: string
        required:
          - type
        title: Template Components
        type: object
      title: Template Components
      type: array
    TemplateParameters:
      items:
        description: Array containing the content of the message.
        properties:
          currency:
            $ref: "#/components/schemas/Currency"
          date_time:
            $ref: "#/components/schemas/DateTimeObject"
          document:
            $ref: "#/components/schemas/Document"
          image:
            $ref: "#/components/schemas/Image"
          text:
            type: string
          type:
            description: Describes the parameter type.
            enum:
              - text
              - currency
              - date_time
              - image
              - document
              - video
            type: string
          video:
            $ref: "#/components/schemas/Video"
        required:
          - type
        title: Template Parameters
        type: object
      title: Template Component Parameters
      type: array
    TexmlApplication:
      example:
        active: false
        anchorsite_override: Amsterdam, Netherlands
        created_at: 2020-02-02T22:25:27.521Z
        dtmf_type: Inband
        first_command_timeout: true
        first_command_timeout_secs: 10
        friendly_name: call-router
        id: "1293384261075731499"
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        record_type: texml_application
        status_callback: https://example.com
        status_callback_method: get
        updated_at: 2020-02-03T22:25:27.521Z
        voice_fallback_url: https://fallback.example.com
        voice_method: get
        voice_url: https://example.com
      properties:
        active:
          $ref: "#/components/schemas/ConnectionActive"
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        first_command_timeout:
          $ref: "#/components/schemas/FirstCommandTimeout"
        first_command_timeout_secs:
          $ref: "#/components/schemas/FirstCommandTimeoutSecs"
        friendly_name:
          $ref: "#/components/schemas/ApplicationName"
        id:
          $ref: "#/components/schemas/IntId"
        inbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            sip_subdomain:
              default: null
              description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
              example: example
              type: string
            sip_subdomain_receive_settings:
              default: from_anyone
              description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
              enum:
                - only_my_connections
                - from_anyone
              example: only_my_connections
              type: string
          type: object
        outbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            outbound_voice_profile_id:
              $ref: "#/components/schemas/OutboundVoiceProfileId"
          type: object
        record_type:
          description: Identifies the type of the resource.
          example: texml_application
          type: string
        status_callback:
          default: null
          description: URL for Telnyx to send requests to containing information about call progress events.
          example: https://example.com
          format: url
          type: string
        status_callback_method:
          default: post
          description: HTTP request method Telnyx should use when requesting the status_callback URL.
          enum:
            - get
            - post
          example: get
          type: string
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        voice_fallback_url:
          default: null
          description: URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.
          example: https://fallback.example.com
          format: url
          type: string
        voice_method:
          default: post
          description: HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.
          enum:
            - get
            - post
          example: get
          type: string
        voice_url:
          description: URL to which Telnyx will deliver your XML Translator webhooks.
          example: https://example.com
          format: url
          type: string
      title: Texml Application
      type: object
    Text:
      example:
        body: <Message Text>
      properties:
        body:
          type: string
      required:
        - body
      title: Text
      type: object
    ToNumber:
      description: Receiving address (+E.164 formatted phone number or short code).
      example: +E.164
      format: address
      type: string
    TrafficType:
      default: conversational
      description: Specifies the type of traffic allowed in this profile.
      enum:
        - conversational
        - short_duration
      example: conversational
      type: string
    Transcription:
      example:
        event_type: call.transcription
        id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
        occurred_at: 2018-02-02T22:25:27.521992Z
        payload:
          call_control_id: v2:7subYr8fLrXmaAXm8egeAMpoSJ72J3SGPUuome81-hQuaKRf9b7hKA
          call_leg_id: 5ca81340-5beb-11eb-ae45-02420a0f8b69
          call_session_id: 5ca81eee-5beb-11eb-ba6c-02420a0f8b69
          client_state: null
          connection_id: "1240401930086254526"
          transcription_data:
            confidence: 0.977219
            transcript: hello this is a test speech
        record_type: event
      properties:
        event_type:
          description: The type of event being delivered.
          enum:
            - call.transcription
          example: call.transcription
          type: string
        id:
          description: Identifies the type of resource.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        occurred_at:
          description: ISO 8601 datetime of when the event occurred.
          example: 2018-02-02T22:25:27.521992Z
          format: date-time
          type: string
        payload:
          properties:
            call_control_id:
              description: Unique identifier and token for controlling the call.
              example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
              type: string
            call_leg_id:
              description: ID that is unique to the call and can be used to correlate webhook events.
              example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1
              type: string
            call_session_id:
              description: ID that is unique to the call session and can be used to correlate webhook events.
              example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1
              type: string
            client_state:
              description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
              example: aGF2ZSBhIG5pY2UgZGF5ID1d
              type: string
            connection_id:
              description: Telnyx connection ID used in the call.
              example: 7267xxxxxxxxxxxxxx
              type: string
            transcription_data:
              properties:
                confidence:
                  description: Speech recognition confidence level.
                  example: 0.977219
                  format: double
                  type: number
                transcript:
                  description: Recognized text.
                  example: hello this is a test speech
                  type: string
              type: object
          type: object
        record_type:
          description: Identifies the type of the resource.
          enum:
            - event
          example: event
          type: string
      title: Transcription
      type: object
    TranscriptionEvent:
      properties:
        data:
          $ref: "#/components/schemas/Transcription"
      title: Transcription Event
      type: object
    TranscriptionStartRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        language: en
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        language:
          default: en
          description: Language to use for speech recognition
          enum:
            - de
            - en
            - es
            - fr
            - it
            - pl
          example: en
          type: string
      title: Transcription start request
      type: object
    TranscriptionStopRequest:
      example:
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
      properties:
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
      title: Transcription stop request
      type: object
    TransferCallRequest:
      example:
        answering_machine_detection: detect
        answering_machine_detection_config:
          after_greeting_silence_millis: 1000
          between_words_silence_millis: 1000
          greeting_duration_millis: 1000
          greeting_silence_duration_millis: 2000
          greeting_total_analysis_time_millis: 50000
          initial_silence_millis: 1000
          maximum_number_of_words: 1000
          maximum_word_length_millis: 2000
          silence_threshold: 512
          total_analysis_time_millis: 5000
        audio_url: http://www.example.com/sounds/greeting.wav
        client_state: aGF2ZSBhIG5pY2UgZGF5ID1d
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        custom_headers:
          - name: head_1
            value: val_1
          - name: head_2
            value: val_2
        from: "+18005550101"
        from_display_name: Company Name
        sip_auth_password: password
        sip_auth_username: username
        timeout_limit_secs: 60
        timeout_secs: 60
        to: +18005550100 or sip:username@sip.telnyx.com
        webhook_url: https://www.example.com/server-b/
        webhook_url_method: POST
      properties:
        answering_machine_detection:
          default: disabled
          description: Enables Answering Machine Detection. When a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will receive another 'call.machine.greeting.ended' webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive 'call.machine.greeting.ended' if a beep is detected.
          enum:
            - detect
            - detect_beep
            - detect_words
            - greeting_end
            - disabled
          type: string
        answering_machine_detection_config:
          description: Optional configuration parameters to modify 'answering_machine_detection' performance.
          properties:
            after_greeting_silence_millis:
              default: 800
              description: Silence duration threshold after a greeting message or voice for it be considered human.
              example: 1000
              format: int32
              type: integer
            between_words_silence_millis:
              default: 50
              description: Maximum threshold for silence between words.
              example: 100
              format: int32
              type: integer
            greeting_duration_millis:
              default: 3500
              description: Maximum threshold of a human greeting. If greeting longer than this value, considered machine.
              example: 1500
              format: int32
              type: integer
            greeting_silence_duration_millis:
              default: 1500
              description: If machine already detected, maximum threshold for silence between words. If exceeded, the greeting is considered ended.
              example: 2000
              format: int32
              type: integer
            greeting_total_analysis_time_millis:
              default: 5000
              description: If machine already detected, maximum timeout threshold to determine the end of the machine greeting.
              example: 7500
              format: int32
              type: integer
            initial_silence_millis:
              default: 3500
              description: If initial silence duration is greater than this value, consider it a machine.
              example: 1800
              format: int32
              type: integer
            maximum_number_of_words:
              default: 5
              description: If number of detected words is greater than this value, consder it a machine.
              example: 3
              format: int32
              type: integer
            maximum_word_length_millis:
              default: 3500
              description: If a single word lasts longer than this threshold, consider it a machine.
              example: 2000
              format: int32
              type: integer
            silence_threshold:
              default: 256
              description: Minimum noise threshold for any analysis.
              example: 512
              format: int32
              type: integer
            total_analysis_time_millis:
              default: 3500
              description: Maximum timeout threshold for overall detection.
              example: 5000
              format: int32
              type: integer
          type: object
        audio_url:
          description: The URL of a file to be played back when the transfer destination answers before bridging the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request.
          example: http://example.com/message.wav
          type: string
        client_state:
          description: Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        command_id:
          description: Use this field to avoid duplicate commands. Telnyx will ignore commands with the same `command_id`.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        custom_headers:
          description: Custom headers to be added to the SIP INVITE.
          example:
            - name: head_1
              value: val_1
            - name: head_2
              value: val_2
          items:
            $ref: "#/components/schemas/CustomSipHeader"
          type: array
        from:
          description: The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format. This attribute will default to the `from` number of the original call if omitted.
          example: "+18005550101"
          type: string
        from_display_name:
          description: The `from_display_name` string 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: Company Name
          type: string
        media_name:
          description: The media_name of a file to be played back when the transfer destination answers before bridging the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file.
          example: my_media_uploaded_to_media_storage_api
          type: string
        sip_auth_password:
          description: SIP Authentication password used for SIP challenges.
          example: password
          type: string
        sip_auth_username:
          description: SIP Authentication username used for SIP challenges.
          example: username
          type: string
        target_leg_client_state:
          description: Use this field to add state to every subsequent webhook for the new leg. It must be a valid Base-64 encoded string.
          example: aGF2ZSBhIG5pY2UgZGF5ID1d
          type: string
        time_limit_secs:
          default: 14400
          description: Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length.
          example: 600
          format: int32
          type: integer
        timeout_secs:
          default: 30
          description: The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being transferred. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds.
          example: 60
          format: int32
          type: integer
        to:
          description: The DID or SIP URI to dial out and bridge to the given call.
          example: +18005550100 or sip:username@sip.telnyx.com
          type: string
        webhook_url:
          description: Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.
          example: https://www.example.com/server-b/
          type: string
        webhook_url_method:
          default: POST
          description: HTTP request type used for `webhook_url`.
          enum:
            - POST
            - GET
          example: GET
          type: string
      required:
        - to
      title: Transfer Call Request
      type: object
    UnprocessableEntityError:
      properties:
        code:
          format: int
          type: string
        detail:
          type: string
        meta:
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              format: json-pointer
              type: string
          type: object
        title:
          type: string
      required:
        - code
        - title
    UpdateAuthenticationProviderRequest:
      example:
        active: true
        name: Okta
        settings:
          idp_cert_fingerprint: 13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7
          idp_cert_fingerprint_algorithm: sha1
          idp_entity_id: https://myorg.myidp.com/saml/metadata
          idp_sso_target_url: https://myorg.myidp.com/trust/saml2/http-post/sso
        short_name: myorg
      properties:
        active:
          $ref: "#/components/schemas/active"
        name:
          $ref: "#/components/schemas/name"
        settings:
          $ref: "#/components/schemas/settings"
        settings_url:
          $ref: "#/components/schemas/settings_url"
        short_name:
          $ref: "#/components/schemas/short_name"
      title: Update Authentication Provider Request
      type: object
    UpdateBillingGroup:
      example:
        name: string
      properties:
        name:
          description: A name for the billing group
          type: string
    UpdateCallControlApplicationRequest:
      example:
        active: false
        anchorsite_override: '"Latency"'
        application_name: call-router
        dtmf_type: Inband
        first_command_timeout: true
        first_command_timeout_secs: 10
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          default: true
          description: Specifies whether the connection can be used.
          type: boolean
        anchorsite_override:
          default: '"Latency"'
          description: |
            <code>Latency</code> directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.
          enum:
            - '"Latency"'
            - '"Chicago, IL"'
            - '"Ashburn, VA"'
            - '"San Jose, CA"'
          example: '"Amsterdam, Netherlands"'
          type: string
        application_name:
          description: A user-assigned name to help manage the application.
          example: call-router
          type: string
        dtmf_type:
          default: RFC 2833
          description: Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
          enum:
            - RFC 2833
            - Inband
            - SIP INFO
          example: Inband
          type: string
        first_command_timeout:
          default: false
          description: Specifies whether calls to phone numbers associated with this connection should hangup after timing out.
          example: true
          type: boolean
        first_command_timeout_secs:
          default: 30
          description: Specifies how many seconds to wait before timing out a dial command.
          example: 10
          type: integer
        inbound:
          $ref: "#/components/schemas/CallControlApplicationInbound"
        outbound:
          $ref: "#/components/schemas/CallControlApplicationOutbound"
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      required:
        - application_name
        - webhook_event_url
      title: Update Call Control Application Request
      type: object
    UpdateConferenceRequest:
      example:
        call_control_id: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ
        command_id: 891510ac-f3e4-11e8-af5b-de00688a4901
        supervisor_role: whisper
        whisper_call_control_ids:
          - v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ
          - v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw
      properties:
        call_control_id:
          description: Unique identifier and token for controlling the call
          example: v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==
          type: string
        command_id:
          description: Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.
          example: 891510ac-f3e4-11e8-af5b-de00688a4901
          type: string
        supervisor_role:
          description: Sets the participant as a supervisor for the conference. A conference can have multiple supervisors. "barge" means the supervisor enters the conference as a normal participant. This is the same as "none". "monitor" means the supervisor is muted but can hear all participants. "whisper" means that only the specified "whisper_call_control_ids" can hear the supervisor. Defaults to "none".
          enum:
            - barge
            - monitor
            - none
            - whisper
          example: whisper
          type: string
        whisper_call_control_ids:
          description: Array of unique call_control_ids the supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only.
          example:
            - v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ
            - v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw
          items:
            type: string
          type: array
      required:
        - call_control_id
        - supervisor_role
      title: Update Conference Request
      type: object
    UpdateCredentialConnectionRequest:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: my name
        default_on_hold_comfort_noise_enabled: false
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        inbound:
          ani_number_format: +E.164
          channel_limit: 10
          codecs: G722
          default_routing_method: sequential
          dnis_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          timeout_1xx_secs: 10
          timeout_2xx_secs: 20
        onnet_t38_passthrough_enabled: true
        outbound:
          ani_override: always
          call_parking_enabled: true
          channel_limit: 10
          generate_ringback_tone: true
          instant_ringback_enabled: true
          localization: US
          outbound_voice_profile_id: "1293384261075731499"
          t38_reinvite_source: telnyx
        password: my123secure456password789
        rtcp_settings:
          capture_enabled: true
          port: rtcp-mux
          report_frequency_seconds: 10
        sip_uri_calling_preference: " disabled"
        user_name: myusername123
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          description: Defaults to true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          type: string
        default_on_hold_comfort_noise_enabled:
          default: false
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        inbound:
          $ref: "#/components/schemas/CredentialInbound"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
          type: boolean
        outbound:
          $ref: "#/components/schemas/CredentialOutbound"
        password:
          description: The password to be used as part of the credentials. Must be 8 to 128 characters long.
          example: my123secure456password789
          type: string
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        sip_uri_calling_preference:
          default: disabled
          description: This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).
          enum:
            - disabled
            - unrestricted
            - internal
          type: string
        user_name:
          description: The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).
          example: myusername123
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      title: Update Credential Connection Request
      type: object
    UpdateFaxApplicationRequest:
      example:
        active: false
        anchorsite_override: Amsterdam, Netherlands
        application_name: fax-router
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          $ref: "#/components/schemas/ConnectionActive"
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        application_name:
          $ref: "#/components/schemas/ApplicationName"
        inbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            sip_subdomain:
              default: null
              description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
              example: example
              type: string
            sip_subdomain_receive_settings:
              default: from_anyone
              description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
              enum:
                - only_my_connections
                - from_anyone
              example: only_my_connections
              type: string
          type: object
        outbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            outbound_voice_profile_id:
              $ref: "#/components/schemas/OutboundVoiceProfileId"
          type: object
        webhook_event_failover_url:
          $ref: "#/components/schemas/WebhookEventFailoverUrl"
        webhook_event_url:
          $ref: "#/components/schemas/WebhookEventUrl"
        webhook_timeout_secs:
          $ref: "#/components/schemas/WebhookTimeoutSecs"
      required:
        - application_name
        - webhook_event_url
      title: Update Fax Application Request
      type: object
    UpdateFqdnConnectionRequest:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: string
        default_on_hold_comfort_noise_enabled: true
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        inbound:
          ani_number_format: +E.164
          channel_limit: 10
          codecs:
            - G722
          default_routing_method: sequential
          dnis_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          sip_region: US
          sip_subdomain: string
          sip_subdomain_receive_settings: only_my_connections
          timeout_1xx_secs: 10
          timeout_2xx_secs: 10
        onnet_t38_passthrough_enabled: true
        rtcp_settings:
          capture_enabled: true
          port: rtcp-mux
          report_frequency_secs: 10
        transport_protocol: UDP
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          description: Defaults to true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          type: string
        default_on_hold_comfort_noise_enabled:
          default: true
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        inbound:
          $ref: "#/components/schemas/InboundFqdn"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer that the sender and receiver negotiate T38 directly when both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call according to each leg's settings.
          type: boolean
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        transport_protocol:
          $ref: "#/components/schemas/FqdnConnectionTransportProtocol"
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      title: Update FQDN Connection Request
    UpdateFqdnRequest:
      example:
        connection_id: "1516447646313612565"
        dns_record_type: a
        fqdn: example.com
        port: 8080
      properties:
        connection_id:
          description: ID of the FQDN connection to which this IP should be attached.
          type: string
        dns_record_type:
          description: The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.
          example: a
          type: string
        fqdn:
          description: FQDN represented by this resource.
          example: example.com
          type: string
        port:
          default: 5060
          description: Port to use when connecting to this FQDN.
          example: 5060
          nullable: true
          type: integer
      title: Update FQDN Request
      type: object
    UpdateIpConnectionRequest:
      example:
        active: true
        anchorsite_override: Latency
        connection_name: string
        default_on_hold_comfort_noise_enabled: true
        dtmf_type: RFC 2833
        encode_contact_header_enabled: true
        encrypted_media: SRTP
        "inbound:":
          ani_number_format: +E.164
          channel_limit: 10
          codecs: G722
          default_primary_ip_id: 192.168.0.0
          default_routing_method: sequential
          default_secondary_ip_id: 192.168.0.0
          default_tertiary_ip_id: 192.168.0.0
          dns_number_format: +e164
          generate_ringback_tone: true
          isup_headers_enabled: true
          prack_enabled: true
          privacy_zone_enabled: true
          sip_compact_headers_enabled: true
          sip_region: US
          sip_subdomain: test
          sip_subdomain_receive_settings: only_my_connections
          timeout_1xx_secs: 10
          timeout_2xx_secs: 20
        onnet_t38_passthrough_enabled: false
        outbound:
          ani_override: string
          ani_override_type: always
          call_parking_enabled: true
          channel_limit: 10
          generate_ringback_tone: true
          instant_ringback_enabled: true
          ip_authentication_method: token
          ip_authentication_token: string
          localization: string
          outbound_voice_profile_id: "1293384261075731499"
          t38_reinvite_source: telnyx
          tech_prefix: string
        rtcp_settings:
          capture_enabled: true
          port: rtcp-mux
          report_frequency_secs: 10
        transport_protocol: UDP
        webhook_api_version: "1"
        webhook_event_failover_url: https://failover.example.com
        webhook_event_url: https://example.com
        webhook_timeout_secs: 25
      properties:
        active:
          description: Defaults to true
          type: boolean
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        connection_name:
          type: string
        default_on_hold_comfort_noise_enabled:
          default: true
          description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
          type: boolean
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        encode_contact_header_enabled:
          default: false
          description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
          type: boolean
        encrypted_media:
          $ref: "#/components/schemas/EncryptedMedia"
        inbound:
          $ref: "#/components/schemas/InboundIp"
        onnet_t38_passthrough_enabled:
          default: false
          description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
          type: boolean
        outbound:
          $ref: "#/components/schemas/OutboundIp"
        rtcp_settings:
          $ref: "#/components/schemas/ConnectionRtcpSettings"
        transport_protocol:
          default: UDP
          description: One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.
          enum:
            - UDP
            - TCP
            - TLS
          type: string
        webhook_api_version:
          default: "1"
          description: Determines which webhook format will be used, Telnyx API v1 or v2.
          enum:
            - "1"
            - "2"
          example: "1"
          type: string
        webhook_event_failover_url:
          default: ""
          description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
          example: https://failover.example.com
          format: url
          nullable: true
          type: string
        webhook_event_url:
          description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
          example: https://example.com
          format: url
          type: string
        webhook_timeout_secs:
          default: null
          description: Specifies how many seconds to wait before timing out a webhook.
          example: 25
          maximum: 30
          minimum: 0
          nullable: true
          type: integer
      title: Update Ip Connection Request
    UpdateIpRequest:
      example:
        connection_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        ip_address: 192.168.0.0
        port: 5060
      properties:
        connection_id:
          description: ID of the IP Connection to which this IP should be attached.
          type: string
        ip_address:
          description: IP adddress represented by this resource.
          example: 192.168.0.0
          type: string
        port:
          default: 5060
          description: Port to use when connecting to this IP.
          example: 5060
          type: integer
      required:
        - ip_address
      title: Update Ip Request
      type: object
    UpdateMediaMultipartRequest:
      example:
        media: string($binary)
        ttl_secs: 86400
      properties:
        media:
          description: The file you want to upload. The maximum allowed size is 20 MB.
          format: binary
          type: string
        ttl_secs:
          description: The number of seconds after which the media resource will be deleted, defaults to 2 days.
          example: 86400
          type: integer
      title: Upload media multipart request
      type: object
    UpdateMediaRequest:
      example:
        media_url: http://www.example.com/audio.mp3
        ttl_secs: 86400
      properties:
        media_url:
          description: The URL where the media to be stored in Telnyx network is currently hosted. The maximum allowed size is 20 MB.
          example: http://www.example.com/audio.mp3
          type: string
        ttl_secs:
          description: The number of seconds after which the media resource will be deleted, defaults to 2 days.
          example: 86400
          type: integer
      title: Upload media request
      type: object
    UpdateMessagingProfileRequest:
      example:
        enabled: true
        name: Updated Profile for Messages
        number_pool_settings:
          geomatch: false
          long_code_weight: 2
          skip_unhealthy: false
          sticky_sender: true
          toll_free_weight: 10
        url_shortener_settings:
          domain: example.ex
          prefix: cmpny
          replace_blacklist_only: true
          send_webhooks: false
        v1_secret: rP1VamejkU2v0qIUxntqLW2c
        webhook_api_version: "2"
        webhook_failover_url: https://backup.example.com/hooks
        webhook_url: https://www.example.com/hooks
        whitelisted_destinations:
          - US
      properties:
        created_at:
          description: ISO 8601 formatted date indicating when the resource was created.
          format: date-time
          readOnly: true
          type: string
        enabled:
          description: Specifies whether the messaging profile is enabled or not.
          type: boolean
        id:
          description: Identifies the type of resource.
          format: uuid
          readOnly: true
          type: string
        name:
          description: A user friendly name for the messaging profile.
          type: string
        number_pool_settings:
          $ref: "#/components/schemas/NumberPoolSettings"
        record_type:
          description: Identifies the type of the resource.
          enum:
            - messaging_profile
          readOnly: true
          type: string
        updated_at:
          description: ISO 8601 formatted date indicating when the resource was updated.
          format: date-time
          readOnly: true
          type: string
        url_shortener_settings:
          $ref: "#/components/schemas/UrlShortenerSettings"
        v1_secret:
          description: Secret used to authenticate with v1 endpoints.
          type: string
        webhook_api_version:
          description: Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.
          enum:
            - "1"
            - "2"
            - 2010-04-01
          type: string
        webhook_failover_url:
          description: The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.
          format: url
          nullable: true
          type: string
        webhook_url:
          description: The URL where webhooks related to this messaging profile will be sent.
          format: url
          nullable: true
          type: string
        whitelisted_destinations:
          description: Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `["*"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes.
          items:
            description: ISO 3166-1 alpha-2 country code.
            pattern: ^[A-Z]{2}$
            type: string
          nullable: true
          type: array
      type: object
    UpdateNumberOrderDocumentRequest:
      example:
        created_at: 2018-01-01T00:00:00.000000Z
        customer_reference: MY REF 001
        file_id: 1e3c5822-0362-4702-8e46-5a129f0d3976
        id: 387d1e31-a218-4375-8151-103f2d5e2d2c
        record_type: number_order_document
        requirement_type: address_proof
        requirements_id: 36aaf27d-986b-493c-bd1b-de16af2e4292
      properties:
        created_at:
          description: An ISO 8901 datetime string denoting when the number order document was uploaded.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        file_id:
          description: The id of the file to associate as a number order document.
          example: 1e3c5822-0362-4702-8e46-5a129f0d3976
          type: string
        id:
          example: 387d1e31-a218-4375-8151-103f2d5e2d2c
          format: uuid
          readOnly: true
          type: string
        record_type:
          example: number_order_document
          readOnly: true
          type: string
        requirement_type:
          enum:
            - address_proof
            - identification
            - reg_form
          readOnly: true
          type: string
        requirements_id:
          description: Unique id for a requirement.
          example: 36aaf27d-986b-493c-bd1b-de16af2e4292
          type: string
    UpdateNumberOrderPhoneNumberRequest:
      properties:
        regulatory_requirements:
          items:
            $ref: "#/components/schemas/UpdateRegulatoryRequirement"
          type: array
    UpdateNumberOrderRequest:
      example:
        created_at: 2018-01-01T00:00:00.000000Z
        customer_reference: MY REF 001
        id: 12ade33a-21c0-473b-b055-b3c836e1c292
        phone_numbers:
          - id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
            phone_number: "+19705555098"
            record_type: number_order_phone_number
            regulatory_group_id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
            regulatory_requirements:
              - field_type: address
                field_value: 45f45a04-b4be-4592-95b1-9306b9db2b21
                record_type: phone_number_regulatory_requirement
                requirement_id: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
            requirements_met: true
            status: success
        phone_numbers_count: 1
        record_type: number_order
        requirements_met: true
        status: pending
        updated_at: 2018-01-01T00:00:00.000000Z
      properties:
        created_at:
          description: An ISO 8901 datetime string denoting when the number order was created.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          readOnly: true
          type: string
        phone_numbers:
          items:
            $ref: "#/components/schemas/PhoneNumber"
          type: array
          writeOnly: true
        phone_numbers_count:
          description: The count of phone numbers in the number order.
          example: 1
          readOnly: true
          type: integer
        record_type:
          example: number_order
          readOnly: true
          type: string
        requirements_met:
          description: True if all requirements are met for every phone number, false otherwise.
          example: true
          readOnly: true
          type: boolean
        status:
          description: The status of the order.
          enum:
            - pending
            - success
            - failure
          readOnly: true
          type: string
        updated_at:
          description: An ISO 8901 datetime string for when the number order was updated.
          example: 2018-01-01T00:00:00.000000Z
          format: datetime
          readOnly: true
          type: string
    UpdateOutboundVoiceProfileRequest:
      example:
        billing_group_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
        concurrent_call_limit: 10
        daily_spend_limit: "100.00"
        daily_spend_limit_enabled: true
        enabled: true
        max_destination_rate: 10
        name: office
        service_plan: global
        tags:
          - office-profile
        traffic_type: conversational
        usage_payment_method: rate-deck
        whitelisted_destinations:
          - US
          - BR
          - AU
      properties:
        billing_group_id:
          default: null
          description: The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          nullable: true
          type: string
        call_recording:
          $ref: "#/components/schemas/OutboundCallRecording"
        concurrent_call_limit:
          description: Must be no more than your global concurrent call limit. Null means no limit.
          example: 10
          nullable: true
          type: integer
        daily_spend_limit:
          description: The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.
          example: "100.00"
          type: string
        daily_spend_limit_enabled:
          default: false
          description: Specifies whether to enforce the daily_spend_limit on this outbound voice profile.
          example: true
          type: boolean
        enabled:
          default: true
          description: Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.
          example: true
          type: boolean
        max_destination_rate:
          description: Maximum rate (price per minute) for a Destination to be allowed when making outbound calls.
          type: number
        name:
          description: A user-supplied name to help with organization.
          example: office
          minLength: 3
          type: string
        service_plan:
          $ref: "#/components/schemas/ServicePlan"
        tags:
          example:
            - office-profile
          items:
            type: string
          type: array
        traffic_type:
          $ref: "#/components/schemas/TrafficType"
        usage_payment_method:
          $ref: "#/components/schemas/UsagePaymentMethod"
        whitelisted_destinations:
          default:
            - US
            - CA
          description: The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.
          example:
            - US
            - BR
            - AU
          items:
            type: string
          type: array
      required:
        - name
      title: Outbound Voice Profile
      type: object
    UpdatePhoneNumberMessagingSettingsRequest:
      example:
        messaging_product: P2P
        messaging_profile_id: dd50eba1-a0c0-4563-9925-b25e842a7cb6
      properties:
        messaging_product:
          description: The requested messaging product the number should be on
          example: P2P
          type: string
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          type: string
      type: object
    UpdatePhoneNumberRequest:
      example:
        address_id: dc8f39ac-953d-4520-b93b-786ae87db0da
        billing_group_id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
        connection_id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
        customer_reference: customer-reference
        external_pin: "1234"
        id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494
        number_level_routing: disabled
        tags:
          - tag
      properties:
        billing_group_id:
          description: Identifies the billing group associated with the phone number.
          type: string
        connection_id:
          description: Identifies the connection associated with the phone number.
          type: string
        customer_reference:
          description: A customer reference string for customer look ups.
          example: MY REF 001
          type: string
        external_pin:
          description: If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.
          type: string
        id:
          description: Identifies the type of resource.
          readOnly: true
          type: string
        number_level_routing:
          default: enabled
          description: Specifies whether the number can have overrides to the routing settings on itself (enabled) or if it uses the associated connection for all routing settings (disabled). Defaults to enabled but will be changed to disabled in the future. There are performance advantages to using disabled and setting all routing information at the connection level.
          enum:
            - enabled
            - disabled
          type: string
        tags:
          description: A list of user-assigned tags to help organize phone numbers.
          items:
            type: string
          type: array
      type: object
    UpdatePhoneNumberVoiceSettingsRequest:
      example:
        call_forwarding:
          call_forwarding_enabled: true
          forwarding_type: always
          forwards_to: "+13035559123"
        call_recording:
          inbound_call_recording_channels: single
          inbound_call_recording_enabled: true
          inbound_call_recording_format: wav
        cnam_listing:
          cnam_listing_details: example
          cnam_listing_enabled: true
        media_features:
          accept_any_rtp_packets_enabled: true
          media_handling_mode: default
          rtp_auto_adjust_enabled: true
          t38_fax_gateway_enabled: true
        tech_prefix_enabled: true
        translated_number: "+13035559999"
        usage_payment_method: pay-per-minute
      properties:
        call_forwarding:
          $ref: "#/components/schemas/CallForwarding"
        call_recording:
          $ref: "#/components/schemas/CallRecording"
        cnam_listing:
          $ref: "#/components/schemas/CnamListing"
        media_features:
          $ref: "#/components/schemas/MediaFeatures"
        tech_prefix_enabled:
          default: false
          description: Controls whether a tech prefix is enabled for this phone number.
          type: boolean
        translated_number:
          description: This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed.
          type: string
        usage_payment_method:
          default: pay-per-minute
          description: Controls whether a number is billed per minute or uses your concurrent channels.
          enum:
            - pay-per-minute
            - channel
          type: string
      type: object
    UpdatePortingOrder:
      properties:
        activation_settings:
          properties:
            foc_datetime_requested:
              description: ISO 8601 formatted Date/Time requested for the FOC date
              example: 2021-03-19T10:07:15.527Z
              format: date-time
              type: string
          type: object
        customer_reference:
          type: string
        end_user:
          $ref: "#/components/schemas/PortingEndUser"
        misc:
          $ref: "#/components/schemas/PortingOrderMisc"
        phone_number_configuration:
          $ref: "#/components/schemas/PortingOrderPhoneNumberConfiguration"
        requirements:
          description: List of requirements for porting numbers.
          items:
            $ref: "#/components/schemas/UpdatePortingOrderRequirement"
          type: array
        user_feedback:
          $ref: "#/components/schemas/PortingOrderUserFeedback"
        webhook_url:
          format: uri
          type: string
      title: UpdatePortingOrder
      type: object
    UpdatePortingOrderRequirement:
      properties:
        field_value:
          description: identifies the document that satisfies this requirement
          example: 9787fb5f-cbe5-4de4-b765-3303774ee9fe
          type: string
        requirement_type_id:
          description: Identifies the requirement type that meets this requirement
          example: 59b0762a-b274-4f76-ac32-4d5cf0272e66
          type: string
      required:
        - field_value
        - requirement_type_id
      type: object
    UpdateRegulatoryRequirement:
      properties:
        field_value:
          description: The value of the requirement, this could be an id to a resource or a string value.
          example: 45f45a04-b4be-4592-95b1-9306b9db2b21
          type: string
        requirement_id:
          description: Unique id for a requirement.
          example: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576
          format: uuid
          type: string
    UpdateShortCodeRequest:
      example:
        messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000
      properties:
        messaging_profile_id:
          description: Unique identifier for a messaging profile.
          type: string
      required:
        - messaging_profile_id
      type: object
    UpdateSubNumberOrderRequest:
      properties:
        regulatory_requirements:
          items:
            $ref: "#/components/schemas/UpdateRegulatoryRequirement"
          type: array
    UpdateTexmlApplicationRequest:
      example:
        active: false
        anchorsite_override: Amsterdam, Netherlands
        dtmf_type: Inband
        first_command_timeout: true
        first_command_timeout_secs: 10
        friendly_name: call-router
        inbound:
          channel_limit: 10
          sip_subdomain: example
          sip_subdomain_receive_settings: only_my_connections
        outbound:
          channel_limit: 10
          outbound_voice_profile_id: "1293384261075731499"
        status_callback: https://example.com
        status_callback_method: get
        voice_fallback_url: https://fallback.example.com
        voice_method: get
        voice_url: https://example.com
      properties:
        active:
          $ref: "#/components/schemas/ConnectionActive"
        anchorsite_override:
          $ref: "#/components/schemas/AnchorsiteOverride"
        dtmf_type:
          $ref: "#/components/schemas/DtmfType"
        first_command_timeout:
          $ref: "#/components/schemas/FirstCommandTimeout"
        first_command_timeout_secs:
          $ref: "#/components/schemas/FirstCommandTimeoutSecs"
        friendly_name:
          $ref: "#/components/schemas/ApplicationName"
        inbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            sip_subdomain:
              default: null
              description: 'Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.'
              example: example
              type: string
            sip_subdomain_receive_settings:
              default: from_anyone
              description: 'This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).'
              enum:
                - only_my_connections
                - from_anyone
              example: only_my_connections
              type: string
          type: object
        outbound:
          properties:
            channel_limit:
              default: null
              description: When set, this will limit the total number of outbound calls to phone numbers associated with this connection.
              example: 10
              type: integer
            outbound_voice_profile_id:
              $ref: "#/components/schemas/OutboundVoiceProfileId"
          type: object
        status_callback:
          default: null
          description: URL for Telnyx to send requests to containing information about call progress events.
          example: https://example.com
          format: url
          type: string
        status_callback_method:
          default: post
          description: HTTP request method Telnyx should use when requesting the status_callback URL.
          enum:
            - get
            - post
          example: get
          type: string
        voice_fallback_url:
          default: null
          description: URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.
          example: https://fallback.example.com
          format: url
          type: string
        voice_method:
          default: post
          description: HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.
          enum:
            - get
            - post
          example: get
          type: string
        voice_url:
          description: URL to which Telnyx will deliver your XML Translator webhooks.
          example: https://example.com
          format: url
          type: string
      required:
        - friendly_name
        - voice_url
      title: Update Texml Application Request
      type: object
    UpdateUserRequest:
      properties:
        webhook_url:
          description: The desired URL to set for your WhatsApp webhook endpoint.
          example: https://mywebhook.com/example/endpoint
          title: Webhook Url
          type: string
      required:
        - webhook_url
      title: UpdateUserRequest
      type: object
    UpdateVerifyProfileCallRequest:
      properties:
        default_call_timeout_secs:
          default: 45
          description: Must be less than default_verification_timeout_secs
          example: 30
          type: integer
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
        speech_template:
          description: Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code.
          example: "Hello, this is the Acme Inc verification code you requested: {code}."
          type: string
      title: UpdateVerifyProfileCallRequest
      type: object
    UpdateVerifyProfileFlashcallRequest:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      title: UpdateVerifyProfileFlashcallRequest
      type: object
    UpdateVerifyProfilePSD2Request:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      title: UpdateVerifyProfilePSD2Request
      type: object
    UpdateVerifyProfileSMSRequest:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
        messaging_enabled:
          description: Enables SMS text messaging for the Verify profile.
          example: true
          type: boolean
        messaging_template:
          description: Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code.
          example: "Hello, this is the Acme Inc verification code you requested: {code}."
          type: string
        rcs_enabled:
          description: Enables RCS messaging for the Verify profile.
          example: true
          type: boolean
        vsms_enabled:
          description: Enables VSMS for the Verify profile.
          example: true
          type: boolean
      title: UpdateVerifyProfileSMSRequest
      type: object
    UpdateVerifyProfileWhatsappRequest:
      properties:
        app_name:
          description: The name that identifies the application requesting 2fa in the verification message.
          example: Example Secure App
          type: string
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      title: UpdateVerifyProfileWhatsappRequest
      type: object
    UpdatedAt:
      description: ISO 8601 formatted date indicating when the resource was updated.
      example: 2020-02-03T22:25:27.521Z
      title: Updated At
      type: string
    UplinkData:
      properties:
        amount:
          description: Uplink data
          example: 1
          type: number
        unit:
          default: MB
          description: Transmission unit
          enum:
            - B
            - KB
            - MB
          type: string
      type: object
    UploadFileMessagingHostedNumberOrderRequest:
      example:
        bill: bill example
        loa: example loa
      properties:
        bill:
          description: Must be the last month's bill with proof of ownership of all of the numbers in the order in PDF format.
          format: binary
          type: string
        loa:
          description: Must be a signed LOA for the numbers in the order in PDF format.
          format: binary
          type: string
      type: object
    UploadMedia:
      description: ""
      example:
        id: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68
        record_type: whatsapp_media_id
      properties:
        id:
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - whatsapp_media_id
          readOnly: true
          type: string
      title: Upload Media
      type: object
    UploadMediaMultipartRequest:
      example:
        media: string($binary)
        media_name: my-file
        ttl_secs: 86400
      properties:
        media:
          description: The file you want to upload. The maximum allowed size is 20 MB.
          format: binary
          type: string
        media_name:
          description: The unique identifier of a file.
          example: my_file
          type: string
        ttl_secs:
          description: The number of seconds after which the media resource will be deleted, defaults to 2 days.
          example: 86400
          type: integer
      required:
        - media
      title: Upload media multipart request
      type: object
    UploadMediaRequest:
      example:
        media_name: my-file
        media_url: http://www.example.com/audio.mp3
        ttl_secs: 86400
      properties:
        media_name:
          description: The unique identifier of a file.
          example: my_file
          type: string
        media_url:
          description: The URL where the media to be stored in Telnyx network is currently hosted. The maximum allowed size is 20 MB.
          example: http://www.example.com/audio.mp3
          type: string
        ttl_secs:
          description: The number of seconds after which the media resource will be deleted, defaults to 2 days.
          example: 86400
          type: integer
      required:
        - media_url
      title: Upload media request
      type: object
    Url:
      description: "Standard Values: HOME, WORK"
      example:
        type: WORK
        url: https://www.facebook.com
      properties:
        type:
          description: "Standard Values: HOME, WORK"
          type: string
        url:
          description: URL
          type: string
      title: Root Type for Url
      type: object
    UrlShortenerSettings:
      description: |
        The URL shortener feature allows automatic replacement of URLs that were generated using
        a public URL shortener service. Some examples include bit.do, bit.ly, goo.gl, ht.ly,
        is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com. Such URLs are replaced with
        with links generated by Telnyx. The use of custom links can improve branding and message
        deliverability.

        To disable this feature, set the object field to `null`.
      example:
        domain: example.ex
        prefix: ""
        replace_blacklist_only: true
        send_webhooks: false
      nullable: true
      properties:
        domain:
          description: |
            One of the domains provided by the Telnyx URL shortener service.
          example: acct.fyi
          type: string
        prefix:
          description: |
            Optional prefix that can be used to identify your brand, and will appear in the Telnyx generated URLs after the domain name.
          example: ""
          type: string
        replace_blacklist_only:
          description: |
            Use the link replacement tool only for links that are specifically blacklisted by Telnyx.
          example: true
          type: boolean
        send_webhooks:
          description: |
            Receive webhooks for when your replaced links are clicked. Webhooks are sent to the webhooks on the messaging profile.
          example: false
          type: boolean
      required:
        - domain
      type: object
    UsagePaymentMethod:
      default: rate-deck
      description: Setting for how costs for outbound profile are calculated.
      enum:
        - tariff
        - rate-deck
      example: tariff
      type: string
    UserBalance:
      example:
        available_credit: "400.00"
        balance: "300.00"
        credit_limit: "100.00"
        currency: USD
        record_type: balance
      properties:
        available_credit:
          description: Available amount to spend (balance + credit limit)
          example: "400.00"
          format: decimal
          type: string
        balance:
          description: The account's current balance.
          example: "300.00"
          format: decimal
          type: string
        credit_limit:
          description: The account's credit limit.
          example: "100.00"
          format: decimal
          type: string
        currency:
          description: The ISO 4217 currency identifier.
          example: USD
          format: iso4217
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - balance
          example: balance
          type: string
      type: object
    ValidateAddress:
      properties:
        administrative_area:
          $ref: "#/components/schemas/administrative_area"
        country_code:
          $ref: "#/components/schemas/country_code"
        extended_address:
          $ref: "#/components/schemas/extended_address"
        locality:
          $ref: "#/components/schemas/locality"
        postal_code:
          $ref: "#/components/schemas/postal_code"
        street_address:
          $ref: "#/components/schemas/street_address"
      type: object
    ValidateAddressRequest:
      properties:
        administrative_area:
          $ref: "#/components/schemas/administrative_area"
        country_code:
          $ref: "#/components/schemas/country_code"
        extended_address:
          $ref: "#/components/schemas/extended_address"
        locality:
          $ref: "#/components/schemas/locality"
        postal_code:
          $ref: "#/components/schemas/postal_code"
        street_address:
          $ref: "#/components/schemas/street_address"
      required:
        - country_code
        - street_address
        - postal_code
      type: object
    ValidateAddressResult:
      properties:
        errors:
          items:
            $ref: "#/components/schemas/Error"
          type: array
        record_type:
          description: Identifies the type of the resource.
          example: address_validation
          type: string
        result:
          description: Indicates whether an address is valid or invalid.
          enum:
            - valid
            - invalid
          example: valid
          type: string
        suggested:
          $ref: "#/components/schemas/ValidateAddress"
          description: Provides normalized address when available.
          type: object
      required:
        - result
        - suggested
      title: Validate address action result
      type: object
    Verification:
      properties:
        call_timeout_secs:
          description: "This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the `default_call_timeout_secs` on the Verify profile."
          example: 299
          type: integer
        created_at:
          example: 2020-09-14T17:03:32.965812
          type: string
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          type: string
        phone_number:
          description: +E164 formatted phone number.
          example: "+13035551234"
          type: string
        record_type:
          $ref: "#/components/schemas/VerificationRecordType"
        status:
          $ref: "#/components/schemas/VerificationStatus"
        timeout_secs:
          description: "This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the `default_verification_timeout_secs` on the Verify profile."
          example: 300
          type: integer
        updated_at:
          example: 2020-09-14T17:03:32.965812
          type: string
        verification_type:
          $ref: "#/components/schemas/VerificationType"
        verify_profile_id:
          description: The identifier of the associated Verify profile.
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          type: string
      title: Verification
      type: object
    VerificationProfileRecordType:
      description: The possible verification profile record types.
      enum:
        - verification_profile
      example: verification_profile
      title: VerificationProfileRecordType
      type: string
    VerificationRecordType:
      description: The possible verification record types.
      enum:
        - verification
      example: verification
      title: VerificationRecordType
      type: string
    VerificationStatus:
      description: The possible statuses of the verification request.
      enum:
        - pending
        - sms_delivery_failed
        - accepted
        - expired
        - not_enough_credit
        - network_error
        - number_unreachable
        - internal_error
        - invalid_destination
        - timed_out
      example: accepted
      title: VerificationStatus
      type: string
    VerificationType:
      description: The possible types of verification.
      enum:
        - sms_verification
        - psd2_verification
        - whatsapp_verification
        - call_verification
        - flashcall_verification
      example: sms_verification
      title: VerificationType
      type: string
    VerifyProfileCallResponse:
      properties:
        default_call_timeout_secs:
          default: 45
          description: Must be less than default_verification_timeout_secs
          example: 30
          type: integer
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
        speech_template:
          description: Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code.
          example: "Hello, this is the Acme Inc verification code you requested: {code}."
          type: string
      title: VerifyProfileCallResponse
      type: object
    VerifyProfileFlashcallResponse:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      title: VerifyProfileFlashcallResponse
      type: object
    VerifyProfilePSD2Response:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      title: VerifyProfilePSD2Response
      type: object
    VerifyProfileResponse:
      properties:
        call:
          $ref: "#/components/schemas/VerifyProfileCallResponse"
          type: object
        created_at:
          example: 2020-09-14T17:03:32.965812
          type: string
        flashcall:
          $ref: "#/components/schemas/VerifyProfileFlashcallResponse"
          type: object
        id:
          example: 12ade33a-21c0-473b-b055-b3c836e1c292
          format: uuid
          type: string
        language:
          example: en-US
          type: string
        name:
          example: Test Profile
          type: string
        psd2:
          $ref: "#/components/schemas/VerifyProfilePSD2Response"
          type: object
        record_type:
          $ref: "#/components/schemas/VerificationProfileRecordType"
        sms:
          $ref: "#/components/schemas/VerifyProfileSMSResponse"
          type: object
        updated_at:
          example: 2020-09-14T17:03:32.965812
          type: string
        webhook_failover_url:
          example: http://example.com/webhook/failover
          type: string
        webhook_url:
          example: http://example.com/webhook
          type: string
        whatsapp:
          $ref: "#/components/schemas/VerifyProfileWhatsappResponse"
          type: object
      title: VerifyProfileResponse
      type: object
    VerifyProfileResponseDataWrapper:
      properties:
        data:
          $ref: "#/components/schemas/VerifyProfileResponse"
          type: object
      title: VerifyProfileResponseDataWrapper
      type: object
    VerifyProfileSMSResponse:
      properties:
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
        messaging_enabled:
          description: Enables SMS text messaging for the Verify profile.
          example: true
          type: boolean
        messaging_template:
          description: Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code.
          example: "Hello, this is the Acme Inc verification code you requested: {code}."
          type: string
        rcs_enabled:
          description: Enables RCS messaging for the Verify profile.
          example: true
          type: boolean
        vsms_enabled:
          description: Enables VSMS for the Verify profile.
          example: true
          type: boolean
      title: VerifyProfileSMSResponse
      type: object
    VerifyProfileWhatsappResponse:
      properties:
        app_name:
          description: The name that identifies the application requesting 2fa in the verification message.
          example: Example Secure App
          type: string
        default_verification_timeout_secs:
          description: For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.
          example: 300
          type: integer
      title: VerifyProfileWhatsappResponse
      type: object
    VerifyVerificationCodeRequest:
      properties:
        code:
          description: This is the code the user submits for verification.
          example: "17686"
          type: string
      required:
        - code
      title: VerifyVerificationCodeRequest
      type: object
    VerifyVerificationCodeResponse:
      properties:
        data:
          properties:
            phone_number:
              description: +E164 formatted phone number.
              example: "+13035551234"
              type: string
            response_code:
              description: Identifies if the verification code has been accepted or rejected.
              enum:
                - accepted
                - rejected
              example: accepted
              type: string
          required:
            - phone_number
            - response_code
          type: object
      required:
        - data
      title: VerifyVerificationCodeResponse
      type: object
    Video:
      description: The media object containing a video
      example:
        caption: My cool media!
        id: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68
      properties:
        caption:
          description: Describes the specified media.
          example: My cool media!
          type: string
        id:
          description: The media object ID returned when the media is successfully uploaded to the media endpoint.
          example: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68
          type: string
        link:
          description: The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Either id or link must be provided, not both.
          example: http://www.example.com/file
          type: string
      title: Video
      type: object
    WdrReport:
      properties:
        created_at:
          description: ISO 8601 formatted date-time indicating when the resource was created.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        end_time:
          description: ISO 8601 formatted date-time indicating the end time.
          example: 2018-02-02T22:25:27.521Z
          type: string
        id:
          description: Identifies the resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          readOnly: true
          type: string
        record_type:
          example: detail_records_report
          readOnly: true
          type: string
        report_url:
          description: The URL where the report content, when generated, will be published to.
          example: http://example.com
          type: string
        start_time:
          description: ISO 8601 formatted date-time indicating the start time.
          example: 2018-02-02T22:25:27.521Z
          type: string
        status:
          description: Indicates the status of the report, which is updated asynchronously.
          enum:
            - pending
            - complete
            - failed
            - deleted
          example: pending
          type: string
        updated_at:
          description: ISO 8601 formatted date-time indicating when the resource was updated.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      type: object
    WdrReportRequest:
      example:
        end_time: 2018-02-02T22:25:27.521Z
        start_time: 2018-02-02T22:25:27.521Z
      properties:
        end_time:
          description: ISO 8601 formatted date-time indicating the end time.
          example: 2018-02-02T22:25:27.521Z
          type: string
        start_time:
          description: ISO 8601 formatted date-time indicating the start time.
          example: 2018-02-02T22:25:27.521Z
          type: string
      type: object
    WebhookApiVersion:
      default: "1"
      description: Determines which webhook format will be used, Telnyx API v1 or v2.
      enum:
        - "1"
        - "2"
      example: "1"
      title: Webhook API Version
      type: string
    WebhookEventFailoverUrl:
      default: ""
      description: The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.
      example: https://failover.example.com
      format: url
      nullable: true
      title: Webhook Event Failover URL
      type: string
    WebhookEventUrl:
      description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
      example: https://example.com
      format: url
      title: Webhook Event URL
      type: string
    WebhookTimeoutSecs:
      default: null
      description: Specifies how many seconds to wait before timing out a webhook.
      example: 25
      maximum: 30
      minimum: 0
      nullable: true
      title: Webhook Timeout Secs
      type: integer
    WhatsAppContactAddress:
      example:
        city: Menlo Park
        country: United States
        country_code: us
        state: CA
        street: 1 Hacker Way
        type: HOME
        zip: "94025"
      properties:
        city:
          description: City name
          type: string
        country:
          description: Full country name
          type: string
        country_code:
          description: Two-letter country abbreviation
          type: string
        state:
          description: State abbreviation
          type: string
        street:
          description: Street number and name
          type: string
        type:
          description: "Standard Values: HOME, WORK"
          type: string
        zip:
          description: ZIP code
          type: string
      required:
        - city
        - country
        - country_code
        - state
        - street
        - type
        - zip
      title: Address
      type: object
    WhatsAppDetailRecordReport:
      properties:
        created_at:
          example: 2020-05-01T00:00:00-06:00
          format: date-time
          type: string
        download_link:
          example: https://portal-cdrs-usage.s3.amazonaws.com
          type: string
        end_date:
          example: 2020-05-01T00:00:00-06:00
          format: date-time
          type: string
        id:
          example: ab76c3b6-80cd-11eb-9439-0242ac130002
          type: string
        record_type:
          example: whatsapp_detail_record_report
          type: string
        start_date:
          example: 2020-05-01T00:00:00-06:00
          format: date-time
          type: string
        status:
          enum:
            - PENDING
            - COMPLETE
            - FAILED
            - EXPIRED
          type: string
      type: object
    WhatsAppDetailReportResponse:
      properties:
        data:
          $ref: "#/components/schemas/WhatsAppDetailRecordReport"
      type: object
    WhatsAppGetAllDetailReportResponse:
      properties:
        data:
          items:
            $ref: "#/components/schemas/WhatsAppDetailRecordReport"
          type: array
        meta:
          $ref: "#/components/schemas/PaginationMeta"
      type: object
    WhatsAppReportsReq:
      properties:
        end_date:
          example: 2021-05-01T00:00:00-06:00
          format: date-time
          type: string
        start_date:
          example: 2021-05-01T00:00:00-06:00
          format: date-time
          type: string
      required:
        - end_date
        - start_date
      type: object
    WhatsAppUsageAggregation:
      properties:
        cost:
          $ref: "#/components/schemas/Money"
        count:
          example: "3"
          type: string
        direction:
          example: inbound
          type: string
        message_type:
          example: template
          type: string
        recipient_country_code:
          example: "1"
          type: string
        record_type:
          example: whatsapp_usage_aggregation
          type: string
        status:
          example: delivered
          type: string
        telnyx_fee:
          $ref: "#/components/schemas/Money"
        whatsapp_fee:
          $ref: "#/components/schemas/Money"
      type: object
    WhatsAppUsageAggregationsResponseContainer:
      properties:
        data:
          items:
            $ref: "#/components/schemas/WhatsAppUsageAggregation"
          type: array
      type: object
    WhatsAppUser:
      description: The WhatsApp user object
      example:
        id: "15125551212"
        record_type: whatsapp_user
        webhook_url: https://mywebhook.com/example/endpoint
      properties:
        id:
          description: The WhatsApp User ID, usually a phone number.
          example: "15125551212"
          type: string
        record_type:
          description: Identifies the type of the resource.
          enum:
            - whatsapp_user
          readOnly: true
          type: string
        webhook_url:
          description: The URL that WhatsApp webhooks are sent to.
          example: https://mywebhook.com/example/endpoint
          title: Webhook Url
          type: string
      title: WhatsApp User
      type: object
    WirelessConnectivityLog:
      description: This object represents a wireless connectivity session log that happened through a SIM card. It aids in finding out potential problems when the SIM is not able to attach properly.
      properties:
        apn:
          description: The Access Point Name (APN) identifies the packet data network that a mobile data user wants to communicate with.
          example: data00.telnyx
          readOnly: true
          type: string
        id:
          description: Uniquely identifies the session.
          example: 137509451
          readOnly: true
          type: integer
        imei:
          description: The International Mobile Equipment Identity (or IMEI) is a number, usually unique, that identifies the device currently being used connect to the network.
          example: "490154203237518"
          readOnly: true
          type: string
        imsi:
          description: |
            SIM cards are identified on their individual operator networks by a unique International Mobile Subscriber Identity (IMSI). <br/>
            Mobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber  Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home  Location Register (HLR) or the Visitor Location Register (VLR).
          example: 81932214823362980
          readOnly: true
          type: string
        ipv4:
          description: |
            The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.
          example: 192.168.0.0
          readOnly: true
          type: string
        ipv6:
          description: |
            The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.
          example: 2001:cdba:0000:0000:0000:0000:3257:9652
          readOnly: true
          type: string
        log_type:
          description: The type of the session, 'registration' being the initial authentication session and 'data' the actual data transfer sessions.
          enum:
            - registration
            - data
          example: registration
          readOnly: true
          type: string
        mobile_country_code:
          description: |-
            It's a three decimal digit that identifies a country.<br/><br/>
            This code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.
          example: "310"
          readOnly: true
          type: string
        mobile_network_code:
          description: |-
            It's a two to three decimal digits that identify a network.<br/><br/>
             This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.
          example: "410"
          readOnly: true
          type: string
        radio_access_technology:
          description: The radio technology the SIM card used during the session.
          example: LTE
          readOnly: true
          type: string
        record_type:
          example: wireless_connectivity_log
          readOnly: true
          type: string
        sim_card_id:
          description: The identification UUID of the related SIM card resource.
          example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
          format: uuid
          type: string
        start_time:
          description: ISO 8601 formatted date-time indicating when the session started.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
        state:
          description: The state of the SIM card after when the session happened.
          example: provisioned
          readOnly: true
          type: string
        stop_time:
          description: ISO 8601 formatted date-time indicating when the session ended.
          example: 2018-02-02T22:25:27.521Z
          readOnly: true
          type: string
      title: WirelessConnectivityLog
      type: object
    WirelessCost:
      properties:
        amount:
          description: Final cost. Cost is calculated as rate * unit
          example: 0.1
          type: string
        currency:
          description: Currency of the rate and cost
          enum:
            - AUD
            - CAD
            - EUR
            - GBP
            - USD
          example: USD
          type: string
      type: object
    WirelessRate:
      properties:
        amount:
          description: Rate from which cost is calculated
          example: 0.1
          type: string
        currency:
          description: Currency of the rate and cost
          enum:
            - AUD
            - CAD
            - EUR
            - GBP
            - USD
          example: USD
          type: string
      type: object
    active:
      default: true
      description: The active status of the authentication provider
      example: true
      type: boolean
    address_book:
      default: true
      description: Indicates whether or not the address should be considered part of your list of addresses that appear for regular use.
      example: false
      type: boolean
    administrative_area:
      description: The locality of the address. For US addresses, this corresponds to the state of the address.
      example: IL
      type: string
    attempt:
      description: Webhook delivery attempt details.
      example:
        - finished_at: 2020-08-10T14:00:05.595Z
          http:
            request:
              headers:
                - "Accept: */*"
              url: https://fallback.example.com/webhooks
            response:
              body: All good.
              headers:
                - "Content-Type: text/html"
              status: 200
          started_at: 2020-08-10T14:00:05.364Z
          status: delivered
        - errors:
            - code: "75499"
              detail: The server returned another HTTP 4XX error
              title: Webhook host returned HTTP 4XX
          finished_at: 2020-08-10T14:00:05.360Z
          http:
            request:
              headers:
                - "Accept: */*"
              url: https://typo.example.com/webhooks
            response:
              body: Oops. Not found.
              headers:
                - "Content-Type: text/html"
                - "Pragma: no-cache"
              status: 404
          started_at: 2020-08-10T14:00:05.004Z
          status: failed
        - errors:
            - code: "75001"
              detail: Unable to resolve the webhook URL domain name
              title: Could not resolve name
          finished_at: 2020-08-10T14:00:05.000Z
          http:
            reponse: null
            request:
              headers:
                - "Accept: */*"
              url: https://slow.example.com/webhooks
          started_at: 2020-08-10T14:00:00.000Z
          status: failed
      properties:
        errors:
          description: Webhook delivery errors.
          items:
            $ref: "#/components/schemas/error"
          type: array
        finished_at:
          description: ISO 8601 timestamp indicating when the attempt has finished.
          format: date-time
          type: string
        http:
          $ref: "#/components/schemas/http"
        started_at:
          description: ISO 8601 timestamp indicating when the attempt was initiated.
          format: date-time
          type: string
        status:
          enum:
            - delivered
            - failed
          type: string
    borough:
      description: The borough of the address. This field is not used for addresses in the US but is used for some international addresses.
      example: Guadalajara
      type: string
    business_name:
      description: The business name associated with the address. An address must have either a first last name or a business name.
      example: Toy-O'Kon
      type: string
    country_code:
      description: The two-character (ISO 3166-1 alpha-2) country code of the address.
      example: US
      type: string
    customer_reference:
      description: A customer reference string for customer look ups.
      example: MY REF 001
      type: string
    error:
      properties:
        code:
          format: int
          type: string
        detail:
          type: string
        title:
          type: string
    extended_address:
      description: Additional street address information about the address such as, but not limited to, unit number or apartment number.
      example: "#504"
      type: string
    first_name:
      description: The first name associated with the address. An address must have either a first last name or a business name.
      example: Alfred
      type: string
    http:
      description: HTTP request and response information.
      properties:
        request:
          description: Request details.
          properties:
            headers:
              $ref: "#/components/schemas/http_headers"
            url:
              example: https://example.com/webhooks
              type: string
        response:
          description: Response details, optional.
          nullable: true
          properties:
            body:
              description: Raw response body, limited to 10kB.
              type: string
            headers:
              $ref: "#/components/schemas/http_headers"
            status:
              example: 200
              type: integer
    http_headers:
      description: List of headers, limited to 10kB.
      items:
        example: "Header-Name: header value"
        type: string
      type: array
    last_name:
      description: The last name associated with the address. An address must have either a first last name or a business name.
      example: Foster
      type: string
    locality:
      description: The locality of the address. For US addresses, this corresponds to the city of the address.
      example: Chicago
      type: string
    name:
      description: The name associated with the authentication provider.
      example: Okta
      type: string
    neighborhood:
      description: The neighborhood of the address. This field is not used for addresses in the US but is used for some international addresses.
      example: Ciudad de los deportes
      type: string
    organization_id:
      description: The id from the Organization the authentication provider belongs to.
      example: 24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7
      format: uuid
      type: string
    phone_number:
      description: The phone number associated with the address.
      example: "+12125559000"
      type: string
    postal_code:
      description: The postal code of the address.
      example: "60654"
      type: string
    settings:
      description: The settings associated with the authentication provider.
      properties:
        idp_cert_fingerprint:
          description: The certificate fingerprint for the identity provider (IdP)
          example: 13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7
          type: string
        idp_cert_fingerprint_algorithm:
          default: sha1
          description: The algorithm used to generate the identity provider's (IdP) certificate fingerprint
          enum:
            - sha1
            - sha256
            - sha384
            - sha512
          example: sha256
          type: string
        idp_entity_id:
          description: The Entity ID for the identity provider (IdP).
          example: https://myorg.myidp.com/saml/metadata
          type: string
        idp_sso_target_url:
          description: The SSO target url for the identity provider (IdP).
          example: https://myorg.myidp.com/trust/saml2/http-post/sso
          type: string
      required:
        - idp_entity_id
        - idp_sso_target_url
        - idp_cert_fingerprint
      type: object
    settings_url:
      description: The URL for the identity provider metadata file to populate the settings automatically. If the settings attribute is provided, that will be used instead.
      example: https://myorg.myidp.com/saml/metadata
      type: string
    short_name:
      description: The short name associated with the authentication provider. This must be unique and URL-friendly, as it's going to be part of the login URL.
      example: myorg
      type: string
    street_address:
      description: The primary street address information about the address.
      example: 311 W Superior Street
      type: string
    validate_address:
      default: true
      description: Indicates whether or not the address should be validated for emergency use upon creation or not. This should be left with the default value of `true` unless you have used the `/addresses/actions/validate` endpoint to validate the address separately prior to creation. If an address is not validated for emergency use upon creation and it is not valid, it will not be able to be used for emergency services.
      example: true
      type: boolean
    webhook_delivery:
      description: Record of all attempts to deliver a webhook.
      properties:
        attempts:
          description: Detailed delivery attempts, ordered by most recent.
          example:
            - finished_at: 2020-08-10T14:00:05.595Z
              http:
                request:
                  headers:
                    - "Accept: */*"
                  url: https://fallback.example.com/webhooks
                response:
                  body: All good.
                  headers:
                    - "Content-Type: text/html"
                  status: 200
              started_at: 2020-08-10T14:00:05.364Z
              status: delivered
            - errors:
                - code: "75499"
                  detail: The server returned another HTTP 4XX error
                  title: Webhook host returned HTTP 4XX
              finished_at: 2020-08-10T14:00:05.360Z
              http:
                request:
                  headers:
                    - "Accept: */*"
                  url: https://typo.example.com/webhooks
                response:
                  body: Oops. Not found.
                  headers:
                    - "Content-Type: text/html"
                    - "Pragma: no-cache"
                  status: 404
              started_at: 2020-08-10T14:00:05.004Z
              status: failed
          items:
            $ref: "#/components/schemas/attempt"
          type: array
        finished_at:
          description: ISO 8601 timestamp indicating when the last webhook response has been received.
          example: 2020-08-10T14:00:05.595Z
          format: date-time
          type: string
        id:
          description: Uniquely identifies the webhook_delivery record.
          example: f5586561-8ff0-4291-a0ac-84fe544797bd
          format: uuid
          type: string
        record_type:
          description: Identifies the type of the resource.
          example: webhook_delivery
          type: string
        started_at:
          description: ISO 8601 timestamp indicating when the first request attempt was initiated.
          example: 2020-08-10T14:00:00.000Z
          format: date-time
          type: string
        status:
          description: "Delivery status: 'delivered' when successfuly delivered or 'failed' if all attempts have failed."
          enum:
            - delivered
            - failed
          type: string
        user_id:
          description: Uniquely identifies the user that owns the webhook_delivery record.
          example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
          format: uuid
          type: string
        webhook:
          description: Original webhook JSON data. Payload fields vary according to event type.
          example:
            event_type: call_initiated
            id: C9C0797E-901D-4349-A33C-C2C8F31A92C2
            occurred_at: 2020-08-10T13:02:01.000Z
            payload:
              useful: information
            record_type: event
          properties:
            event_type:
              description: The type of event being delivered.
              enum:
                - webhook.command
              example: webhook.command
              type: string
            id:
              description: Identifies the type of resource.
              example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0
              format: uuid
              type: string
            occurred_at:
              description: ISO 8601 datetime of when the event occurred.
              example: 2018-02-02T22:25:27.521992Z
              format: date-time
              type: string
            payload:
              properties: {}
              type: object
            record_type:
              description: Identifies the type of the resource.
              enum:
                - event
              example: event
              type: string
          type: object
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http
    bearerAuth:
      scheme: bearer
      type: http
