Telnyx MCP Server

components: callbacks: {} examples: Maximum20JobsAllowed: value: errors: - code: '10015' detail: You can have at most 20 pending or in progress jobs meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /base title: Bad Request MaximumAllowedPhoneNumbers: value: errors: - code: '10015' detail: 1000 numbers is the maximum allowed. meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /phone_numbers title: Bad Request MinimumAllowedPhoneNumbers: value: errors: - code: '10015' detail: You must provide at least 1 phone number. meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /phone_numbers title: Bad Request MixedIdsAndE164Values: value: errors: - code: '10015' detail: You must specify either all phone numbers in the e164 format or all as phone number ids meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /phone_numbers title: Bad Request NotAuthorized: value: errors: - code: '10006' detail: You are not authorized to access the requested resource. meta: url: https://developers.telnyx.com/docs/overview/errors/10006 title: Not authorized PhoneNumberOwnership: value: errors: - code: '10015' detail: You must own every number in the bulk request meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /phone_numbers title: Bad Request PhoneNumbersMustBePresent: value: errors: - code: '10015' detail: must be present meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /phone_numbers title: Bad Request headers: {} links: {} parameters: 10dlc_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[telnyx_campaign_id], filter[telnyx_brand_id], filter[tcr_campaign_id], filter[tcr_brand_id]' explode: true in: query name: filter schema: properties: tcr_brand_id: description: Filter results by the TCR Brand id example: BRANDID type: string tcr_campaign_id: description: Filter results by the TCR Campaign id example: CAMPID3 type: string telnyx_brand_id: description: Filter results by the Telnyx Brand id example: f3575e15-32ce-400e-a4c0-dd78800c20b0 format: uuid type: string telnyx_campaign_id: description: Filter results by the Telnyx Campaign id example: f3575e15-32ce-400e-a4c0-dd78800c20b0 format: uuid type: string type: object style: deepObject AccountSid: description: The id of the account the resource belongs to. in: path name: account_sid required: true schema: type: string ApplicationId: description: The ID of the TeXML application used for the call. in: path name: application_id required: true schema: type: string AuthorizationBearer: description: 'Format: Bearer <TOKEN>' in: header name: authorization_bearer schema: description: Authenticates the request with your Telnyx API V2 KEY type: string BundleId: in: path name: bundle_id required: true schema: description: Billing bundle's ID, this is used to identify the billing bundle in the API. example: 8661948c-a386-4385-837f-af00f40f111a format: uuid title: Bundle Id type: string CallControlId: description: Unique identifier and token for controlling the call in: path name: call_control_id required: true schema: type: string CallSid: description: The CallSid that identifies the call to update. in: path name: call_sid required: true schema: type: string CallSidOrParticipantLabel: description: CallSid or Label of the Participant to update. in: path name: call_sid_or_participant_label required: true schema: type: string ConferenceSid: description: The ConferenceSid that uniquely identifies a conference. in: path name: conference_sid required: true schema: type: string ConferenceStatus: description: Filters conferences by status. example: in-progress in: query name: Status required: false schema: enum: - init - in-progress - completed type: string ConnectionId: description: Telnyx connection id in: path name: connection_id required: true schema: example: '1293384261075731461' type: string DateCreated: description: Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateCreated>=2023-05-22. example: '>=2023-05-22' in: query name: DateCreated required: false schema: type: string DateUpdated: description: Filters conferences by the time they were last updated. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateUpdated>=2023-05-22. example: '>=2023-05-22' in: query name: DateUpdated required: false schema: 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 EndTime: description: Filters calls by their end date. Expected format is YYYY-MM-DD example: '2023-05-22' in: query name: EndTime required: false schema: type: string EndTime_gt: description: Filters calls by their end date (after). Expected format is YYYY-MM-DD example: '2023-05-22' in: query name: EndTime_gt required: false schema: type: string EndTime_lt: description: Filters calls by their end date (before). Expected format is YYYY-MM-DD example: '2023-05-22' in: query name: EndTime_lt required: false schema: type: string FilterAddressByAdministrativeArea: description: Filter by state or province where the address is located. in: query name: filter[address.administrative_area] schema: example: TX 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: 14th Floor type: string FilterAddressById: description: Uniquely identifies the address for the order. in: query name: filter[address.id] schema: example: '1293384261075731499' type: string FilterAddressByLocality: description: Filter by the name of the city where the address is located. in: query name: filter[address.locality] schema: example: Austin type: string FilterAddressByPostalCode: description: Filter by postal code for the address. in: query name: filter[address.postal_code] schema: example: '78701' 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: 600 Congress Avenue 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 FilterBulkSIMCardActionId: description: Filter by a bulk SIM card action ID. in: query name: filter[bulk_sim_card_action_id] required: false schema: example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9 format: uuid type: string FilterCivicAddressesConsolidated: description: Filter parameter for civic addresses (deepObject style). Supports filtering by country. explode: true in: query name: filter schema: properties: country: description: The country (or countries) to filter addresses by. example: - US - CA - MX - BR items: description: The ISO 3166-1 alpha-2 country code (2 characters) type: string type: array type: object style: deepObject FilterConnectionsConsolidated: description: Filter parameter for external connections (deepObject style). Supports filtering by connection_name, external_sip_connection, id, created_at, and phone_number. explode: true in: query name: filter schema: properties: connection_name: properties: contains: default: null 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. example: My Connection type: string type: object created_at: default: null description: If present, connections with <code>created_at</code> date matching the given YYYY-MM-DD date will be returned. example: '2022-12-31' type: string external_sip_connection: description: If present, connections with <code>external_sip_connection</code> matching the given value will be returned. enum: - zoom - operator_connect example: zoom type: string id: default: null description: If present, connections with <code>id</code> matching the given value will be returned. example: '1930241863466354012' type: string phone_number: description: 'Phone number filter for connections. Note: Despite the ''contains'' name, this requires a full E164 match per the original specification.' properties: contains: description: If present, connections associated with the given phone_number will be returned. A full match is necessary with a e164 format. example: '+15555555555' type: string type: object type: object style: deepObject FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[customer_reference][eq], filter[customer_reference][contains], filter[used_as_emergency], filter[street_address][contains], filter[address_book][eq]' explode: true in: query name: filter schema: properties: address_book: properties: eq: description: If present, only returns results with the <code>address_book</code> flag equal to the given value. type: string type: object customer_reference: oneOf: - description: If present, addresses with <code>customer_reference</code> containing the given value will be returned. Matching is not case-sensitive. type: string - properties: contains: description: Partial match for customer_reference. Matching is not case-sensitive. type: string eq: description: Exact match for customer_reference. type: string type: object street_address: properties: contains: 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. type: string type: object used_as_emergency: 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.' type: string type: object style: deepObject 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: date-time type: string FilterDocumentLinksConsolidated: description: 'Consolidated filter parameter for document links (deepObject style). Originally: filter[linked_record_type], filter[linked_resource_id]' explode: true in: query name: filter required: false schema: additionalProperties: false properties: linked_record_type: description: The linked_record_type of the document to filter on. example: porting_order type: string linked_resource_id: description: The linked_resource_id of the document to filter on. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string type: object style: deepObject FilterDocumentsConsolidated: description: 'Consolidated filter parameter for documents (deepObject style). Originally: filter[filename][contains], filter[customer_reference][eq], filter[customer_reference][in][], filter[created_at][gt], filter[created_at][lt]' explode: true in: query name: filter required: false schema: additionalProperties: false example: created_at: gt: '2021-01-01T00:00:00Z' customer_reference: in: - REF001 - REF002 filename: contains: invoice properties: created_at: additionalProperties: false properties: gt: description: Filter by created at greater than provided value. example: '2021-04-09T22:25:27.521Z' format: date-time type: string lt: description: Filter by created at less than provided value. example: '2021-04-09T22:25:27.521Z' format: date-time type: string type: object customer_reference: additionalProperties: false properties: eq: description: Filter documents by a customer reference. example: MY REF 001 type: string in: description: Filter documents by a list of customer references. example: - MY REF 001 - MY REF 002 items: type: string type: array type: object filename: additionalProperties: false properties: contains: description: Filter by string matching part of filename. example: invoice type: string type: object type: object style: deepObject FilterLogMessagesConsolidated: description: Filter parameter for log messages (deepObject style). Supports filtering by external_connection_id and telephone_number with eq/contains operations. explode: true in: query name: filter schema: properties: external_connection_id: description: The external connection ID to filter by or "null" to filter for logs without an external connection ID example: 67ea7693-9cd5-4a68-8c76-abb3aa5bf5d2 type: string telephone_number: description: Telephone number filter operations for log messages. Use 'eq' for exact matches or 'contains' for partial matches. properties: contains: description: The partial phone number to filter log messages for. Requires 3-15 digits. example: '+123' type: string eq: description: The phone number to filter log messages for or "null" to filter for logs without a phone number example: '+1234567890' format: E164 type: string type: object type: object style: deepObject FilterMobileNetworkOperatorsConsolidated: description: 'Consolidated filter parameter for mobile network operators (deepObject style). Originally: filter[name][starts_with], filter[name][contains], filter[name][ends_with], filter[country_code], filter[mcc], filter[mnc], filter[tadig], filter[network_preferences_enabled]' explode: true in: query name: filter schema: properties: country_code: description: Filter by exact country_code. example: US type: string mcc: description: Filter by exact MCC. example: '310' type: string mnc: description: Filter by exact MNC. example: '410' type: string name: description: Advanced name filtering operations properties: contains: description: Filter by name containing match. example: T&T type: string ends_with: description: Filter by name ending with. example: T type: string starts_with: description: Filter by name starting with. example: AT type: string type: object network_preferences_enabled: description: Filter by network_preferences_enabled. example: true type: boolean tadig: description: Filter by exact TADIG. example: USACG type: string type: object style: deepObject FilterOTAUpdatesConsolidated: description: 'Consolidated filter parameter for OTA updates (deepObject style). Originally: filter[status], filter[sim_card_id], filter[type]' explode: true in: query name: filter schema: properties: sim_card_id: description: The SIM card identification UUID. type: string status: description: Filter by a specific status of the resource's lifecycle. enum: - in-progress - completed - failed example: in-progress type: string type: description: Filter by type. enum: - sim_card_network_preferences example: sim_card_network_preferences type: string type: object style: deepObject FilterPhoneNumbersConsolidated: description: Filter parameter for phone numbers (deepObject style). Supports filtering by phone_number, civic_address_id, and location_id with eq/contains operations. explode: true in: query name: filter required: false schema: properties: civic_address_id: properties: eq: description: The civic address ID to filter by example: '19990261512338516954' type: string type: object location_id: properties: eq: description: The location ID to filter by example: '19995665508264022121' type: string type: object phone_number: properties: contains: description: The phone number to filter by (partial match) example: '+1970' type: string eq: description: The phone number to filter by (exact match) example: '+19705555098' type: string type: object type: object style: deepObject FilterQuantity: description: Filter orders by how many SIM cards were ordered. in: query name: filter[quantity] schema: example: 21 type: integer FilterReleasesConsolidated: description: Filter parameter for releases (deepObject style). Supports filtering by status, civic_address_id, location_id, and phone_number with eq/contains operations. explode: true in: query name: filter schema: properties: civic_address_id: properties: eq: description: The civic address ID to filter by example: '19990261512338516954' type: string type: object location_id: properties: eq: description: The location ID to filter by example: '19995665508264022121' type: string type: object phone_number: description: Phone number filter operations. Use 'eq' for exact matches or 'contains' for partial matches. properties: contains: description: The partial phone number to filter by. Requires 3-15 digits. example: '+123' type: string eq: description: The phone number to filter by example: '+1234567890' format: E164 type: string type: object status: properties: eq: description: The status of the release to filter by example: - pending - in_progress items: enum: - pending_upload - pending - in_progress - complete - failed - expired - unknown type: string type: array type: object type: object style: deepObject FilterRequirementTypesConsolidated: description: 'Consolidated filter parameter for requirement types (deepObject style). Originally: filter[name]' explode: true in: query name: filter required: false schema: additionalProperties: false properties: name: additionalProperties: false properties: contains: description: Filters requirement types to those whose name contains a certain string. example: utility bill type: string type: object type: object style: deepObject FilterRequirementsConsolidated: description: 'Consolidated filter parameter for requirements (deepObject style). Originally: filter[country_code], filter[phone_number_type], filter[action]' explode: true in: query name: filter required: false schema: additionalProperties: false properties: action: description: Filters requirements to those applying to a specific action. enum: - branded_calling - ordering - porting example: porting type: string country_code: description: Filters results to those applying to a 2-character (ISO 3166-1 alpha-2) country code example: US type: string phone_number_type: description: Filters results to those applying to a specific phone_number_type enum: - local - national - toll_free example: local type: string type: object style: deepObject FilterSIMCardActionsConsolidated: description: 'Consolidated filter parameter for SIM card actions (deepObject style). Originally: filter[sim_card_id], filter[status], filter[bulk_sim_card_action_id], filter[action_type]' explode: true in: query name: filter schema: properties: action_type: description: Filter by action type. enum: - enable - enable_standby_sim_card - disable - set_standby - remove_public_ip - set_public_ip example: disable type: string bulk_sim_card_action_id: description: Filter by a bulk SIM card action ID. example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9 format: uuid type: string sim_card_id: description: A valid SIM card ID. example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9 format: uuid type: string status: description: Filter by a specific status of the resource's lifecycle. enum: - in-progress - completed - failed example: in-progress type: string type: object style: deepObject FilterSIMCardConsolidated: description: 'Consolidated filter parameter for SIM cards (deepObject style). Originally: filter[tags], filter[iccid], filter[status]' explode: true in: query name: filter schema: properties: iccid: description: A search string to partially match for the SIM card's ICCID. example: '89310410106543789301' type: string status: description: Filter by a SIM card's status. items: enum: - enabled - disabled - standby - data_limit_exceeded - unauthorized_imei type: string type: array tags: description: "A list of SIM card tags to filter on.<br/><br/>\n If the\ \ SIM card contains <b><i>all</i></b> of the given <code>tags</code>\ \ they will be found.<br/><br/>\nFor example, if the SIM cards have\ \ the following tags: <ul>\n <li><code>['customers', 'staff', 'test']</code>\n\ \ <li><code>['test']</code></li>\n <li><code>['customers']</code></li>\n\ </ul>\nSearching 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/>\n" example: - personal - customers - active-customers items: type: string type: array type: object style: deepObject 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 FilterSIMCardId: description: A valid SIM card ID. in: query name: filter[sim_card_id] schema: example: 47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9 format: uuid type: string FilterSIMCardOrdersConsolidated: description: 'Consolidated filter parameter for SIM card orders (deepObject style). Originally: filter[created_at], filter[updated_at], filter[quantity], filter[cost.amount], filter[cost.currency], filter[address.id], filter[address.street_address], filter[address.extended_address], filter[address.locality], filter[address.administrative_area], filter[address.country_code], filter[address.postal_code]' explode: true in: query name: filter schema: properties: address: properties: administrative_area: description: Filter by state or province where the address is located. example: TX type: string country_code: description: Filter by the mobile operator two-character (ISO 3166-1 alpha-2) origin country code. example: US type: string extended_address: description: Returns entries with matching name of the supplemental field for address information. example: 14th Floor type: string id: description: Uniquely identifies the address for the order. example: '1293384261075731499' type: string locality: description: Filter by the name of the city where the address is located. example: Austin type: string postal_code: description: Filter by postal code for the address. example: '78701' type: string street_address: description: Returns entries with matching name of the street where the address is located. example: 600 Congress Avenue type: string type: object cost: properties: amount: description: The total monetary amount of the order. example: '2.53' type: string currency: description: Filter by ISO 4217 currency string. example: USD type: string type: object created_at: description: Filter by ISO 8601 formatted date-time string matching resource creation date-time. example: '2018-02-02T22:25:27.521Z' format: date-time type: string quantity: description: Filter orders by how many SIM cards were ordered. example: 21 type: integer updated_at: description: Filter by ISO 8601 formatted date-time string matching resource last update date-time. example: '2018-02-02T22:25:27.521Z' format: date-time type: string type: object style: deepObject 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: date-time type: string FilterUploadsConsolidated: description: Filter parameter for uploads (deepObject style). Supports filtering by status, civic_address_id, location_id, and phone_number with eq/contains operations. explode: true in: query name: filter required: false schema: properties: civic_address_id: properties: eq: description: The civic address ID to filter by example: '19990261512338516954' type: string type: object location_id: properties: eq: description: The location ID to filter by example: '19995665508264022121' type: string type: object phone_number: properties: contains: description: The phone number to filter by (partial match) example: '+1970' type: string eq: description: The phone number to filter by (exact match) example: '+19705555098' type: string type: object status: properties: eq: description: The status of the upload to filter by example: - pending_upload - pending items: enum: - pending_upload - pending - in_progress - success - error type: string type: array type: object type: object style: deepObject FqdnId: description: Identifies the resource. in: path name: id required: true schema: example: '1517907029795014409' format: int64 type: string FriendlyName: description: Filters conferences by their friendly name. example: weekly_review_call in: query name: FriendlyName required: false schema: type: string From: description: Filters calls by the from number. example: '+1312345678' in: query name: From required: false schema: type: string GcbChannelNumberZoneId: description: Channel zone identifier in: path name: channel_zone_id required: true schema: type: string GcbChannelZoneId: description: Channel zone identifier in: path name: channel_zone_id required: true schema: type: string GcbPhoneNumber: description: The phone number to be looked up in: path name: phone_number required: true schema: example: '+15554441234' type: string Id: description: Identifies the resource. in: path name: id required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string IncludeCancelledAccounts: description: Specifies if cancelled accounts should be included in the results. in: query name: include_cancelled_accounts required: false schema: default: false example: true type: boolean IncludeICCIDs: description: It includes a list of associated ICCIDs. in: query name: include_iccids 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' 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 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 NumberLookupType: description: Specifies the type of number lookup to be performed in: query name: type required: false schema: enum: - carrier - caller-name type: string Page: description: The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken. example: 1 in: query name: Page required: false schema: type: integer PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject PageNumber: description: The page number to load. in: query name: page[number] schema: default: 1 minimum: 1 type: integer PageSize: description: The number of records to be displayed on a page example: 10 in: query name: PageSize required: false schema: type: integer PageSizeTexml: description: The number of records to be displayed on a page example: 10 in: query name: PageSize required: false schema: type: integer PageToken: description: Used to request the next page of results. in: query name: PageToken required: false schema: type: string PathCommentID: description: Comment id in: path name: id required: true schema: type: string PathCustomerServiceRecordId: description: The ID of the customer service record in: path name: customer_service_record_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 PrivateWirelessGatewayId: description: Identifies the private wireless gateway. in: path name: id required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid 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 RecordingId: description: Uniquely identifies the recording by id. in: path name: recording_id required: true schema: type: string RecordingSid: description: Uniquely identifies the recording by id. in: path name: recording_sid required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string RecordingTranscriptionId: description: Uniquely identifies the recording transcription by id. in: path name: recording_transcription_id required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string RecordingTranscriptionSid: description: Uniquely identifies the recording transcription by id. in: path name: recording_transcription_sid required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string ResourceId: description: Identifies the resource. in: path name: id required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string SIMCardGroupId: description: Identifies the SIM group. in: path name: id required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string SIMCardId: description: Identifies the SIM. in: path name: 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 SiprecConnectorName: description: Uniquely identifies a SIPREC connector. in: path name: connector_name required: true schema: type: string SiprecSid: description: The SiprecSid that uniquely identifies the Sip Recording. in: path name: siprec_sid required: true schema: type: string Sort: description: Set the order of the results by the creation date. in: query name: sort required: false schema: enum: - asc - desc example: desc 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/>\nThat is: <ul>\n <li>\n <code>street_address</code>:\ \ sorts the result by the\n <code>street_address</code> field in ascending\ \ order.\n </li>\n\n <li>\n <code>-street_address</code>: sorts the result\ \ by the\n <code>street_address</code> field in descending order.\n </li>\n\ </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 SortApplication: 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/>\nThat is: <ul>\n <li>\n <code>friendly_name</code>:\ \ sorts the result by the\n <code>friendly_name</code> field in ascending\ \ order.\n </li>\n\n <li>\n <code>-friendly_name</code>: sorts the result\ \ by the\n <code>friendly_name</code> field in descending order.\n </li>\n\ </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 - friendly_name - active example: friendly_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/>\nThat is: <ul>\n <li>\n <code>connection_name</code>:\ \ sorts the result by the\n <code>connection_name</code> field in ascending\ \ order.\n </li>\n\n <li>\n <code>-connection_name</code>: sorts the\ \ result by the\n <code>connection_name</code> field in descending order.\n\ \ </li>\n</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 - connection_name - active example: connection_name type: string SortDocumentsConsolidated: description: 'Consolidated sort parameter for documents (deepObject style). Originally: sort[]' in: query name: sort required: false schema: 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. example: - filename items: enum: - filename - created_at - updated_at - -filename - -created_at - -updated_at type: string type: array 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/>\nThat is: <ul>\n <li>\n <code>name</code>: sorts the\ \ result by the\n <code>name</code> field in ascending order.\n </li>\n\ \n <li>\n <code>-name</code>: sorts the result by the\n <code>name</code>\ \ field in descending order.\n </li>\n</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 SortRequirementTypesConsolidated: description: 'Consolidated sort parameter for requirement types (deepObject style). Originally: sort[]' in: query name: sort required: false schema: 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. example: - name items: enum: - name - created_at - updated_at - -name - -created_at - -updated_at type: string type: array SortRequirementsConsolidated: description: 'Consolidated sort parameter for requirements (deepObject style). Originally: sort[]' in: query name: sort required: false schema: 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. example: - country_code items: enum: - created_at - updated_at - country_code - phone_number_type - -created_at - -updated_at - -country_code - -phone_number_type type: string type: array SortUserAddress: 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/>\nThat is: <ul>\n <li>\n <code>street_address</code>:\ \ sorts the result by the\n <code>street_address</code> field in ascending\ \ order.\n </li>\n\n <li>\n <code>-street_address</code>: sorts the result\ \ by the\n <code>street_address</code> field in descending order.\n </li>\n\ </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 StartTime: description: Filters calls by their start date. Expected format is YYYY-MM-DD. example: '2023-05-22' in: query name: StartTime required: false schema: type: string StartTime_gt: description: Filters calls by their start date (after). Expected format is YYYY-MM-DD example: '2023-05-22' in: query name: StartTime_gt required: false schema: type: string StartTime_lt: description: Filters calls by their start date (before). Expected format is YYYY-MM-DD example: '2023-05-22' in: query name: StartTime_lt required: false schema: type: string Status: description: Filters calls by status. example: no-answer in: query name: Status required: false schema: enum: - canceled - completed - failed - busy - no-answer type: string StreamingSid: description: Uniquely identifies the streaming by id. in: path name: streaming_sid required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string TexmlDateCreated: description: Filters recording by the creation date. Expected format is ISO8601 date or date-time, ie. {YYYY}-{MM}-{DD} or {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}Z. Also accepts inequality operators, e.g. DateCreated>=2023-05-22. in: query name: DateCreated required: false schema: example: '2023-05-22' format: date-time type: string To: description: Filters calls by the to number. example: '+1312345678' in: query name: To required: false schema: type: string UserBundleId: in: path name: user_bundle_id required: true schema: description: User bundle's ID, this is used to identify the user bundle in the API. example: ca1d2263-d1f1-43ac-ba53-248e7a4bb26a format: uuid title: User Bundle Id type: string UserId: description: User identifier in: path name: user_id required: true schema: type: string WirelessBlocklistId: description: Identifies the wireless blocklist. in: path name: id required: true schema: example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string address_id: description: Identifies a civic address or a location. in: path name: address_id required: true schema: example: 318fb664-d341-44d2-8405-e6bfb9ced6d9 format: uuid type: string audit-logs_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[created_before], filter[created_after]' explode: true in: query name: filter schema: properties: created_after: description: Filter for audit events created after a specific date. example: '2021-01-01T00:00:00Z' format: date-time type: string created_before: description: Filter for audit events created before a specific date. example: '2021-01-01T00:00:00Z' format: date-time type: string type: object style: deepObject audit-logs_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: description: Page number to load. example: 1 type: integer size: description: Number of items per page. example: 10 type: integer type: object style: deepObject bundle-pricing_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Supports filtering by country_iso and resource. Examples: filter[country_iso]=US or filter[resource]=+15617819942' explode: true in: query name: filter schema: properties: country_iso: description: Filter by country code. items: example: US type: string title: Filter[Country Iso] type: array resource: description: Filter by resource. items: description: Filter by resource. example: '+15617819942' type: string title: Filter[Resource] type: array type: object style: deepObject bundle-pricing_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load. minimum: 1 type: integer size: default: 20 description: The size of the page. maximum: 250 minimum: 1 type: integer type: object style: deepObject call-control_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound.outbound_voice_profile_id], filter[leg_id], filter[application_session_id], filter[connection_id], filter[product], filter[failed], filter[from], filter[to], filter[name], filter[type], filter[occurred_at][eq/gt/gte/lt/lte], filter[status]' explode: true in: query name: filter schema: properties: application_name: additionalProperties: false description: Application name filters properties: contains: default: 'null' 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. type: string type: object application_session_id: description: The unique identifier of the call session. A session may include multiple call leg events. format: uuid type: string connection_id: description: The unique identifier of the conection. type: string failed: description: Delivery failed or not. example: false type: boolean from: description: Filter by From number. example: '+12025550142' type: string leg_id: description: The unique identifier of an individual call leg. format: uuid type: string name: description: If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive type: string occurred_at: additionalProperties: false description: Event occurred_at filters properties: eq: description: 'Event occurred_at: equal' example: '2019-03-29T11:10:00Z' type: string gt: description: 'Event occurred_at: greater than' example: '2019-03-29T11:10:00Z' type: string gte: description: 'Event occurred_at: greater than or equal' example: '2019-03-29T11:10:00Z' type: string lt: description: 'Event occurred_at: lower than' example: '2019-03-29T11:10:00Z' type: string lte: description: 'Event occurred_at: lower than or equal' example: '2019-03-29T11:10:00Z' type: string type: object outbound.outbound_voice_profile_id: description: Identifies the associated outbound voice profile. example: '1293384261075731499' format: int64 type: string product: description: Filter by product. enum: - call_control - fax - texml example: texml type: string status: description: If present, conferences will be filtered by status. enum: - init - in_progress - completed type: string to: description: Filter by To number. example: '+12025550142' type: string type: description: Event type enum: - command - webhook example: webhook type: string type: object style: deepObject call-control_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]' explode: true in: query name: page schema: properties: after: default: 'null' description: Opaque identifier of next page type: string before: default: 'null' description: Opaque identifier of previous page type: string limit: default: 20 description: Limit of records per single page maximum: 250 minimum: 1 type: integer number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject call-recordings_ConnectionId: description: Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource. in: path name: connection_id required: true schema: type: string call-recordings_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load. minimum: 1 type: integer size: default: 20 description: The size of the page. maximum: 250 minimum: 1 type: integer type: object style: deepObject call-scripting_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[outbound_voice_profile_id], filter[friendly_name]' explode: true in: query name: filter schema: properties: friendly_name: default: 'null' 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. type: string outbound_voice_profile_id: description: Identifies the associated outbound voice profile. example: '1293384261075731499' type: string type: object style: deepObject call-scripting_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 250 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject connections_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]' explode: true in: query name: filter schema: properties: connection_name: description: Filter by connection_name using nested operations properties: contains: default: null 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. type: string type: object fqdn: default: null description: If present, connections with an `fqdn` that equals the given value will be returned. Matching is case-sensitive, and the full string must match. type: string outbound_voice_profile_id: description: Identifies the associated outbound voice profile. example: '1293384261075731499' format: int64 type: string type: object style: deepObject connections_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 250 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject connections_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/>\nThat is: <ul>\n <li>\n <code>connection_name</code>:\ \ sorts the result by the\n <code>connection_name</code> field in ascending\ \ order.\n </li>\n\n <li>\n <code>-connection_name</code>: sorts the\ \ result by the\n <code>connection_name</code> field in descending order.\n\ \ </li>\n</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 connections_id: description: Identifies the resource. in: path name: id required: true schema: example: '1293384261075731499' format: int64 type: string customer_service_record_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number][eq], filter[phone_number][in][], filter[status][eq], filter[status][in][], filter[created_at][lt], filter[created_at][gt]' explode: true in: query name: filter schema: properties: created_at: properties: gt: description: Filters records to those created after a specific date. example: '2020-01-01T00:00:00Z' format: date-time type: string lt: description: Filters records to those created before a specific date. example: '2020-01-01T00:00:00Z' format: date-time type: string type: object phone_number: properties: eq: description: Filters records to those with a specified number. example: '+12441239999' type: string in: description: Filters records to those with at least one number in the list. items: example: '+12441239999' type: string type: array type: object status: properties: eq: description: Filters records to those with a specific status. enum: - pending - completed - failed example: pending type: string in: description: Filters records to those with a least one status in the list. items: enum: - pending - completed - failed example: pending type: string type: array type: object type: object style: deepObject customer_service_record_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject documents_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject emergency_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject external-voice-integrations_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 250 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject external-voice-integrations_id: description: Identifies the resource. in: path name: id required: true schema: example: '1293384261075731499' format: int64 type: string id: description: Identifies the resource. in: path name: id required: true schema: example: '1293384261075731499' type: string managed-accounts_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[email][contains], filter[email][eq], filter[organization_name][contains], filter[organization_name][eq]' explode: true in: query name: filter required: false schema: additionalProperties: false example: email: contains: john organization_name: eq: Example Company LLC properties: email: additionalProperties: false properties: contains: description: If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. type: string eq: description: If present, only returns results with the <code>email</code> matching exactly the value given. type: string type: object organization_name: additionalProperties: false properties: contains: description: If present, only returns results with the <code>organization_name</code> containing the given value. Matching is not case-sensitive. Requires at least three characters. type: string eq: description: If present, only returns results with the <code>organization_name</code> matching exactly the value given. type: string type: object type: object style: deepObject managed-accounts_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/>\nThat is: <ul>\n <li>\n <code>email</code>:\ \ sorts the result by the\n <code>email</code> field in ascending order.\n\ \ </li>\n\n <li>\n <code>-email</code>: sorts the result by the\n \ \ <code>email</code> field in descending order.\n </li>\n</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 media-streaming_ConnectionId: description: Uniquely identifies a Telnyx application (Call Control). in: path name: connection_id required: true schema: type: string netapps_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[timestamp][gt], filter[timestamp][lt]' explode: true in: query name: filter schema: additionalProperties: false properties: timestamp: oneOf: - description: Filter by exact timestamp example: '2019-01-01T00:00:00.000Z' format: date-time type: string - additionalProperties: false description: Timestamp filtering operations properties: gt: description: Filter by timestamp greater than format: date-time type: string lt: description: Filter by timestamp less than format: date-time type: string type: object type: object style: deepObject notifications_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[associated_record_type][eq], filter[channel_type_id][eq], filter[notification_profile_id][eq], filter[notification_channel][eq], filter[notification_event_condition_id][eq], filter[status][eq]' explode: true in: query name: filter required: false schema: properties: associated_record_type: properties: eq: description: Filter by the associated record type enum: - account - phone_number example: phone_number type: string type: object channel_type_id: properties: eq: description: Filter by the id of a channel type enum: - webhook - sms - email - voice example: webhook type: string type: object notification_channel: properties: eq: description: Filter by the id of a notification channel example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a type: string type: object notification_event_condition_id: properties: eq: description: Filter by the id of a notification channel example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a type: string type: object notification_profile_id: properties: eq: description: Filter by the id of a notification profile example: 12455643-3cf1-4683-ad23-1cd32f7d5e0a type: string type: object status: properties: eq: description: The status of a notification setting enum: - enabled - enable-received - enable-pending - enable-submtited - delete-received - delete-pending - delete-submitted - deleted example: enable-received type: string type: object type: object style: deepObject notifications_Id: description: The id of the resource. in: path name: id required: true schema: format: uuid type: string numbers_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject outbound-voice-profiles_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[name][contains]' explode: true in: query name: filter schema: properties: name: description: Name filtering operations properties: contains: description: Optional filter on outbound voice profile name. example: office-profile type: string type: object type: object style: deepObject outbound-voice-profiles_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load. minimum: 1 type: integer size: default: 20 description: The size of the page. maximum: 250 minimum: 1 type: integer type: object style: deepObject phone_number_id: description: A phone number's ID via the Telnyx API in: path name: phone_number_id required: true schema: example: '1234567889' type: string porting-order_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order_id], filter[support_key], filter[status], filter[phone_number], filter[activation_status], filter[portability_status]' explode: true in: query name: filter schema: properties: activation_status: $ref: '#/components/schemas/PortingOrderActivationStatus' description: Filter results by activation status phone_number: description: Filter results by a list of phone numbers items: example: '+12003151212' type: string type: array portability_status: $ref: '#/components/schemas/PortabilityStatus' description: Filter results by portability status porting_order_id: description: Filter results by a list of porting order ids items: example: f3575e15-32ce-400e-a4c0-dd78800c20b0 format: uuid type: string type: array status: description: 'Filter porting orders by status(es). Originally: filter[status], filter[status][in][]' oneOf: - description: Filter by single status enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled example: in-process type: string - description: Filter by multiple statuses (in operation) example: - in-process - submitted items: enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled type: string type: array support_key: description: 'Filter results by support key(s). Originally: filter[support_key][eq], filter[support_key][in][]' oneOf: - description: Filter by exact support key match (eq operation) example: sr_a12345 type: string - description: Filter by multiple support keys (in operation) items: example: sr_a12345 type: string type: array type: object style: deepObject porting-order_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject programmable-fax_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound_voice_profile_id]' explode: true in: query name: filter schema: properties: application_name: description: Application name filtering operations properties: contains: 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. example: fax-app type: string type: object outbound_voice_profile_id: description: Identifies the associated outbound voice profile. example: '1293384261075731499' type: string type: object style: deepObject programmable-fax_SortApplication: 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/>\nThat is: <ul>\n <li>\n <code>application_name</code>:\ \ sorts the result by the\n <code>application_name</code> field in ascending\ \ order.\n </li>\n\n <li>\n <code>-application_name</code>: sorts the\ \ result by the\n <code>application_name</code> field in descending order.\n\ \ </li>\n</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 - application_name - active example: application_name type: string push-notifications_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load. minimum: 1 type: integer size: default: 20 description: The size of the page. maximum: 250 minimum: 1 type: integer type: object style: deepObject release_id: description: Identifies a Release request in: path name: release_id required: true schema: example: 7b6a6449-b055-45a6-81f6-f6f0dffa4cc6 format: uuid type: string telephony-credentials_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[name], filter[status], filter[resource_id], filter[sip_username]' explode: true in: query name: filter schema: properties: name: description: Filter by name type: string resource_id: description: Filter by resource_id type: string sip_username: description: Filter by sip_username type: string status: description: Filter by status type: string tag: description: Filter by tag type: string type: object style: deepObject telephony-credentials_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 50 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject ticket_id: description: Identifies an Upload request in: path name: ticket_id required: true schema: example: 7b6a6449-b055-45a6-81f6-f6f0dffa4cc6 format: uuid type: string user-addresses_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[customer_reference][eq], filter[customer_reference][contains], filter[street_address][contains]' examples: combined_filters: description: Use multiple filters together summary: Combined filters value: customer_reference: contains: REF street_address: contains: Avenue customer_reference_contains: description: Find user addresses containing part of customer reference summary: Filter by partial customer reference value: customer_reference: contains: REF customer_reference_eq: description: Find user addresses with exact customer reference match summary: Filter by exact customer reference value: customer_reference: eq: MY REF 001 street_address_contains: description: Find user addresses containing part of street address summary: Filter by street address value: street_address: contains: Congress explode: true in: query name: filter schema: properties: customer_reference: description: Filter user addresses via the customer reference. Supports both exact matching (eq) and partial matching (contains). Matching is not case-sensitive. properties: contains: description: If present, user addresses with <code>customer_reference</code> containing the given value will be returned. Matching is not case-sensitive. type: string eq: description: Filter user addresses via exact customer reference match. Matching is not case-sensitive. type: string type: object street_address: description: Filter user addresses via street address. Supports partial matching (contains). Matching is not case-sensitive. properties: contains: description: If present, user addresses with <code>street_address</code> containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. type: string type: object type: object style: deepObject user-addresses_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject video_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load. minimum: 1 type: integer size: default: 20 description: The size of the page. maximum: 250 minimum: 1 type: integer type: object style: deepObject voice-channels_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject wireless_PageConsolidated: description: 'Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load. minimum: 1 type: integer size: default: 20 description: The size of the page. maximum: 250 minimum: 1 type: integer type: object style: deepObject wireless_PageSize: description: The size of the page. in: query name: page[size] schema: default: 20 maximum: 250 minimum: 1 type: integer requestBodies: CreateCredentialsRequest: content: application/json: schema: $ref: '#/components/schemas/CustomStorageConfiguration' description: Creates new credentials resource for the specified connection_id. required: true CreateCustomerServiceRecord: content: application/json: schema: properties: additional_data: $ref: '#/components/schemas/CustomerServiceRecordAdditionalData' phone_number: description: A valid US phone number in E164 format. example: '+1234567890' pattern: ^\+1\d{10}$ type: string webhook_url: description: Callback URL to receive webhook notifications. example: https://example.com/webhook type: string required: - phone_number type: object required: true CreatePortingAdditionalDocuments: content: application/json: schema: example: additional_documents: - document_id: 22771a52-c43a-4539-80db-9dd9ec36e237 document_type: loa - document_id: d91474e6-4ebc-4ec1-b379-c596eeb405d6 document_type: invoice properties: additional_documents: items: properties: document_id: description: The document identification format: uuid type: string document_type: description: The type of document being created. enum: - loa - invoice - csr - other type: string type: object maxItems: 100 type: array type: object description: A list of additional document parameters required: true CreatePortingAssociatedPhoneNumber: content: application/json: schema: properties: action: description: Specifies the action to take with this phone number during partial porting. enum: - keep - disconnect example: keep type: string phone_number_range: properties: end_at: description: Specifies the end of the phone number range for this associated phone number. example: '+441234567899' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the phone number range for this associated phone number. example: '+441234567890' pattern: ^\+\d{7,15}$ type: string type: object required: - phone_number_range - action type: object required: true CreatePortingLOAConfiguration: content: application/json: schema: description: The parameters for creating a new LOA configuration. properties: address: description: The address of the company. properties: city: description: The locality of the company example: Austin type: string country_code: description: The country code of the company example: US pattern: ^[A-Z]{2}$ type: string extended_address: description: The extended address of the company example: 14th Floor type: string state: description: The administrative area of the company example: TX pattern: ^[A-Z]{2}$ type: string street_address: description: The street address of the company example: 600 Congress Avenue type: string zip_code: description: The postal code of the company example: '78701' pattern: ^[0-9]{5}(?:-[0-9]{4})?$ type: string required: - street_address - city - state - zip_code - country_code type: object company_name: description: The name of the company example: Telnyx type: string contact: description: The contact information of the company. properties: email: description: The email address of the contact example: testing@telnyx.com type: string phone_number: description: The phone number of the contact example: '+12003270001' pattern: ^\+\d{11,15}$ type: string required: - email - phone_number type: object logo: description: The logo of the LOA configuration properties: document_id: description: The document identification format: uuid type: string required: - document_id type: object name: description: The name of the LOA configuration example: My LOA Configuration type: string required: - name - logo - company_name - address - contact type: object required: true CreatePortingPhoneNumberBlock: content: application/json: schema: properties: activation_ranges: description: Specifies the activation ranges for this porting phone number block. The activation range must be within the block range and should not overlap with other activation ranges. items: properties: end_at: description: Specifies the end of the activation range. It must be no more than the end of the extension range. example: '+4930244999910' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the activation range. Must be greater or equal the start of the extension range. example: '+4930244999901' pattern: ^\+\d{7,15}$ type: string required: - start_at - end_at type: object type: array phone_number_range: properties: end_at: description: Specifies the end of the phone number range for this porting phone number block. example: '+4930244999910' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the phone number range for this porting phone number block. example: '+4930244999901' pattern: ^\+\d{7,15}$ type: string required: - start_at - end_at type: object required: - phone_number_range - activation_ranges type: object required: true CreatePortingPhoneNumberConfigurations: content: application/json: schema: properties: phone_number_configurations: items: properties: porting_phone_number_id: description: Identifies the porting phone number to be configured. example: 927f4687-318c-44bc-9f2f-22a5898143a4 format: uuid type: string user_bundle_id: description: Identifies the user bundle to be associated with the porting phone number. example: ff901545-3e27-462a-ba9d-2b34654cab82 format: uuid type: string required: - porting_phone_number_id - user_bundle_id type: object maxItems: 20 type: array type: object description: A list of phone number configuration parameters required: true CreatePortingPhoneNumberExtension: content: application/json: schema: properties: activation_ranges: description: Specifies the activation ranges for this porting phone number extension. The activation range must be within the extension range and should not overlap with other activation ranges. items: properties: end_at: description: Specifies the end of the activation range. It must be no more than the end of the extension range. example: 10 type: integer start_at: description: Specifies the start of the activation range. Must be greater or equal the start of the extension range. example: 1 type: integer required: - start_at - end_at type: object type: array extension_range: properties: end_at: description: Specifies the end of the extension range for this porting phone number extension. example: 10 type: integer start_at: description: Specifies the start of the extension range for this porting phone number extension. example: 1 type: integer required: - start_at - end_at type: object porting_phone_number_id: description: Identifies the porting phone number associated with this porting phone number extension. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid type: string required: - porting_phone_number_id - extension_range - activation_ranges type: object required: true CreatePortingReport: content: application/json: schema: description: The parameters for generating a new porting related report. properties: params: oneOf: - $ref: '#/components/schemas/ExportPortingOrdersCSVReport' report_type: description: Identifies the type of report enum: - export_porting_orders_csv example: export_porting_orders_csv type: string required: - report_type - params type: object required: true CreatePortoutReport: content: application/json: schema: description: The parameters for generating a new port-out related report. properties: params: oneOf: - $ref: '#/components/schemas/ExportPortoutsCSVReport' report_type: description: Identifies the type of report enum: - export_portouts_csv example: export_portouts_csv type: string required: - report_type - params type: object required: true DeleteRecordingsRequest: content: application/json: example: ids: - 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 - 428c31b6-7af4-4bcb-b7f5-5013ef9657c2 schema: properties: ids: description: List of call recording IDs to delete. items: type: string type: array required: - ids type: object description: Deletes recordings for the given list of IDs. required: true DialogflowConnectionRequest: content: application/json: schema: $ref: '#/components/schemas/DialogflowConnection' description: The params expected to create/update a Dialogflow Connection for given connection_id. required: true InitiatePortingActionRequirement: content: application/json: schema: properties: params: oneOf: - $ref: '#/components/schemas/AUIdVerificationParams' required: - params type: object description: Parameters for initiating the action requirement required: true SendPortingVerificationCodes: content: application/json: schema: example: phone_numbers: - '+61424000001' - '+61424000002' verification_method: sms properties: phone_numbers: items: type: string maxItems: 100 type: array verification_method: enum: - sms - call type: string type: object description: A list of phone numbers to send the verification codes to and the method to send them by required: false SharePortingOrder: content: application/json: schema: example: expires_in_seconds: 3600 permissions: - porting_order.document.read - porting_order.document.update properties: expires_in_seconds: description: The number of seconds the token will be valid for maximum: 172800 minimum: 1 type: integer permissions: description: The permissions the token will have enum: - porting_order.document.read - porting_order.document.update type: string type: object required: true SiprecConnectorRequest: content: application/json: schema: $ref: '#/components/schemas/SiprecConnector' description: The parameters required to create or update a SIPREC connector. required: true TexmlCreateCallRecordingRequest: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TexmlCreateCallRecordingRequestBody' description: Starts call recording on a call. TexmlCreateCallStreamingRequest: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TexmlCreateCallStreamingRequestBody' description: Start streaming media from a call TexmlCreateSiprecSessionRequest: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TexmlCreateSiprecSessionRequestBody' description: Starts a SIPREC session. TexmlUpdateCallRecordingRequest: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TexmlUpdateCallRecordingRequestBody' description: Update call recording on a call. TexmlUpdateCallStreamingRequest: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TexmlUpdateCallStreamingRequestBody' description: Update streaming TexmlUpdateSiprecSessionRequest: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TexmlUpdateSiprecSessionRequestBody' description: Updates a SIPREC session. UpdatePortingOrdersActivationJob: content: application/json: schema: properties: activate_at: description: The desired activation time. The activation time should be between any of the activation windows. example: '2019-01-01T00:00:00Z' format: date-time type: string type: object required: true VerifyCustomerServiceRecordPhoneNumberCoverage: content: application/json: schema: properties: phone_numbers: description: The phone numbers list to be verified. items: description: A valid US phone number in E164 format. example: '+1234567890' pattern: ^\+1\d{10}$ type: string type: array required: - phone_numbers type: object required: true VerifyPortingVerificationCodes: content: application/json: schema: example: verification_codes: - code: '12345' phone_number: '+61424000001' - code: '54321' phone_number: '+61424000002' properties: verification_codes: items: properties: code: type: string phone_number: type: string type: object maxItems: 100 type: array type: object description: A list of phone numbers and their verification codes required: true responses: 10dlc_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/10dlc_Errors' description: Unexpected error ActionSuccessResponse: content: application/json: schema: properties: data: properties: result: example: ok type: string type: object type: object description: Success Action Response ActiveCallsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/ActiveCall' type: array meta: $ref: '#/components/schemas/CursorPaginationMeta' title: Active Calls Response type: object description: Successful response with list of details about active calls. AddressResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/Address' type: object description: Successful response AdvancedOrderResponse: content: application/json: schema: properties: area_code: default: '' maxLength: 3 title: Area Code type: string comments: default: '' maxLength: 255 title: Comments type: string country_code: default: US maxLength: 2 minLength: 2 title: Country Code type: string customer_reference: default: '' title: Customer Reference type: string features: items: enum: - sms - mms - voice - fax - emergency title: Features type: array uniqueItems: true id: format: uuid title: Id type: string orders: items: format: uuid type: string title: Orders type: array uniqueItems: true phone_number_type: default: '' items: enum: - local - mobile - toll_free - shared_cost - national - landline quantity: default: 1 maximum: 10000 minimum: 1 title: Quantity type: integer requirement_group_id: description: The ID of the requirement group associated with this advanced order example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 format: uuid title: Requirement Group ID type: string status: items: enum: - pending - processing - ordered type: string description: An Advanced Order Response AuditLogListResponse: content: application/json: schema: $ref: '#/components/schemas/AuditLogList' description: A list of audit log entries. AutoRechargePrefResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/AutoRechargePref' type: object description: Successful response BadRequestResponse: content: application/json: examples: missingParameter: value: errors: - code: '10015' detail: The request failed because it was not well-formed. meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: / title: Bad Request schema: $ref: '#/components/schemas/ErrorResponse' description: Bad request, the request was unacceptable, often due to missing a required parameter. BlackBoxTestResultsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/BlackBoxTestResultSet' type: array type: object description: A list of black box test results. BulkDeleteRoomRecordingsResponse: content: application/json: schema: properties: data: properties: room_recordings: description: Amount of room recordings affected example: 5 type: integer type: object title: Bulk Room Recordings Delete Response type: object description: Successful response for Bulk Delete Room recordings requests BulkMessagingSettingsUpdatePhoneNumbersResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/BulkMessagingSettingsUpdatePhoneNumbers' title: Retrieve bulk update messaging settings Response type: object description: Successful response with details about messaging bulk update phone numbers. BulkSIMCardActionCollectionResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/BulkSIMCardActionDetailed' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful Response BulkSIMCardActionDetailedResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/BulkSIMCardActionDetailed' type: object description: Successful Response BulkSIMCardActionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/BulkSIMCardAction' type: object description: Successful Response 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. CallControlCommandResponseWithConversationId: content: application/json: schema: properties: data: $ref: '#/components/schemas/CallControlCommandResultWithConversationId' title: Call Control Command Response With Conversation ID type: object description: Successful response upon making a call control command that includes conversation_id. CallControlCommandResponseWithRecordingId: content: application/json: schema: properties: data: $ref: '#/components/schemas/CallControlCommandResultWithRecordingId' title: Call Control Command Response With Recording ID type: object description: Successful response upon making a call control command that includes recording_id. CancelFaxResponse: content: application/json: schema: example: data: result: ok properties: result: example: ok type: string title: Successful response upon accepting cancel fax command type: object description: Successful response upon accepting cancel fax command CancelPortingOrderResponse: content: application/json: schema: example: data: activation_settings: activation_status: null fast_port_eligible: true foc_datetime_actual: null foc_datetime_requested: '2022-04-08T15:00:00Z' created_at: '2022-03-24T14:22:28Z' customer_reference: Test1234 description: FP Telnyx documents: invoice: 3a5b98a0-5049-47c3-96e1-aa6c8d119117 loa: 3a5b98a0-5049-47c3-96e1-aa6c8d119117 end_user: admin: account_number: 123abc auth_person_name: Porter McPortersen II billing_phone_number: '+13035551234' business_identifier: abc123 entity_name: Porter McPortersen pin_passcode: '1234' tax_identifier: 1234abcd location: administrative_area: TX country_code: US extended_address: 14th Floor locality: Austin postal_code: '78701' street_address: 600 Congress Avenue id: eef10fb8-f3df-4c67-97c5-e18179723222 misc: new_billing_phone_number: null remaining_numbers_action: null type: full old_service_provider_ocn: Unreal Communications parent_support_key: pr_4bec1a phone_number_configuration: billing_group_id: null connection_id: '1752379429071357070' emergency_address_id: null messaging_profile_id: null tags: [] phone_number_type: local porting_phone_numbers_count: 1 record_type: porting_order requirements: [] requirements_met: true status: details: [] value: cancel-pending support_key: sr_10b316 updated_at: '2022-03-24T16:43:35Z' user_feedback: user_comment: null user_rating: null user_id: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 webhook_url: https://example.com/porting_webhooks meta: phone_numbers_url: /v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222 properties: data: $ref: '#/components/schemas/PortingOrder' meta: properties: phone_numbers_url: description: Link to list all phone numbers type: string type: object type: object description: Successful response 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. ConfirmPortingOrderResponse: content: application/json: schema: example: data: activation_settings: activation_status: null fast_port_eligible: true foc_datetime_actual: null foc_datetime_requested: '2022-04-08T15:00:00Z' created_at: '2022-03-24T14:22:28Z' customer_reference: Test1234 description: FP Telnyx documents: invoice: 3a5b98a0-5049-47c3-96e1-aa6c8d119117 loa: 3a5b98a0-5049-47c3-96e1-aa6c8d119117 end_user: admin: account_number: 123abc auth_person_name: Porter McPortersen II billing_phone_number: '+13035551234' business_identifier: abc123 entity_name: Porter McPortersen pin_passcode: '1234' tax_identifier: 1234abcd location: administrative_area: TX country_code: US extended_address: 14th Floor locality: Austin postal_code: '78701' street_address: 600 Congress Avenue id: eef10fb8-f3df-4c67-97c5-e18179723222 messaging: enable_messaging: false messaging_capable: true messaging_port_completed: false messaging_port_status: not_applicable misc: new_billing_phone_number: null remaining_numbers_action: null type: full old_service_provider_ocn: Unreal Communications parent_support_key: pr_4bec1a phone_number_configuration: billing_group_id: null connection_id: '1752379429071357070' emergency_address_id: null messaging_profile_id: null tags: [] phone_number_type: local porting_phone_numbers_count: 1 record_type: porting_order requirements: [] requirements_met: true status: details: [] value: in-process support_key: sr_10b316 updated_at: '2022-03-24T16:42:43Z' user_feedback: user_comment: null user_rating: null user_id: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 webhook_url: https://example.com/porting_webhooks meta: phone_numbers_url: /v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222 properties: data: $ref: '#/components/schemas/PortingOrder' meta: properties: phone_numbers_url: description: Link to list all phone numbers type: string type: object type: object description: Successful response ConnectionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/Connection' title: Connection Response type: object description: Successful response with details about a connection. CountryCoverageResponse: content: application/json: examples: example-1: value: data: Afghanistan: code: AF features: [] international_sms: false inventory_coverage: false local: {} mobile: {} national: {} numbers: false p2p: false phone_number_type: [] quickship: false reservable: false toll_free: {} Aland Islands: code: AX features: [] international_sms: false inventory_coverage: false local: {} mobile: {} national: {} numbers: false p2p: false phone_number_type: [] quickship: false reservable: false toll_free: {} Albania: code: AL features: - voice - fax international_sms: false inventory_coverage: false local: features: - fax - voice international_sms: false p2p: false quickship: false reservable: false mobile: {} national: {} numbers: true p2p: false phone_number_type: - local - toll_free quickship: false reservable: false shared_cost: {} toll_free: features: - fax - voice international_sms: false p2p: false quickship: false reservable: false Algeria: code: DZ features: [] international_sms: false inventory_coverage: false local: {} mobile: {} national: {} numbers: false p2p: false phone_number_type: [] quickship: false reservable: false toll_free: {} schema: properties: data: items: $ref: '#/components/schemas/CountryCoverage' type: array type: object description: Response for country coverage CreateCustomerServiceRecord: content: application/json: schema: example: data: created_at: '2023-01-01T00:00:00Z' error_message: null id: db7cebdb-21a8-4e89-8f51-e03ba6b799bb phone_number: '+2003271000' result: null status: pending updated_at: '2023-01-01T00:00:00Z' webhook_url: https://example.com/webhook properties: data: $ref: '#/components/schemas/CustomerServiceRecord' type: object description: Successful Response CreatePortOutSupportingDocumentsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortOutSupportingDocument' type: array type: object description: Portout Supporting Documents CreatePortingAdditionalDocuments: content: application/json: schema: example: data: - created_at: '2023-06-01T10:00:00.00000Z' document_id: 40bc547a-7f96-4cd5-926a-da4842671e88 document_type: loa id: 2acd1061-33cb-49b8-8014-beb6dc3fedbf porting_order_id: 9d7b3b8e-4e67-4837-9c44-d110cd2c82a1 record_type: porting_additional_document updated_at: '2023-06-01T10:00:00.00000Z' properties: data: items: $ref: '#/components/schemas/PortingAdditionalDocument' type: array type: object description: Successful response CreatePortingLOAConfiguration: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingLOAConfiguration' type: object description: Successful response CreatePortingPhoneNumberConfigurations: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumberConfiguration' type: array type: object description: Successful response CreatePortingReport: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingReport' type: object description: Successful response CreatePortoutReport: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortoutReport' type: object description: Successful response CreatePrivateWirelessGatewayResponse: content: application/json: schema: example: data: assigned_resources: - count: 1 record_type: sim_card_group created_at: '2018-02-02T22:25:27.521Z' id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 ip_range: 100.64.1.0/24 name: My private wireless gateway network_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 record_type: private_wireless_gateway region_code: dc2 status: error_code: null error_description: null value: provisioning updated_at: '2018-02-02T22:25:27.521Z' 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 type: string refresh_token_expires_at: description: ISO 8601 timestamp when the refresh token expires. example: '2021-03-26T17:51:59Z' format: date-time type: string token: example: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ type: string token_expires_at: description: ISO 8601 timestamp when the token expires. example: '2021-03-26T17:51:59Z' format: date-time type: string type: object type: object description: Create room client token response. CreateRoomCompositionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/RoomComposition' type: object description: Create room composition response. CreateRoomResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/Room' type: object description: Create room response. CreateSimCardDataUsageNotificationResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SimCardDataUsageNotification' type: object description: Successful 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 CreateTeXMLSecretResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/CreateTeXMLSecretResult' title: Create TeXML Secret request type: object description: Successful response upon creating a TeXML secret. CreateWdrReportResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/WdrReport' type: object description: Successful response CreateWirelessBlocklistResponse: content: application/json: schema: example: data: created_at: '2018-02-02T22:25:27.521Z' id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 name: North American Wireless Blocklist record_type: wireless_blocklist type: country updated_at: '2018-02-02T22:25:27.521Z' values: - CA - MX - US properties: data: $ref: '#/components/schemas/WirelessBlocklist' 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. CredentialsResponseBody: content: application/json: schema: $ref: '#/components/schemas/CredentialsResponse' description: A response containing a credentials resource. 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. DefaultGatewayResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/DefaultGateway' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response 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 DeleteSimCardDataUsageNotificationResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SimCardDataUsageNotification' 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 DeleteWirelessBlocklistResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/WirelessBlocklist' type: object description: Successful Response DeprecatedInitiateCallResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/InitiateCallResult' title: Initiate TeXML Call Response type: object description: Successful response upon initiating a TeXML call. DialParticipantResponse: content: application/json: schema: $ref: '#/components/schemas/NewParticipantResource' description: New participant resource. DialogflowConnectionResponseBody: content: application/json: schema: $ref: '#/components/schemas/DialogflowConnectionResponse' description: Return details of the Dialogflow connection associated with the given CallControl connection. 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: example: '%PDF-1.4...' format: binary type: string description: Successful response DynamicEmergencyAddressResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/DynamicEmergencyAddress' type: object description: Dynamic Emergency Address Response DynamicEmergencyEndpointResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/DynamicEmergencyEndpoint' type: object description: Dynamic Emergency Endpoint Response ExternalConnectionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/ExternalConnection' title: External Connection Response type: object 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/video_Error' description: Forbidden ForbiddenErrorResponse: content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/ForbiddenError' type: array description: You do not have permission to perform the requested action on the specified resource or resources. ForbiddenResponse: description: Unauthorized response. Happens when the current user is not authorized to access the endpoint. 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/call-recordings_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 GetAllCivicAddressesResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/CivicAddress' type: array title: Get All Civic Addresses Response type: object description: Successful response GetAllExternalConnectionResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/ExternalConnection' type: array meta: $ref: '#/components/schemas/external-voice-integrations_PaginationMeta' title: Get All External Connections Response 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/SearchedSIMCardGroup' 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/call-scripting_PaginationMeta' title: Get All Texml Applications Response type: object description: Successful response GetAllUserAddressResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/UserAddress' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response GetAllWirelessBlocklistsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/WirelessBlocklist' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful Response GetCallResponse: content: application/json: schema: $ref: '#/components/schemas/CallResource' description: Call resource. GetCallsResponse: content: application/json: schema: $ref: '#/components/schemas/CallResourceIndex' description: Multiple call resources. GetCivicAddressResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/CivicAddress' title: Get Civic Address Response type: object description: Successful response GetConferenceRecordingsResponse: content: application/json: schema: $ref: '#/components/schemas/ConferenceRecordingResourceIndex' description: Multiple conference recording resources. GetConferenceResponse: content: application/json: schema: $ref: '#/components/schemas/ConferenceResource' description: Conference resource. GetConferencesResponse: content: application/json: schema: $ref: '#/components/schemas/ConferenceResourceIndex' description: Multiple conference resources. GetExternalConnectionPhoneNumberResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/ExternalConnectionPhoneNumber' title: Get External Connection Phone Number 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 GetGcbChannelZoneRequestResponse: content: application/json: schema: $ref: '#/components/schemas/GcbChannelZone' description: Requested channel zone GetGcbChannelZonesRequestResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GcbChannelZone' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: A list of channel zones GetGcbNumbersResponse: content: application/json: schema: properties: data: items: properties: number_of_channels: example: 7 type: integer numbers: items: properties: country: example: FR type: string number: example: '+15554441234' type: string type: object type: array zone_id: example: 1653e6a1-4bfd-4857-97c6-6a51e1c34477 type: string zone_name: example: Euro channel zone type: string type: object type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: A list of numbers using GCB, grouped by channel zone GetGcbPhoneNumbersRequestResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GcbPhoneNumber' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: A list of phone numbers GetLogMessageResponse: content: application/json: schema: properties: log_messages: items: $ref: '#/components/schemas/LogMessage' maxItems: 1 minItems: 1 type: array title: Get Log Message Response type: object description: Successful response GetParticipantResponse: content: application/json: schema: $ref: '#/components/schemas/ParticipantResource' description: Participant resource. GetParticipantsResponse: content: application/json: schema: $ref: '#/components/schemas/ParticipantResourceIndex' description: Multiple participant resources. GetPrivateWirelessGatewayResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/PrivateWirelessGateway' type: object description: Successful Response GetReleaseResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/Release' title: Get Release Response type: object description: Successful response GetRoomCompositionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/RoomComposition' type: object description: Get room composition response. GetRoomParticipantResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/RoomParticipant' type: object description: Get room participant response. GetRoomRecordingResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/RoomRecording' type: object description: Get room recording 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. GetSimCardDataUsageNotificationResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SimCardDataUsageNotification' type: object description: Successful 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 GetUploadResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/Upload' title: Get Upload Response type: object description: Successful response GetUploadsStatusResponse: content: application/json: schema: properties: data: properties: pending_numbers_count: description: The count of phone numbers that are pending assignment to the external connection. type: integer pending_orders_count: description: The count of number uploads that have not yet been uploaded to Microsoft. type: integer type: object title: Get Uploads Status Response 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 GetWirelessBlocklistResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/WirelessBlocklist' type: object description: Successful Response GlobalIpAllowedPortListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIPAllowedPort' type: array type: object description: Successful response GlobalIpAssignmentListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIpAssignment' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response GlobalIpAssignmentResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/GlobalIpAssignment' type: object description: Successful response GlobalIpAssignmentUsageResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIpAssignmentUsageMetric' type: array type: object description: Successful response GlobalIpHealthCheckListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIPHealthCheck' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response GlobalIpHealthCheckResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/GlobalIPHealthCheck' type: object description: Successful response GlobalIpHealthCheckTypesResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIpHealthCheckType' type: array type: object description: Successful response GlobalIpHealthResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIpAssignmentHealthMetric' type: array type: object description: Successful response GlobalIpLatencyResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIpLatencyMetric' type: array type: object description: Successful response GlobalIpListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIP' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response GlobalIpProtocolListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIPProtocol' type: array type: object description: Successful response GlobalIpResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/GlobalIP' type: object description: Successful response GlobalIpUsageResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GlobalIpUsageMetric' type: array type: object description: Successful response InitiateCallResponse: content: application/json: schema: $ref: '#/components/schemas/InitiateCallResult' description: Successful response upon initiating a TeXML call. 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 InvoiceDetailResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/InvoiceDetail' type: object description: Get invoice details 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. ListAdvancedOrderResponse: content: application/json: schema: properties: data: items: $ref: '#/components/responses/AdvancedOrderResponse' type: array description: An array of Advanced Order Responses ListAllowedFocWindows: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrdersAllowedFocWindow' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response 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. 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/connections_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/connections_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. ListCustomerServiceRecordPhoneNumberCoverage: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/CustomerServiceRecordPhoneNumberCoverage' type: array type: object description: Successful Response ListCustomerServiceRecords: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/CustomerServiceRecord' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful Response 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 ListDraftPortingOrdersWithoutPagination: content: application/json: schema: example: data: - activation_settings: activation_status: null fast_port_eligible: true foc_datetime_actual: null foc_datetime_requested: null created_at: '2022-03-17T18:01:01Z' customer_reference: null description: FP Telnyx documents: invoice: null loa: null end_user: admin: account_number: null auth_person_name: null billing_phone_number: null business_identifier: null entity_name: null pin_passcode: null tax_identifier: null location: administrative_area: null country_code: null extended_address: null locality: null postal_code: null street_address: null id: b0ea6d6f-de31-4079-a536-992e0c98b037 messaging: enable_messaging: false messaging_capable: true messaging_port_completed: false messaging_port_status: not_applicable misc: null old_service_provider_ocn: Unreal Communications parent_support_key: null phone_number_configuration: billing_group_id: null connection_id: null emergency_address_id: null messaging_profile_id: null tags: [] phone_number_type: local phone_numbers: - activation_status: null phone_number: '{e.164 TN}' phone_number_type: local portability_status: confirmed porting_order_id: b0ea6d6f-de31-4079-a536-992e0c98b037 porting_order_status: draft record_type: porting_phone_number requirements_status: requirement-info-pending support_key: null porting_phone_numbers_count: 1 record_type: porting_order requirements: [] requirements_met: false status: details: [] value: draft support_key: null updated_at: '2022-03-17T18:01:01Z' user_feedback: user_comment: null user_rating: null user_id: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 webhook_url: null properties: data: items: $ref: '#/components/schemas/PortingOrder' type: array type: object description: Successful response ListExternalConnectionPhoneNumbersResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/ExternalConnectionPhoneNumber' type: array meta: $ref: '#/components/schemas/external-voice-integrations_PaginationMeta' title: List External Connection Phone Numbers Response 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/connections_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/connections_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/connections_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. ListLogMessagesResponse: content: application/json: schema: properties: log_messages: items: $ref: '#/components/schemas/LogMessage' type: array meta: $ref: '#/components/schemas/external-voice-integrations_PaginationMeta' title: List Log Messages Response type: object description: Successful response ListManagedAccountsAllocatableGlobalOutboundChannelsResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/ManagedAccountsGlobalOutboundChannels' type: object description: Successful response with information about allocatable global outbound channels. ListManagedAccountsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/ManagedAccountMultiListing' 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. 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. 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. ListPortingActionRequirements: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingActionRequirement' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingAdditionalDocuments: content: application/json: schema: example: data: - created_at: '2023-06-01T10:00:00.00000Z' document_id: 40bc547a-7f96-4cd5-926a-da4842671e88 document_type: loa id: 2acd1061-33cb-49b8-8014-beb6dc3fedbf porting_order_id: 9d7b3b8e-4e67-4837-9c44-d110cd2c82a1 record_type: porting_additional_document updated_at: '2023-06-01T10:00:00.00000Z' meta: page_number: 1 page_size: 25 total_pages: 1 total_results: 1 properties: data: items: $ref: '#/components/schemas/PortingAdditionalDocument' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingAssociatedPhoneNumbers: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingAssociatedPhoneNumber' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingEventsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingEvent' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingLOAConfigurations: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingLOAConfiguration' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingOrder: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrder' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingOrderRequirements: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingOrderRequirementDetail' type: array meta: $ref: '#/components/schemas/PaginationMeta' 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 ListPortingPhoneNumberBlocks: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumberBlock' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingPhoneNumberConfigurations: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumberConfiguration' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingPhoneNumberExtensions: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumberExtension' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingPhoneNumbers: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingPhoneNumber' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object text/csv: schema: example: "phone_number,phone_number_type,porting_order_id,support_key,porting_order_status\r\ \n+12003155566,local,5f940c35-ef28-4408-bb95-af73b047d589,sr_a12345,draft\r\ \n" type: string description: Successful response ListPortingReports: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingReport' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortingUKCarriersResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortingUKCarrier' type: array type: object description: Successful response ListPortingVerificationCodes: content: application/json: schema: example: data: - created_at: '2020-10-22T15:00:00.000Z' id: 52090326-6533-4421-bcf4-bd0117cf3954 phone_number: '+61424000001' porting_order_id: f28e6ecc-29a8-430b-bd0b-d93055f70604 updated_at: '2020-10-22T15:00:00.000Z' verified: true - created_at: '2020-10-22T15:00:00.000Z' id: cf076b8e-645b-4040-8209-543c5909775f phone_number: '+61424000002' porting_order_id: f28e6ecc-29a8-430b-bd0b-d93055f70604 updated_at: '2020-10-22T15:00:00.000Z' verified: false meta: page_number: 1 page_size: 2 total_pages: 1 total_results: 2 properties: data: items: $ref: '#/components/schemas/PortingVerificationCode' type: array meta: $ref: '#/components/schemas/PaginationMeta' 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 ListPortoutEventsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortoutEvent' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListPortoutRejections: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortoutRejection' type: array type: object description: Successful response ListPortoutReports: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortoutReport' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response 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. ListRecordingTranscriptionsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/RecordingTranscription' type: array meta: $ref: '#/components/schemas/call-recordings_CursorPaginationMeta' type: object description: A response listing multiple recording transcriptions. ListReleasesResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Release' type: array meta: $ref: '#/components/schemas/external-voice-integrations_PaginationMeta' title: List Releases Response type: object description: Successful response ListRequirementsResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/DocReqsRequirementList' meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response ListRoomCompositionsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/RoomComposition' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: List room compositions 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. ListRoomRecordingsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/RoomRecording' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: List room recordings 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. ListUploadsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Upload' type: array meta: $ref: '#/components/schemas/external-voice-integrations_PaginationMeta' title: List Uploads Response type: object description: Successful response ListUserTagsResponse: content: application/json: schema: properties: data: properties: number_tags: $ref: '#/components/schemas/UserTagList' outbound_profile_tags: $ref: '#/components/schemas/UserTagList' type: object type: object description: A list of your tags ListWebhookDeliveriesResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/webhook_delivery' type: array meta: $ref: '#/components/schemas/webhooks_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: application/octet-stream: 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. NetworkCoverageListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/NetworkCoverage' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response NetworkInterfaceListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/NetworkInterface' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response NetworkListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Network' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response NetworkResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/Network' type: object description: Successful response NotFoundErrorResponse: content: application/json: schema: $ref: '#/components/schemas/verified-numbers_Errors' description: Resource Not Found NotFoundResponse: description: Conference does not exist NotFoundResponseApp: content: application/json: examples: notFound: value: errors: - code: '10005' detail: The requested resource or URL could not be found. meta: url: https://developers.telnyx.com/docs/overview/errors/10005 source: pointer: / title: Resource not found schema: $ref: '#/components/schemas/ErrorResponse' description: The requested resource doesn't 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 PatchGcbChannelZoneRequestResponse: content: application/json: schema: $ref: '#/components/schemas/GcbChannelZone' description: Successfuly patched channel zone PatchRoomResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/Room' type: object description: Update room response. 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 messaging 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. PortOutListSupportingDocumentsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PortOutSupportingDocument' type: array type: object description: Portout Supporting Documents 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 PostGcbPhoneNumberRequestResponse: content: application/json: schema: $ref: '#/components/schemas/GcbPhoneNumber' description: A new inserted phone number PublicInternetGatewayListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/PublicInternetGatewayRead' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response PublicInternetGatewayResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/PublicInternetGatewayRead' type: object description: Successful 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 RecordingResponseBody: content: application/json: schema: $ref: '#/components/schemas/RecordingResponse' description: A response with a single recording resource. RecordingTranscriptionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/RecordingTranscription' type: object description: A response with a single recording transcription resource. RecordingsResponseBody: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/RecordingResponseData' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: A response containing multiple recordings. 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 type: string token_expires_at: description: ISO 8601 timestamp when the token expires. example: '2021-03-26T17:51:59Z' format: date-time type: string type: object type: object description: Refresh room client token response. RegionListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/netapps_Region' type: array type: object description: Successful 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/wireless_Error' type: array type: object description: Successful response RegistrationStatusResponse: content: application/json: schema: properties: data: example: data: id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 ip_address: 190.106.106.121 last_registration: '2021-09-28T15:11:02' port: 37223 record_type: registration_status sip_username: rogerp status: Expired transport: UDP user_agent: Z 5.4.12 v2.10.13.2-mod properties: ip_address: description: The ip used during the SIP connection example: 190.106.106.121 type: string last_registration: description: ISO 8601 formatted date indicating when the resource was last updated. example: '2018-02-02T22:25:27.521Z' type: string port: description: The port of the SIP connection example: 37223 type: integer record_type: description: Identifies the type of the resource. example: registration_status type: string sip_username: description: The user name of the SIP connection example: sip_username type: string status: description: The current registration status of your SIP connection enum: - Not Applicable - Not Registered - Failed - Expired - Registered - Unregistered type: string transport: description: The protocol of the SIP connection example: TCP type: string user_agent: description: The user agent of the SIP connection example: Z 5.4.12 v2.10.13.2-mod type: string title: Registration Status type: object title: Registration Status Response type: object description: Successful response with details about a credential connection registration status. ResourceNotFound: content: application/json: schema: $ref: '#/components/schemas/documents_Error' description: Resource not found ResourceNotFoundErrorResponse: content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/customer_service_record_ResourceNotFoundError' type: array description: Resource not found 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. RetrieveCallStatusResponseWithRecordingId: content: application/json: schema: properties: data: $ref: '#/components/schemas/CallWithRecordingId' title: Retrieve Call Status Response With Recording ID type: object description: Successful response with details about a call status that includes recording_id. SIMCardActionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SIMCardAction' type: object description: Successful Response SIMCardActivationCodeResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SIMCardActivationCode' type: object description: Successful response SIMCardDeviceDetailsResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SIMCardDeviceDetails' type: object description: Successful response SIMCardGroupActionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SIMCardGroupAction' type: object description: Successful 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 SearchMobileNetworkOperatorsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/MobileNetworkOperator' 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 SharePortingOrder: content: application/json: example: created_at: '2023-07-20T22:11:17.292573Z' expires_at: '2023-07-20T23:11:17Z' expires_in_seconds: 3600 id: 03a35311-ad92-46b3-95d7-8ad6dccf2d7c permissions: - porting_order.document.read - porting_order.document.update porting_order_id: fd4b86c8-497d-4c6d-9609-a789e4e14cfe record_type: porting_order_sharing_token token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODk4OTQ2NzcsImlzdCI6MTY4OTg5MTA3NywicGVybWlzc2lvbnMiOlsicG9ydGluZ19vcmRlci5kb2N1bWVudC5yZWFkIl0sInBvcnRpbmdfb3JkZXJfaWQiOiJmZDRiODZjOC00OTdkLTRjNmQtOTYwOS1hNzg5ZTRlMTRjZmUifQ.CT0HRF6OLj7VPZ8p5Y_0S8rOL8SEUznwJJkR-YReKwc schema: properties: data: $ref: '#/components/schemas/PortingOrderSharingToken' type: object description: Successful 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. ShowCustomerServiceRecord: content: application/json: schema: properties: data: $ref: '#/components/schemas/CustomerServiceRecord' type: object description: Successful Response ShowPortingActionRequirement: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingActionRequirement' type: object description: Successful response ShowPortingAssociatedPhoneNumber: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingAssociatedPhoneNumber' type: object description: Successful response ShowPortingEventResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingEvent' type: object description: Successful response ShowPortingLOAConfiguration: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingLOAConfiguration' 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: /v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222 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 ShowPortingPhoneNumber: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingPhoneNumber' 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 ShowPortingPhoneNumberBlock: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingPhoneNumberBlock' type: object description: Successful response ShowPortingPhoneNumberExtension: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingPhoneNumberExtension' type: object description: Successful response ShowPortingReport: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingReport' type: object description: Successful response ShowPortoutEventResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortoutEvent' type: object description: Successful response ShowPortoutReport: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortoutReport' type: object description: Successful response SimCardActionCollectionResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/SIMCardAction' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful Response SimCardDataUsageNotificationCollectionResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/SimCardDataUsageNotification' type: array meta: $ref: '#/components/schemas/PaginationMeta' 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 SinglePhoneNumberCampaign: content: application/json: schema: $ref: '#/components/schemas/PhoneNumberCampaign' description: Successful Response SiprecConnectorResponseBody: content: application/json: schema: $ref: '#/components/schemas/SiprecConnectorResponse' description: Return details of the SIPREC connector. SlimListPhoneNumbersResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/SlimPhoneNumberDetailed' type: array meta: $ref: '#/components/schemas/PaginationMeta' title: List Phone Numbers Response type: object description: Successful response with a list of phone numbers. SpecificCountryResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/CountryCoverage' type: object description: Response for specific country coverage 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. SubNumberOrdersReportResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SubNumberOrdersReport' type: object description: Sub number orders report response SubRequestByPortingOrder: content: application/json: schema: properties: data: $ref: '#/components/schemas/GetSubRequestByPortingOrder' type: object description: Successful response 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 TexmlCreateCallRecordingResponse: content: application/json: schema: $ref: '#/components/schemas/TexmlCreateCallRecordingResponseBody' description: Successful call recording create response TexmlCreateCallStreamingResponse: content: application/json: schema: $ref: '#/components/schemas/TexmlCreateCallStreamingResponseBody' description: Successful call streaming create response TexmlCreateSiprecSessionResponse: content: application/json: schema: $ref: '#/components/schemas/TexmlCreateSiprecSessionResponseBody' description: Successful SIPREC session create response TexmlGetCallRecordingResponse: content: application/json: schema: $ref: '#/components/schemas/TexmlGetCallRecordingResponseBody' description: Retrieves call recording resource. TexmlGetCallRecordingsResponse: content: application/json: schema: $ref: '#/components/schemas/TexmlGetCallRecordingsResponseBody' description: Successful Get Call Recordings Response TexmlGetRecordingTranscriptionResponse: content: application/json: schema: $ref: '#/components/schemas/TexmlRecordingTranscription' title: Recording Transcription Response type: object description: Successful get Recording Transcription Response TexmlListRecordingTranscriptionResponse: content: application/json: schema: properties: end: description: The number of the last element on the page, zero-indexed example: 1 type: integer first_page_uri: description: Relative uri to the first page of the query results example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?Page=0&PageSize=1 format: uri type: string next_page_uri: description: Relative uri to the next page of the query results example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?PageToken=KRWXZPO&PageSize=1 type: string page: description: Current page number, zero-indexed. example: 0 type: integer page_size: description: The number of items on the page example: 20 type: integer previous_page_uri: description: Relative uri to the previous page of the query results example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?PageToken=MZQTDUHX&PageSize=1 format: uri type: string start: description: The number of the first element on the page, zero-indexed. example: 0 type: integer transcriptions: items: $ref: '#/components/schemas/TexmlRecordingTranscription' type: array uri: description: The URI of the current page. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions.json?PageToken=YTBNAXPI&PageSize=1 type: string title: List Recording Transcriptions Response type: object description: Successful list Recording Transcriptions Response TexmlUpdateCallStreamingResponse: content: application/json: schema: $ref: '#/components/schemas/TexmlUpdateCallStreamingResponseBody' description: Successful call streaming update response TexmlUpdateSiprecSessionResponse: content: application/json: schema: $ref: '#/components/schemas/TexmlUpdateSiprecSessionResponseBody' description: Successful SIPREC session update response UnauthenticatedResponse: content: application/json: examples: Authentication Failed: value: errors: - code: '10009' detail: Could not understand the provided credentials. meta: url: https://developers.telnyx.com/docs/overview/errors/10009 title: Authentication failed schema: $ref: '#/components/schemas/ErrorResponse' description: Unauthorized UnauthorizedErrorResponse: content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/UnauthorizedError' type: array description: The required authentication headers were either invalid or not included in the request. UnauthorizedRequestErrorResponse: content: application/json: schema: $ref: '#/components/schemas/verified-numbers_Errors' description: Unauthorized Request UnauthorizedResponse: description: Unauthorized UnexpectedErrorResponse: content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/UnexpectedError' type: array description: An unexpected error occurred. UnprocessableEntity: content: application/json: schema: $ref: '#/components/schemas/documents_Errors' description: Unprocessable entity. Check the 'detail' field in response for details. UnprocessableEntityErrorResponse: content: application/json: schema: properties: errors: items: $ref: '#/components/schemas/customer_service_record_UnprocessableEntityError' type: array 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. UpdateManagedAccountGlobalChannelLimitResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SingleManagedAccountGlobalOutboundChannels' type: object description: Successful response with information about the allocatable global outbound channels for the given account. UpdatePortingLOAConfiguration: content: application/json: schema: properties: data: $ref: '#/components/schemas/PortingLOAConfiguration' type: object description: Successful response UpdatePortingOrderResponse: content: application/json: schema: example: data: activation_settings: activation_status: null fast_port_eligible: true foc_datetime_actual: null foc_datetime_requested: '2022-04-08T15:00:00Z' created_at: '2022-03-24T14:22:28Z' customer_reference: Test1234 description: FP Telnyx documents: invoice: null loa: null end_user: admin: account_number: 123abc auth_person_name: Porter McPortersen II billing_phone_number: '+13035551234' business_identifier: abc123 entity_name: Porter McPortersen pin_passcode: '1234' tax_identifier: 1234abcd location: administrative_area: TX country_code: US extended_address: 14th Floor locality: Austin postal_code: '78701' street_address: 600 Congress Avenue id: eef10fb8-f3df-4c67-97c5-e18179723222 messaging: enable_messaging: true messaging_capable: true messaging_port_completed: false messaging_port_status: pending misc: new_billing_phone_number: null remaining_numbers_action: null type: full old_service_provider_ocn: Unreal Communications parent_support_key: null phone_number_configuration: billing_group_id: null connection_id: '1752379429071357070' emergency_address_id: null messaging_profile_id: null tags: [] phone_number_type: local porting_phone_numbers_count: 1 record_type: porting_order requirements: [] requirements_met: false status: details: [] value: draft support_key: null updated_at: '2022-03-24T14:26:53Z' user_feedback: user_comment: null user_rating: null user_id: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 webhook_url: https://example.com/porting_webhooks meta: phone_numbers_url: /v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222 properties: data: $ref: '#/components/schemas/PortingOrder' meta: properties: phone_numbers_url: description: Link to list all phone numbers type: string type: object type: object description: Successful response UpdateSimCardDataUsageNotificationResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/SimCardDataUsageNotification' type: object description: Successful Response 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 UpdateTeXMLCallResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/UpdateCommandResult' title: TeXML REST Command Response type: object description: Successful response upon updating a TeXML call. UpdateWirelessBlocklistResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/WirelessBlocklist' type: object description: Successful response UserAddressResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/UserAddress' type: object description: Successful response UserBalanceResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/UserBalance' type: object description: Get user balance details ValidateAddressResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/ValidateAddressResult' title: Validate address action response type: object description: Action response ValidationCodesResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/ValidationCodes' title: Retrieve Messaging Hosted Number Response type: object description: Successful response with the phone numbers and their respective status of the validation codes. VerifyPortingVerificationCodes: content: application/json: schema: example: data: - created_at: '2020-10-22T15:00:00.000Z' id: 52090326-6533-4421-bcf4-bd0117cf3954 phone_number: '+61424000001' porting_order_id: f28e6ecc-29a8-430b-bd0b-d93055f70604 updated_at: '2020-10-22T15:00:00.000Z' verified: true - created_at: '2020-10-22T15:00:00.000Z' id: cf076b8e-645b-4040-8209-543c5909775f phone_number: '+61424000002' porting_order_id: f28e6ecc-29a8-430b-bd0b-d93055f70604 updated_at: '2020-10-22T15:00:00.000Z' verified: false properties: data: items: $ref: '#/components/schemas/PortingVerificationCode' type: array type: object description: Successful response VirtualCrossConnectCoverageListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/VirtualCrossConnectCoverage' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response VirtualCrossConnectListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/VirtualCrossConnectCombined' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response VirtualCrossConnectResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/VirtualCrossConnectCombined' type: object description: Successful response VoicemailResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/VoicemailPrefResponse' type: object description: Successful response WireguardInterfaceListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/WireguardInterfaceRead' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response WireguardInterfaceResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/WireguardInterfaceRead' type: object description: Successful response WireguardPeerListResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/WireguardPeer' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response WireguardPeerResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/WireguardPeer' 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 billing_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/billing_Errors' description: Unexpected error bundle-pricing_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/bundle-pricing_Errors' description: Unexpected error call-control_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/call-control_Errors' description: Unexpected error call-scripting_NotFoundResponse: content: application/json: schema: $ref: '#/components/schemas/call-scripting_ResourceNotFoundError' description: Resource not found call-scripting_UnauthorizedResponse: content: application/json: examples: notAuthorized: value: errors: - code: '10010' detail: You are not authorized to access the requested resource. meta: url: https://developers.telnyx.com/docs/overview/errors/10010 source: pointer: / title: Not authorized schema: $ref: '#/components/schemas/ErrorResponse' description: The user doesn't have the required permissions to perform the requested action. charges_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/charges_Errors' description: Unexpected error connections_NotFoundResponse: content: application/json: examples: notFound: value: errors: - code: '10005' detail: The requested resource or URL could not be found. meta: url: https://developers.telnyx.com/docs/overview/errors/10005 source: pointer: / title: Resource not found schema: $ref: '#/components/schemas/ErrorResponse' description: The requested resource doesn't exist. connections_UnauthorizedResponse: content: application/json: examples: notAuthorized: value: errors: - code: '10010' detail: You are not authorized to access the requested resource. meta: url: https://developers.telnyx.com/docs/overview/errors/10010 source: pointer: / title: Not authorized schema: $ref: '#/components/schemas/ErrorResponse' description: The user doesn't have the required permissions to perform the requested action. connections_UnprocessableEntityResponse: content: application/json: examples: unprocessableEntity: value: errors: - code: '10015' detail: 'Invalid dnis_format: test, was provided. Acceptable formats are +e164, e164, national, sip_username' meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /inbound/dnis_number_format title: Bad Request schema: $ref: '#/components/schemas/ErrorResponse' description: The request was well-formed but was unable to be followed due to semantic errors. documents_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/documents_Errors' description: Unexpected error emergency_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/emergency_Errors' description: Unexpected error external-voice-integrations_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/external-voice-integrations_Errors' description: Unexpected error invoice_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/invoice_Errors' description: Unexpected error 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 listDynamicEmergencyAddresses: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/DynamicEmergencyAddress' type: array meta: $ref: '#/components/schemas/Metadata' type: object description: Dynamic Emergency Address Responses listDynamicEmergencyEndpoints: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/DynamicEmergencyEndpoint' type: array meta: $ref: '#/components/schemas/Metadata' type: object description: Dynamic Emergency Endpoints Responses listRegulatoryRequirements: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/RegulatoryRequirements' type: array type: object description: An array of Regulatory Requirements Responses listRegulatoryRequirementsPhoneNumbers: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/RegulatoryRequirementsPhoneNumbers' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: An array of Regulatory Requirements Responses managed-accounts_UnauthorizedResponse: description: Unauthenticated response. Happens when the current user cannot be authenticated. media-storage_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/media-storage_Errors' description: Unexpected error media-streaming_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/media-streaming_Errors' description: Unexpected error. messaging_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/messaging_Errors' description: Unexpected error netapps_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/netapps_Errors' description: Unexpected error netapps_UnprocessableEntity: content: application/json: schema: $ref: '#/components/schemas/netapps_Errors' description: Unprocessable entity. Check the 'detail' field in response for details. notifications_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/notifications_Errors' description: Unexpected error number-lookup_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/number-lookup_Errors' description: Unexpected error number-lookup_UnprocessableEntity: content: application/json: schema: $ref: '#/components/schemas/number-lookup_Errors' description: Unprocessable entity. Check the 'detail' field in response for details. numbers_ForbiddenResponse: content: application/json: examples: Not authorized: $ref: '#/components/examples/NotAuthorized' schema: $ref: '#/components/schemas/numbers_Errors' description: Forbidden numbers_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/numbers_Errors' description: Unexpected error numbers_UnauthorizedResponse: content: application/json: examples: Authentication Failed: value: errors: - code: '10009' detail: Could not understand the provided credentials. meta: url: https://developers.telnyx.com/docs/overview/errors/10009 title: Authentication failed schema: $ref: '#/components/schemas/numbers_Errors' description: Unauthorized payment_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/payment_Errors' description: Unexpected error programmable-fax_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/programmable-fax_Errors' description: Unexpected error programmable-fax_NotFoundResponse: description: Fax does not exist siprec_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/siprec_Errors' description: Unexpected error. toll-free-verification_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/toll-free-verification_Errors' description: Unexpected error user-addresses_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/user-addresses_Errors' description: Unexpected error verified-numbers_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/verified-numbers_Errors' description: Bad Request verified-numbers_UnprocessableEntityErrorResponse: content: application/json: schema: $ref: '#/components/schemas/verified-numbers_Errors' description: Unprocessable Entity verify_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/verify_Errors' description: Bad Request video_ResourceNotFound: content: application/json: schema: $ref: '#/components/schemas/video_Error' description: Resource not found video_UnprocessableEntity: content: application/json: schema: $ref: '#/components/schemas/video_Errors' description: Unprocessable entity. Check the 'detail' field in response for details. voice-channels_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/voice-channels_Errors' description: Unexpected error voicemail_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/voicemail_Errors' description: Unexpected error wireless_GenericErrorResponse: content: application/json: schema: $ref: '#/components/schemas/wireless_Errors' description: Unexpected error wireless_ResourceNotFound: content: application/json: schema: $ref: '#/components/schemas/wireless_Error' description: Resource not found wireless_UnprocessableEntity: content: application/json: schema: $ref: '#/components/schemas/wireless_Errors' description: Unprocessable entity. Check the 'detail' field in response for details. schemas: 10dlc_Error: properties: code: type: string detail: type: string source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object 10dlc_Errors: properties: errors: items: $ref: '#/components/schemas/10dlc_Error' type: array type: object 10dlc_TaskStatus: description: An enumeration. enum: - pending - processing - completed - failed title: TaskStatus type: string AIAssistantStartRequest: properties: assistant: description: AI Assistant configuration properties: id: description: The identifier of the AI assistant to use type: string instructions: description: The system instructions that the voice assistant uses during the start assistant command. This will overwrite the instructions set in the assistant configuration. example: You are a friendly voice assistant. type: string openai_api_key_ref: description: Reference to the OpenAI API key. Required only when using OpenAI models type: string type: object 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string greeting: description: Text that will be played when the assistant starts, if none then nothing will be played when the assistant starts. The greeting can be text for any voice or SSML for `AWS.Polly.<voice_id>` voices. There is a 3,000 character limit. example: Hello, can you tell me your age and where you live? type: string interruption_settings: $ref: '#/components/schemas/InterruptionSettings' transcription: $ref: '#/components/schemas/TranscriptionConfig' voice: $ref: '#/components/schemas/VoiceConfig' voice_settings: description: The settings associated with the voice selected oneOf: - $ref: '#/components/schemas/ElevenLabsVoiceSettings' - $ref: '#/components/schemas/TelnyxVoiceSettings' - $ref: '#/components/schemas/AWSVoiceSettings' type: object AIAssistantStopRequest: 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string title: AI Assistant Stop Request type: object AUIdVerificationParams: description: Required information for initiating the action requirement for AU ID verification. properties: first_name: description: The first name of the person that will perform the verification flow. example: John type: string last_name: description: The last name of the person that will perform the verification flow. example: Doe type: string required: - first_name - last_name type: object AWSVoiceSettings: properties: {} title: AWS Voice Settings type: object AcceptSuggestionsRequest: properties: id: description: The ID of the address. type: string type: object AccessIPAddressListResponseSchema: properties: data: items: $ref: '#/components/schemas/AccessIPAddressResponseSchema' title: Data type: array meta: $ref: '#/components/schemas/cloudflare-ip-list-sync_PaginationMeta' required: - data - meta title: AccessIPAddressListResponseSchema type: object AccessIPAddressPOST: properties: description: title: Description type: string ip_address: title: Ip Address type: string required: - ip_address title: AccessIPAddressPOST type: object AccessIPAddressResponseSchema: properties: created_at: format: date-time title: Created At type: string description: title: Description type: string id: title: Id type: string ip_address: title: Ip Address type: string source: title: Source type: string status: $ref: '#/components/schemas/CloudflareSyncStatus' updated_at: format: date-time title: Updated At type: string user_id: title: User Id type: string required: - id - ip_address - source - status - user_id title: AccessIPAddressResponseSchema type: object AccessIPRangeListResponseSchema: properties: data: items: $ref: '#/components/schemas/AccessIPRangeResponseSchema' title: Data type: array meta: $ref: '#/components/schemas/cloudflare-ip-list-sync_PaginationMeta' required: - data - meta title: AccessIPRangeListResponseSchema type: object AccessIPRangePOST: properties: cidr_block: title: Cidr Block type: string description: title: Description type: string required: - cidr_block title: AccessIPRangePOST type: object AccessIPRangeResponseSchema: properties: cidr_block: title: Cidr Block type: string created_at: format: date-time title: Created At type: string description: title: Description type: string id: title: Id type: string status: $ref: '#/components/schemas/CloudflareSyncStatus' updated_at: format: date-time title: Updated At type: string user_id: title: User Id type: string required: - id - cidr_block - status - user_id title: AccessIPRangeResponseSchema type: object AccountSid: example: 61bf923e-5e4d-4595-a110-56190ea18a1b type: string ActionsParticipantsRequest: properties: exclude: description: List of participant id to exclude from the action. items: example: 7b61621f-62e0-4aad-ab11-9fd19e272e73 format: uuid type: string type: array participants: description: Either a list of participant id to perform the action on, or the keyword "all" to perform the action on all participant. oneOf: - enum: - all example: all type: string - items: example: 7b61621f-62e0-4aad-ab11-9fd19e272e73 format: uuid type: string type: array type: object ActiveCall: example: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_duration: 50 call_leg_id: 2dc6fc34-f9e0-11ea-b68e-02420a0f7768 call_session_id: 2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d record_type: call properties: call_control_id: description: Unique identifier and token for controlling the call. example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg type: string call_duration: description: Indicates the duration of the call in seconds example: 50 type: integer 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call example: 428c31b6-7af4-4bcb-b68e-5013ef9657c1 type: string client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string record_type: enum: - call example: call type: string required: - call_control_id - call_leg_id - call_session_id - client_state - record_type - call_duration title: Active Call type: object 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 AddressSuggestionResponse: properties: data: properties: accepted: description: Indicates if the address suggestions are accepted. type: boolean id: description: The UUID of the location. format: uuid type: string record_type: enum: - address_suggestion type: string type: object type: object AdjustmentLine: properties: amount: description: Adjustment amount as decimal string example: '-10.00' type: string description: description: Description of the adjustment example: Credit for service outage type: string event_date: description: Date when the adjustment occurred example: '2025-05-15' format: date type: string required: - amount - description - event_date type: object AdvancedOrderRequest: properties: area_code: default: '' maxLength: 3 title: Area Code type: string comments: default: '' maxLength: 255 title: Comments type: string country_code: default: US maxLength: 2 minLength: 2 title: Country Code type: string customer_reference: default: '' title: Customer Reference type: string features: items: enum: - sms - mms - voice - fax - emergency title: Features type: array uniqueItems: true phone_number_type: default: local enum: - local - mobile - toll_free - shared_cost - national - landline type: string quantity: default: 1 maximum: 10000 minimum: 1 title: Quantity type: integer requirement_group_id: description: The ID of the requirement group to associate with this advanced order example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 format: uuid title: Requirement Group ID type: string title: AdvancedOrderRequest type: object AltBusinessIdType: description: An enumeration. enum: - NONE - DUNS - GIIN - LEI title: AltBusinessIdType type: string AmdDetailRecord: properties: billing_group_id: description: Billing Group id example: 01977831-abdd-4894-84f3-244385621424 type: string billing_group_name: description: Name of the Billing Group specified in billing_group_id example: Billing group name type: string call_leg_id: description: Telnyx UUID that identifies the related call leg example: 3ca7bd3d-7d82-4e07-9df4-009123068320 type: string call_session_id: description: Telnyx UUID that identifies the related call session example: 3ca7bd3d-7d82-4e07-9df4-009123068320 type: string connection_id: description: Connection id example: '1684947189014463919' type: string connection_name: description: Connection name example: Name of the connection with id specified in connection_id field 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 feature: description: Feature name enum: - PREMIUM type: string id: description: Feature invocation id example: 3ca7bd3d-7d82-4e07-9df4-009123068320 type: string invoked_at: description: Feature invocation time example: '2020-07-01T00:00:00Z' format: date-time type: string is_telnyx_billable: description: Indicates whether Telnyx billing charges might be applicable example: true type: boolean 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: invocations type: string record_type: default: amd_detail_record example: amd_detail_record type: string tags: description: User-provided tags example: tag1,tag2 type: string required: - record_type 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 send_silence_when_idle: true 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string custom_headers: description: Custom headers to be added to the SIP INVITE response. example: - name: head_1 value: val_1 - name: head_2 value: val_2 items: $ref: '#/components/schemas/CustomSipHeader' type: array preferred_codecs: description: The list of comma-separated codecs in a preferred order for the forked media to be received. enum: - G722,PCMU,PCMA,G729,OPUS,VP8,H264 example: G722,PCMU,PCMA,G729,OPUS,VP8,H264 type: string record: description: Start recording automatically after an event. Disabled by default. enum: - record-from-answer example: record-from-answer type: string record_channels: default: dual description: Defines which channel should be recorded ('single' or 'dual') when `record` is specified. enum: - single - dual example: single type: string record_custom_file_name: description: The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix. example: my_recording_file_name maxLength: 40 minLength: 1 type: string record_format: default: mp3 description: Defines the format of the recording ('wav' or 'mp3') when `record` is specified. enum: - wav - mp3 example: wav type: string record_max_length: default: 0 description: Defines the maximum length for the recording in seconds when `record` is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite). example: 1000 format: int32 type: integer record_timeout_secs: default: 0 description: The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when `record` is specified. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite). example: 100 format: int32 type: integer record_track: default: both description: The audio track to be recorded. Can be either `both`, `inbound` or `outbound`. If only single track is specified (`inbound`, `outbound`), `channels` configuration is ignored and it will be recorded as mono (single channel). enum: - both - inbound - outbound example: outbound type: string record_trim: description: When set to `trim-silence`, silence will be removed from the beginning and end of the recording. enum: - trim-silence example: trim-silence type: string send_silence_when_idle: default: false description: Generate silence RTP packets when no transmission available. example: true type: boolean sip_headers: description: SIP headers to be added to the SIP INVITE response. Currently only User-to-User header is supported. example: - name: User-to-User value: value items: $ref: '#/components/schemas/SipHeader' type: array sound_modifications: $ref: '#/components/schemas/SoundModifications' stream_bidirectional_codec: $ref: '#/components/schemas/StreamBidirectionalCodec' stream_bidirectional_mode: $ref: '#/components/schemas/StreamBidirectionalMode' stream_bidirectional_target_legs: $ref: '#/components/schemas/StreamBidirectionalTargetLegs' stream_codec: $ref: '#/components/schemas/StreamCodec' stream_track: default: inbound_track description: Specifies which track should be streamed. enum: - inbound_track - outbound_track - both_tracks example: both_tracks type: string stream_url: description: The destination WebSocket address where the stream is going to be delivered. example: wss://www.example.com/websocket type: string transcription: default: false description: Enable transcription upon call answer. The default value is false. example: true type: boolean transcription_config: $ref: '#/components/schemas/TranscriptionStartRequest' 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 AssignProfileToCampaignRequest: properties: campaignId: description: The ID of the campaign you want to link to the specified messaging profile. If you supply this ID in the request, do not also include a tcrCampaignId. example: 4b300178-131c-d902-d54e-72d90ba1620j title: Campaignid type: string messagingProfileId: description: The ID of the messaging profile that you want to link to the specified campaign. example: 4001767e-ce0f-4cae-9d5f-0d5e636e7809 title: Messagingprofileid type: string tcrCampaignId: description: The TCR ID of the shared campaign you want to link to the specified messaging profile (for campaigns not created using Telnyx 10DLC services only). If you supply this ID in the request, do not also include a campaignId. example: CWZTFH1 title: Tcrcampaignid type: string required: - messagingProfileId title: AssignProfileToCampaignRequest type: object AssignProfileToCampaignResponse: properties: campaignId: description: The ID of the campaign you want to link to the specified messaging profile. If you supply this ID in the request, do not also include a tcrCampaignId. example: 4b300178-131c-d902-d54e-72d90ba1620j title: Campaignid type: string messagingProfileId: description: The ID of the messaging profile that you want to link to the specified campaign. example: 4001767e-ce0f-4cae-9d5f-0d5e636e7809 title: Messagingprofileid type: string taskId: description: The ID of the task associated with assigning a messaging profile to a campaign. example: 667a80f8-b0a9-49d0-b9ab-a7a1bcc45086 title: Taskid type: string tcrCampaignId: description: The TCR ID of the shared campaign you want to link to the specified messaging profile (for campaigns not created using Telnyx 10DLC services only). If you supply this ID in the request, do not also include a campaignId. example: CWZTFH1 title: Tcrcampaignid type: string required: - messagingProfileId - taskId title: AssignProfileToCampaignResponse type: object AssignmentTaskStatusResponse: properties: createdAt: format: date-time title: Createdat type: string status: allOf: - $ref: '#/components/schemas/10dlc_TaskStatus' description: The status of the task associated with assigning a messaging profile to a campaign. example: pending type: string taskId: title: Taskid type: string updatedAt: format: date-time title: Updatedat type: string required: - taskId - status title: AssignmentTaskStatusResponse type: object Assistant: description: Assistant configuration including choice of LLM, custom instructions, and tools. properties: instructions: description: The system instructions that the voice assistant uses during the gather command example: You are a friendly voice assistant. type: string model: default: meta-llama/Meta-Llama-3.1-70B-Instruct description: The model to be used by the voice assistant. example: meta-llama/Meta-Llama-3.1-70B-Instruct type: string openai_api_key_ref: description: 'This is necessary only if the model selected is from OpenAI. You would pass the `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your OpenAI API Key. Warning: Free plans are unlikely to work with this integration.' example: my_openai_api_key type: string tools: description: The tools that the voice assistant can use. items: oneOf: - $ref: '#/components/schemas/BookAppointmentTool' - $ref: '#/components/schemas/CheckAvailabilityTool' - $ref: '#/components/schemas/WebhookTool' - $ref: '#/components/schemas/HangupTool' - $ref: '#/components/schemas/TransferTool' - $ref: '#/components/schemas/RetrievalTool' type: array title: Assistant type: object AssistantChatReq: properties: content: description: The message content sent by the client to the assistant example: Tell me a joke about cats title: Content type: string conversation_id: description: A unique identifier for the conversation thread, used to maintain context example: 42b20469-1215-4a9a-8964-c36f66b406f4 title: Conversation Id type: string name: description: The optional display name of the user sending the message example: Charlie title: Name type: string required: - content - conversation_id title: AssistantChatReq type: object AssistantChatResponse: properties: content: description: The assistant's generated response based on the input message and context. example: Why did the cat sit on the computer? Because it wanted to keep an eye on the mouse! title: Content type: string required: - content title: AssistantChatResponse type: object AssistantDeletedResponse: description: 'Aligns with the OpenAI API: https://platform.openai.com/docs/api-reference/assistants/deleteAssistant' properties: deleted: title: Deleted type: boolean id: title: Id type: string object: title: Object type: string required: - id - object - deleted title: AssistantDeletedResponse type: object AssistantTestResponse: description: 'Response model containing complete assistant test information. Returns all test configuration details including evaluation criteria, scheduling, and metadata. Used when retrieving individual tests or after creating/updating tests.' properties: created_at: description: Timestamp when the test was created. example: - '2024-01-15T09:00:00Z' format: date-time title: Created At type: string description: description: Detailed description of the test's purpose and scope. title: Description type: string destination: description: Target destination for test conversations. title: Destination type: string instructions: description: Detailed test scenario instructions and objectives. title: Instructions type: string max_duration_seconds: description: Maximum allowed duration for test execution in seconds. title: Max Duration Seconds type: integer name: description: Human-readable name of the test. example: Customer Support Bot Test title: Name type: string rubric: description: Evaluation criteria used to assess test performance. example: - - criteria: Responds within 30 seconds name: Response Time items: additionalProperties: false properties: criteria: description: "Specific guidance on how to assess the assistant\u2019\ s performance for this rubric item." type: string name: description: Label for the evaluation criterion, e.g., Empathy, Accuracy, Clarity. type: string required: - name - criteria type: object title: Rubric type: array telnyx_conversation_channel: allOf: - $ref: '#/components/schemas/TelnyxConversationChannel' description: Communication channel used for test execution. example: web_chat test_id: description: Unique identifier for the assistant test. example: 123e4567-e89b-12d3-a456-426614174000 format: uuid title: Test Id type: string test_suite: description: Test suite grouping for organizational purposes. title: Test Suite type: string required: - test_id - name - telnyx_conversation_channel - rubric - created_at title: AssistantTestResponse type: object AssistantTools: description: The tools that the assistant can use. These may be templated with [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) items: oneOf: - $ref: '#/components/schemas/WebhookTool' - $ref: '#/components/schemas/RetrievalTool' - $ref: '#/components/schemas/HandoffTool' - $ref: '#/components/schemas/HangupTool' - $ref: '#/components/schemas/TransferTool' - $ref: '#/components/schemas/SIPReferTool' - $ref: '#/components/schemas/DTMFTool' type: array AssistantsListData: properties: data: items: $ref: '#/components/schemas/inference-embedding_Assistant' title: Data type: array required: - data title: AssistantsListData type: object AudioTranscriptionRequest: properties: file: description: 'The audio file object to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot be used together with `file_url`' format: binary type: string file_url: description: 'Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. Support for hosted files is limited to 100MB. Cannot be used together with `file`' example: https://example.com/file.mp3 type: string model: default: distil-whisper/distil-large-v2 description: ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly higher latency. enum: - distil-whisper/distil-large-v2 - openai/whisper-large-v3-turbo example: distil-whisper/distil-large-v2 type: string response_format: default: json description: The format of the transcript output. Use `verbose_json` to take advantage of timestamps. enum: - json - verbose_json example: json type: string timestamp_granularities[]: description: The timestamp granularities to populate for this transcription. `response_format` must be set verbose_json to use timestamp granularities. Currently `segment` is supported. enum: - segment example: json type: string required: - model type: object AudioTranscriptionResponse: properties: duration: description: The duration of the audio file in seconds. This is only included if `response_format` is set to `verbose_json`. type: number segments: description: Segments of the transcribed text and their corresponding details. This is only included if `response_format` is set to `verbose_json`. items: $ref: '#/components/schemas/AudioTranscriptionResponseSegments' type: array text: description: The transcribed text for the audio file. type: string required: - text type: object AudioTranscriptionResponseSegments: properties: end: description: End time of the segment in seconds. type: number id: description: Unique identifier of the segment. type: number start: description: Start time of the segment in seconds. type: number text: description: Text content of the segment. type: string required: - id - start - end - text type: object AuditEventChanges: description: Details of the changes made to a resource. properties: field: description: The name of the field that was changed. May use the dot notation to indicate nested fields. example: nested.field.name type: string from: anyOf: - type: string - type: number - type: boolean - additionalProperties: true type: object - items: {} type: array description: The previous value of the field. Can be any JSON type. example: 54321 nullable: true to: anyOf: - type: string - type: number - type: boolean - additionalProperties: true type: object - items: {} type: array description: The new value of the field. Can be any JSON type. example: 12345 nullable: true title: Audit Event Changes type: object AuditLog: properties: alternate_resource_id: description: An alternate identifier for a resource which may be considered unique enough to identify the resource but is not the primary identifier for the resource. For example, this field could be used to store the phone number value for a phone number when the primary database identifier is a separate distinct value. example: '+14155551234' nullable: true type: string change_made_by: description: Indicates if the change was made by Telnyx on your behalf, the organization owner, a member of your organization, or in the case of managed accounts, the account manager. enum: - telnyx - account_manager - account_owner - organization_member example: organization_owner type: string change_type: description: The type of change that occurred. example: update type: string changes: description: Details of the changes made to the resource. example: - field: field.name from: new value to: old value items: $ref: '#/components/schemas/AuditEventChanges' nullable: true type: array created_at: description: ISO 8601 formatted date indicating when the change occurred. example: '2023-01-01T00:00:00Z' format: date-time type: string id: description: Unique identifier for the audit log entry. example: 550e8400-e29b-41d4-a716-446655440000 format: uuid type: string organization_id: description: Unique identifier for the organization that owns the resource. example: 550e8400-e29b-41d4-a716-446655440003 format: uuid type: string record_type: description: The type of the resource being audited. example: audit_event type: string resource_id: description: Unique identifier for the resource that was changed. example: 550e8400-e29b-41d4-a716-446655440002 type: string user_id: description: Unique identifier for the user who made the change. example: 550e8400-e29b-41d4-a716-446655440001 format: uuid type: string title: Audit Log Entry type: object AuditLogList: properties: data: items: $ref: '#/components/schemas/AuditLog' type: array meta: $ref: '#/components/schemas/audit-logs_PaginationMeta' title: Audit Log List 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' format: date-time 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 format: uri 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 format: uri 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 format: uri 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 format: uri 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' format: date-time 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 AuthorizationServerMetadata: properties: authorization_endpoint: description: Authorization endpoint URL format: uri type: string code_challenge_methods_supported: description: Supported PKCE code challenge methods items: type: string type: array grant_types_supported: description: Supported grant types items: type: string type: array introspection_endpoint: description: Token introspection endpoint URL format: uri type: string issuer: description: Authorization server issuer URL format: uri type: string jwks_uri: description: JWK Set endpoint URL format: uri type: string registration_endpoint: description: Dynamic client registration endpoint URL format: uri type: string response_types_supported: description: Supported response types items: type: string type: array scopes_supported: description: Supported OAuth scopes example: - admin items: type: string type: array token_endpoint: description: Token endpoint URL format: uri type: string token_endpoint_auth_methods_supported: description: Supported token endpoint authentication methods items: type: string type: array type: object AutoRechargePref: properties: enabled: description: Whether auto recharge is enabled. example: true type: boolean id: description: The unique identifier for the auto recharge preference. example: '1524126400473204723' type: string invoice_enabled: example: true type: boolean preference: description: The payment preference for auto recharge. enum: - credit_paypal - ach example: credit_paypal type: string recharge_amount: description: The amount to recharge the account, the actual recharge amount will be the amount necessary to reach the threshold amount plus the recharge amount. example: '104.00' format: decimal type: string record_type: description: The record type. example: auto_recharge_pref type: string threshold_amount: description: The threshold amount at which the account will be recharged. example: '104.00' format: decimal type: string type: object AutoRechargePrefRequest: properties: enabled: description: Whether auto recharge is enabled. example: true type: boolean invoice_enabled: example: true type: boolean preference: description: The payment preference for auto recharge. enum: - credit_paypal - ach example: credit_paypal type: string recharge_amount: description: The amount to recharge the account, the actual recharge amount will be the amount necessary to reach the threshold amount plus the recharge amount. example: '104.00' format: decimal type: string threshold_amount: description: The threshold amount at which the account will be recharged. example: '104.00' format: decimal type: string type: object AutoRespConfigCreateSchema: properties: country_code: example: US title: Country Code type: string keywords: example: - keyword1 - keyword2 items: type: string title: Keywords type: array op: enum: - start - stop - info title: Op type: string resp_text: example: Thank you for your message title: Resp Text type: string required: - op - keywords - country_code title: AutoRespConfigCreateSchema type: object AutorespConfigResponseSchema: properties: data: $ref: '#/components/schemas/AutorespConfigSchema' required: - data title: AutorespConfigResponseSchema type: object AutorespConfigSchema: properties: country_code: example: '*' title: Country Code type: string created_at: format: date-time title: Created At type: string id: example: b8f9c1c0-5b5a-4b1e-8c1c-0b5a4b1e8c1c title: Id type: string keywords: example: - START - BEGIN items: type: string title: Keywords type: array op: enum: - start - stop - info example: start title: Op type: string resp_text: example: Thank you for subscribing to our service. title: Resp Text type: string updated_at: format: date-time title: Updated At type: string required: - op - keywords - country_code - id - created_at - updated_at title: AutorespConfigSchema type: object AutorespConfigsResponseSchema: description: List of Auto-Response Settings properties: data: items: $ref: '#/components/schemas/AutorespConfigSchema' title: Data type: array meta: $ref: '#/components/schemas/PaginationMeta' required: - data - meta title: AutorespConfigsResponseSchema 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 AvailableService: enum: - cloud_vpn - private_wireless_gateway - virtual_cross_connect title: Available service type: string AwsAccessKeyId: description: AWS credentials access key id. example: AKIAIOSFODNN7EXAMPLE type: string AwsSecretAccessKey: description: AWS secret access key. example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY type: string AzureAccountKey: description: Azure Blob Storage account key. example: bPxRfiCYEXAMPLEKEY type: string AzureAccountName: description: Azure Blob Storage account name. example: my-account type: string AzureConfigurationData: properties: account_key: $ref: '#/components/schemas/AzureAccountKey' account_name: $ref: '#/components/schemas/AzureAccountName' bucket: $ref: '#/components/schemas/Bucket' title: Azure Blob Storage Configuration Data type: object BackgroundTaskStatus: description: Status of an embeddings task. enum: - queued - processing - success - failure - partial_success title: BackgroundTaskStatus type: string BackgroundTasksQueryResponse: properties: bucket: title: Bucket type: string created_at: format: date-time title: Created At type: string finished_at: format: date-time title: Finished At type: string status: $ref: '#/components/schemas/BackgroundTaskStatus' task_id: title: Task Id type: string task_name: title: Task Name type: string user_id: title: User Id type: string required: - user_id - task_id - task_name - status - created_at title: BackgroundTasksQueryResponse type: object BackgroundTasksQueryResponseData: properties: data: items: $ref: '#/components/schemas/BackgroundTasksQueryResponse' title: Data type: array required: - data title: BackgroundTasksQueryResponseData type: object BillingBundleResponse: properties: data: $ref: '#/components/schemas/BillingBundleSchema' required: - data title: BillingBundleResponse type: object BillingBundleSchema: properties: active: description: If that bundle is active or not. title: Active type: boolean bundle_limits: items: $ref: '#/components/schemas/BundleLimitSchema' title: Bundle Limits type: array cost_code: description: Bundle's cost code, this is used to identify the bundle in the billing system. example: BUNDLE-PRICING-BASIC-MRC title: Cost Code type: string created_at: description: Date the bundle was created. format: date title: Created At type: string id: description: Bundle's ID, this is used to identify the bundle in the API. example: 7ecd040e-6bac-4139-9160-3c0427d98fea format: uuid title: Id type: string is_public: description: Available to all customers or only to specific customers. title: Is Public type: boolean name: description: Bundle's name, this is used to identify the bundle in the UI. example: Australia Basic title: Name type: string slug: description: Slugified version of the bundle's name. example: basic-au-e4f8 title: Slug type: string required: - id - name - cost_code - active - is_public - created_at - bundle_limits title: BillingBundleSchema type: object BillingBundleSummary: properties: cost_code: description: Bundle's cost code, this is used to identify the bundle in the billing system. example: BUNDLE-PRICING-BASIC-MRC title: Cost Code type: string created_at: description: Date the bundle was created. format: date title: Created At type: string currency: description: Bundle's currency code. example: USD title: Currency type: string id: description: Bundle's ID, this is used to identify the bundle in the API. example: 7ecd040e-6bac-4139-9160-3c0427d98fea format: uuid title: Id type: string is_public: description: Available to all customers or only to specific customers. title: Is Public type: boolean mrc_price: description: Monthly recurring charge price. example: 2.0 format: float title: Mrc Price type: number name: description: Bundle's name, this is used to identify the bundle in the UI. example: Australia Basic title: Name type: string slug: description: Slugified version of the bundle's name. example: basic-au-e4f8 title: Slug type: string specs: example: - 1 AU Number - Emergency Calling - All inbound and outbound calling billed pay-as-you-go items: type: string title: Specs type: array required: - id - name - cost_code - is_public - created_at title: BillingBundleSummary 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 nullable: true 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 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 BlackBoxTestResult: properties: id: description: The name of the black box test. example: msg_overview_outbound_sms type: string record_type: example: black_box_test type: string result: description: The average result of the black box test over the last hour. example: 0.999 type: number type: object BlackBoxTestResultSet: properties: black_box_tests: items: $ref: '#/components/schemas/BlackBoxTestResult' type: array product: description: The product associated with the black box test group. example: cloud_storage type: string record_type: example: black_box_test_result type: string type: object BookAppointmentTool: properties: book_appointment: $ref: '#/components/schemas/BookAppointmentToolParams' type: enum: - book_appointment type: string required: - type - book_appointment title: BookAppointmentTool type: object BookAppointmentToolParams: properties: api_key_ref: description: Reference to an integration secret that contains your Cal.com API key. You would pass the `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your Cal.com API key. example: my_calcom_api_key type: string attendee_name: description: The name of the attendee [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-name). If not provided, the assistant will ask for the attendee's name. type: string attendee_timezone: description: The timezone of the attendee [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-attendee-timezone). If not provided, the assistant will ask for the attendee's timezone. type: string event_type_id: description: Event Type ID for which slots are being fetched. [cal.com](https://cal.com/docs/api-reference/v2/bookings/create-a-booking#body-event-type-id) type: integer required: - event_type_id - api_key_ref title: BookAppointmentToolParams type: object BrandBasic: properties: assignedCampaingsCount: description: Number of campaigns associated with the brand example: 2 type: integer brandId: description: Unique identifier assigned to the brand. example: 4b206179-f731-8ab7-f19c-34e19d22ide9 type: string companyName: description: (Required for Non-profit/private/public) Legal company name. example: Example Company Inc. type: string createdAt: description: Date and time that the brand was created at. example: '2021-03-08T17:57:48.801186' type: string displayName: description: Display or marketing name of the brand. example: Example Company type: string email: description: Valid email address of brand support contact. example: examplename@examplecompany.com type: string entityType: $ref: '#/components/schemas/EntityType' failureReasons: description: Failure reasons for brand title: failureReasons type: string identityStatus: $ref: '#/components/schemas/BrandIdentityStatus' status: description: Status of the brand enum: - OK - REGISTRATION_PENDING - REGISTRATION_FAILED title: status type: string tcrBrandId: description: Unique identifier assigned to the brand by the registry. example: BBRAND1 type: string updatedAt: description: Date and time that the brand was last updated at. example: '2021-03-08T17:57:48.801186' type: string website: description: Brand website URL. example: www.examplecompany.com type: string title: ListedBrand type: object BrandFeedback: properties: brandId: description: ID of the brand being queried about example: d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5 title: Brandid type: string category: description: A list of reasons why brand creation/revetting didn't go as planned items: $ref: '#/components/schemas/BrandFeedbackCategory' title: Category type: array required: - brandId - category title: BrandFeedback type: object BrandFeedbackCategory: properties: description: description: Long-form description of the feedback with additional information example: Tax Id does not match with the company name or business type. title: Description type: string displayName: description: Human-readable version of the `id` field example: Tax Id title: Displayname type: string fields: description: List of relevant fields in the originally-submitted brand json example: - ein - companyName - entityType items: type: string title: Fields type: array id: description: One of `TAX_ID`, `STOCK_SYMBOL`, `GOVERNMENT_ENTITY`, `NONPROFIT`, and `OTHERS` example: TAX_ID title: Id type: string required: - id - displayName - description - fields title: BrandFeedbackCategory type: object BrandIdentityStatus: description: The verification status of an active brand enum: - VERIFIED - UNVERIFIED - SELF_DECLARED - VETTED_VERIFIED title: BrandIdentityStatus type: string BrandOptionalAttributes: properties: taxExemptStatus: description: The tax exempt status of the brand title: Taxexemptstatus type: string title: BrandOptionalAttributes type: object BrandRecordSetCSP: properties: page: example: 1 title: Page type: integer records: items: $ref: '#/components/schemas/BrandBasic' title: Records type: array totalRecords: example: 1 title: Totalrecords type: integer title: BrandRecordSetCSP type: object BrandRelationship: description: Brand relationship to the CSP. enum: - BASIC_ACCOUNT - SMALL_ACCOUNT - MEDIUM_ACCOUNT - LARGE_ACCOUNT - KEY_ACCOUNT title: BrandRelationship type: string BreakdownData: properties: currency: description: Currency code example: USD type: string end_date: description: End date of the breakdown period example: '2025-06-01' format: date type: string results: description: List of phone number charge breakdowns items: $ref: '#/components/schemas/NumberBreakdownResult' type: array start_date: description: Start date of the breakdown period example: '2025-05-01' format: date type: string user_email: description: User email address example: user@example.com format: email type: string user_id: description: User identifier example: 0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8 type: string required: - user_id - start_date - end_date - user_email - currency - results type: object BridgeRequest: example: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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, can't be used together with queue parameter or video_room_id parameter. example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string mute_dtmf: default: none description: When enabled, DTMF tones are not passed to the call participant. The webhooks containing the DTMF information will be sent. enum: - none - both - self - opposite example: opposite 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 play_ringtone: default: false description: Specifies whether to play a ringtone if the call you want to bridge with has not yet been answered. example: true type: boolean queue: description: The name of the queue you want to bridge with, can't be used together with call_control_id parameter or video_room_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 record: description: Start recording automatically after an event. Disabled by default. enum: - record-from-answer example: record-from-answer type: string record_channels: default: dual description: Defines which channel should be recorded ('single' or 'dual') when `record` is specified. enum: - single - dual example: single type: string record_custom_file_name: description: The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix. example: my_recording_file_name maxLength: 40 minLength: 1 type: string record_format: default: mp3 description: Defines the format of the recording ('wav' or 'mp3') when `record` is specified. enum: - wav - mp3 example: wav type: string record_max_length: default: 0 description: Defines the maximum length for the recording in seconds when `record` is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite). example: 1000 format: int32 type: integer record_timeout_secs: default: 0 description: The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when `record` is specified. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite). example: 100 format: int32 type: integer record_track: default: both description: The audio track to be recorded. Can be either `both`, `inbound` or `outbound`. If only single track is specified (`inbound`, `outbound`), `channels` configuration is ignored and it will be recorded as mono (single channel). enum: - both - inbound - outbound example: outbound type: string record_trim: description: When set to `trim-silence`, silence will be removed from the beginning and end of the recording. enum: - trim-silence example: trim-silence type: string ringtone: default: us description: Specifies which country ringtone to play when `play_ringtone` is set to `true`. If not set, the US ringtone will be played. enum: - at - au - be - bg - br - ch - cl - cn - cz - de - dk - ee - es - fi - fr - gr - hu - il - in - it - jp - lt - mx - my - nl - 'no' - nz - ph - pl - pt - ru - se - sg - th - tw - uk - us-old - us - ve - za example: pl type: string video_room_context: description: The additional parameter that will be passed to the video conference. It is a text field and the user can decide how to use it. For example, you can set the participant name or pass JSON text. It can be used only with video_room_id parameter. example: Alice type: string video_room_id: description: The ID of the video room you want to bridge with, can't be used together with call_control_id parameter or queue parameter. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string required: - call_control_id title: Bridge Request type: object Bucket: description: Name of the bucket to be used to store recording files. example: example-bucket type: string BucketAPIUsageResponse: properties: categories: items: $ref: '#/components/schemas/BucketOps' type: array timestamp: description: The time the usage was recorded example: - '2020-01-01T00:00:00Z' format: date-time type: string total: $ref: '#/components/schemas/BucketOpsTotal' type: object BucketIds: properties: bucket_ids: items: type: string title: Bucket Ids type: array max_num_results: description: The maximum number of results to retrieve as context for the language model. type: integer required: - bucket_ids title: BucketIds type: object BucketNotFoundError: properties: detail: items: $ref: '#/components/schemas/NotFoundError' title: Detail type: array title: HTTPValidationError type: object BucketOps: properties: bytes_received: description: The number of bytes received example: - 123456 type: integer bytes_sent: description: The number of bytes sent example: - 123456 type: integer category: description: The category of the bucket operation enum: - list_bucket - list_buckets - get-bucket_location - create_bucket - stat_bucket - get_bucket_versioning - set_bucket_versioning - get_obj - put_obj - delete_obj example: - put_obj type: string ops: description: The number of operations example: - 123456 type: integer successful_ops: description: The number of successful operations example: - 123456 type: integer type: object BucketOpsTotal: properties: bytes_received: description: The number of bytes received example: - 123456 type: integer bytes_sent: description: The number of bytes sent example: - 123456 type: integer ops: description: The number of operations example: - 123456 type: integer successful_ops: description: The number of successful operations example: - 123456 type: integer type: object BucketUsage: properties: num_objects: description: The number of objects in the bucket example: - 123456 type: integer size: description: The size of the bucket in bytes example: - 123456 type: integer size_kb: description: The size of the bucket in kilobytes example: - 123456 type: integer timestamp: description: The time the snapshot was taken example: - '2020-01-01T00:00:00Z' format: date-time type: string type: object BulkMessagingSettingsUpdatePhoneNumbers: example: failed: [] order_id: 00000000-0000-0000-0000-000000000000 pending: [] record_type: messaging_numbers_bulk_update success: - '+18880000000' - '+18880000001' - '+18880000002' properties: failed: description: Phone numbers that failed to update. items: format: +E.164 type: string type: array order_id: description: Order ID to verify bulk update status. format: uuid readOnly: true type: string pending: description: Phone numbers pending to be updated. items: format: +E.164 type: string type: array record_type: description: Identifies the type of the resource. enum: - messaging_numbers_bulk_update example: messaging_numbers_bulk_update readOnly: true type: string success: description: Phoned numbers updated successfully. items: format: +E.164 type: string type: array type: object BulkMessagingSettingsUpdatePhoneNumbersRequest: example: messaging_profile_id: 00000000-0000-0000-0000-000000000000 numbers: - '+18880000000' - '+18880000001' - '+18880000002' properties: messaging_profile_id: description: 'Configure the messaging profile these phone numbers are assigned to: * Set this field to `""` to unassign each number from their respective messaging profile * Set this field to a quoted UUID of a messaging profile to assign these numbers to that messaging profile' type: string numbers: description: The list of phone numbers to update. items: format: +E.164 type: string type: array required: - messaging_profile_id - numbers type: object BulkSIMCardAction: description: This object represents a bulk SIM card action. It groups SIM card actions created through a bulk endpoint under a single resource for further lookup. properties: action_type: description: 'The operation type. It can be one of the following: <br/> <ul> <li><code>bulk_set_public_ips</code> - set a public IP for each specified SIM card.</li> </ul>' enum: - bulk_set_public_ips example: bulk_set_public_ips readOnly: true type: string created_at: $ref: '#/components/schemas/wireless_CreatedAt' id: $ref: '#/components/schemas/wireless_Id' record_type: example: bulk_sim_card_action readOnly: true type: string settings: additionalProperties: true description: A JSON object representation of the bulk action payload. example: {} readOnly: true type: object updated_at: $ref: '#/components/schemas/wireless_UpdatedAt' type: object BulkSIMCardActionDetailed: properties: action_type: description: 'The operation type. It can be one of the following: <br/> <ul> <li><code>bulk_set_public_ips</code> - set a public IP for each specified SIM card.</li> </ul>' enum: - bulk_set_public_ips example: bulk_set_public_ips readOnly: true type: string created_at: $ref: '#/components/schemas/wireless_CreatedAt' id: $ref: '#/components/schemas/wireless_Id' record_type: example: bulk_sim_card_action readOnly: true type: string settings: additionalProperties: true description: A JSON object representation of the bulk action payload. example: {} readOnly: true type: object sim_card_actions_summary: items: $ref: '#/components/schemas/SIMCardActionsSummary' type: array updated_at: $ref: '#/components/schemas/wireless_UpdatedAt' type: object BundleLimitDirection: description: An enumeration. enum: - inbound - outbound title: BundleLimitDirection type: string BundleLimitSchema: properties: billing_service: example: emergency title: Billing Service type: string country: deprecated: true description: Use country_iso instead title: Country type: string country_code: example: 61 title: Country Code type: integer country_iso: example: AU title: Country Iso type: string created_at: format: date title: Created At type: string direction: $ref: '#/components/schemas/BundleLimitDirection' id: example: e6a32ea9-953b-4622-bbba-9f7bcf7e6717 format: uuid title: Id type: string limit: example: 1 title: Limit type: integer metric: example: number title: Metric type: string rate: example: '5' title: Rate type: string service: example: E911 title: Service type: string types: items: example: local type: string title: Types type: array updated_at: format: date title: Updated At type: string required: - id - service - metric - created_at - updated_at title: BundleLimitSchema type: object Call: example: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_duration: 50 call_leg_id: 2dc6fc34-f9e0-11ea-b68e-02420a0f7768 call_session_id: 2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d end_time: '2019-01-23T18:11:52.574Z' is_alive: false record_type: call start_time: '2019-01-23T18:10:02.574Z' properties: call_control_id: description: Unique identifier and token for controlling the call. example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg type: string call_duration: description: Indicates the duration of the call in seconds example: 50 type: integer 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call example: 428c31b6-7af4-4bcb-b68e-5013ef9657c1 type: string client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string end_time: description: ISO 8601 formatted date indicating when the call ended. Only present when the call is not alive example: '2019-01-23T18:11:52.574Z' 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 start_time: description: ISO 8601 formatted date indicating when the call started example: '2019-01-23T18:10:02.574Z' type: string required: - call_control_id - call_leg_id - call_session_id - is_alive - record_type title: Call type: object CallAIGatherEnded: example: event_type: call.ai_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 from: '+35319605860' message_history: - content: Hello, can you tell me your age and where you live? role: assistant - content: Hello, I'm 29 and I live in Paris? role: user result: age: 29 city: Paris status: valid to: '+35319605860' record_type: event properties: event_type: description: The type of event being delivered. enum: - call.ai_gather.ended example: call.ai_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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 from: description: Number or SIP URI placing the call. example: '+35319605860' type: string message_history: description: The history of the messages exchanged during the AI gather items: properties: content: description: The content of the message example: Hello, I'm 29 and I live in Paris. type: string role: description: The role of the message sender enum: - assistant - user example: user type: string type: object type: array result: description: The result of the AI gather, its type depends of the `parameters` provided in the command example: age: 29 city: Paris type: object status: description: Reflects how command ended. enum: - valid - invalid 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 AI Gather Ended type: object CallAIGatherEndedEvent: properties: data: $ref: '#/components/schemas/CallAIGatherEnded' title: Call AI Gather Ended Event type: object CallAIGatherMessageHistoryUpdated: example: event_type: call.ai_gather.message_history_updated 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' message_history: - content: Hello, can you tell me your age and where you live? role: assistant - content: Hello, I'm 29 and I live in Paris? role: user to: '+35319605860' record_type: event properties: event_type: description: The type of event being delivered. enum: - call.ai_gather.message_history_updated example: call.ai_gather.message_history_updated 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 from: description: Number or SIP URI placing the call. example: '+35319605860' type: string message_history: description: The history of the messages exchanged during the AI gather items: properties: content: description: The content of the message example: Hello, I'm 29 and I live in Paris. type: string role: description: The role of the message sender enum: - assistant - user example: user type: string type: object type: array 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 AI Gather Message History Updated type: object CallAIGatherMessageHistoryUpdatedEvent: properties: data: $ref: '#/components/schemas/CallAIGatherMessageHistoryUpdated' title: Call AI Gather Message History Updated Event type: object CallAIGatherPartialResults: example: event_type: call.ai_gather.partial_results 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' message_history: - content: Hello, can you tell me your age and where you live? role: assistant - content: Hello, I'm 29 and I live in Paris? role: user partial_results: age: 29 city: Paris to: '+35319605860' record_type: event properties: event_type: description: The type of event being delivered. enum: - call.ai_gather.partial_results example: call.ai_gather.partial_results 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 from: description: Number or SIP URI placing the call. example: '+35319605860' type: string message_history: description: The history of the messages exchanged during the AI gather items: properties: content: description: The content of the message example: Hello, I'm 29 and I live in Paris. type: string role: description: The role of the message sender enum: - assistant - user example: user type: string type: object type: array partial_results: description: The partial result of the AI gather, its type depends of the `parameters` provided in the command example: age: 29 city: Paris type: object 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 AI Gather Partial Results type: object CallAIGatherPartialResultsEvent: properties: data: $ref: '#/components/schemas/CallAIGatherPartialResults' title: Call AI Gather Partial Results Event 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx from: '+35319605860' start_time: '2018-02-02T22:25:27.521992Z' 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 custom_headers: description: Custom headers set on answer command example: - name: head_1 value: val_1 - name: head_2 value: val_2 items: $ref: '#/components/schemas/CustomSipHeader' type: array from: description: Number or SIP URI placing the call. example: '+35319605860' type: string sip_headers: description: User-to-User and Diversion headers from sip invite. example: - name: User-to-User value: '1234' - name: Diversion value: <sip:111@192.168.1.1> items: $ref: '#/components/schemas/SipHeader' type: array 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: - answered example: answered type: string tags: description: Array of tags associated to number. example: - tag-01 - tag-02 items: type: string type: array 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 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 shaken_stir_enabled: true sip_subdomain: example sip_subdomain_receive_settings: only_my_connections outbound: channel_limit: 10 outbound_voice_profile_id: '1293384261075731499' record_type: call_control_application redact_dtmf_debug_logging: true 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 redact_dtmf_debug_logging: default: false description: When enabled, DTMF digits entered by users will be redacted in debug logs to protect PII data entered through IVR interactions. example: true type: boolean tags: description: Tags assigned to the Call Control Application. items: type: string type: array 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 shaken_stir_enabled: default: false description: When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls. example: false type: boolean 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 CallControlCommandResultWithConversationId: example: conversation_id: d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a result: ok properties: conversation_id: description: The ID of the conversation created by the command. example: d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a format: uuid type: string result: example: ok type: string title: Call Control Command Result With Conversation ID type: object CallControlCommandResultWithRecordingId: example: recording_id: d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a result: ok properties: recording_id: description: The ID of the recording. Only present when the record parameter is set to record-from-answer. example: d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a format: uuid type: string result: example: ok type: string title: Call Control Command Result With Recording ID type: object CallControlId: example: v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA type: string CallCost: properties: event_type: description: The type of the event being delivered enum: - call.cost example: call.cost type: string id: description: Uniquely identifies a webhook example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string meta: properties: meta: properties: attempt: description: The number of attempts made to deliver the webhook example: 1 minimum: 1 type: integer delivered_to: description: The URL where webhook was sent example: https://example.com type: string type: object type: object 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: billed_duration_secs: description: The number of seconds for which this call will be billed example: 0 minimum: 0 type: integer call_control_id: description: Call ID used to issue commands via Call Control API. example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 cost_parts: items: properties: billed_duration_secs: description: The number of seconds for which this item will be billed example: 0 minimum: 0 type: integer call_part: description: The service incurring a charge example: call-control type: string cost: description: The billed cost of the item, in currency shown in the `currency` field example: 0.0 minimum: 0.0 type: number currency: description: The currency in which `cost` is measured example: USD type: string rate: description: The cost per unit of the item incurring a charge example: 0.001 minimum: 0.0 type: number type: object type: array status: description: Reflects how command ended. enum: - valid - invalid - call_hangup - cancelled - cancelled_amd example: valid type: string total_cost: description: The billed cost of the call example: 0.0 minimum: 0.0 type: number type: object record_type: description: Identifies the type of resource. enum: - event example: event type: string title: Call Cost Received Event 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 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 queue_avg_wait_time_secs: description: Average time call spends in the queue in seconds. example: 60 type: integer 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_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx stream_type: decrypted 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_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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 stream_type: description: Type of media streamed. It can be either 'raw' or 'decrypted'. enum: - decrypted example: decrypted 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_control_id: v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx stream_type: decrypted 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_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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 stream_type: description: Type of media streamed. It can be either 'raw' or 'decrypted'. enum: - decrypted example: decrypted 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 - timeout 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 call_quality_stats: inbound: jitter_max_variance: '2.74' jitter_packet_count: '0' mos: '4.50' packet_count: '591' skip_packet_count: '9' outbound: packet_count: '0' skip_packet_count: '0' 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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_quality_stats: description: Call quality statistics aggregated from the CHANNEL_HANGUP_COMPLETE event. Only includes metrics that are available (filters out nil values). Returns nil if no metrics are available. example: inbound: jitter_max_variance: '2.74' jitter_packet_count: '0' mos: '4.50' packet_count: '591' skip_packet_count: '9' outbound: packet_count: '0' skip_packet_count: '0' nullable: true properties: inbound: description: Inbound call quality statistics. properties: jitter_max_variance: description: Maximum jitter variance for inbound audio. example: '2.74' type: string jitter_packet_count: description: Number of packets used for jitter calculation on inbound audio. example: '0' type: string mos: description: Mean Opinion Score (MOS) for inbound audio quality. example: '4.50' type: string packet_count: description: Total number of inbound audio packets. example: '591' type: string skip_packet_count: description: Number of skipped inbound packets (packet loss). example: '9' type: string type: object outbound: description: Outbound call quality statistics. properties: packet_count: description: Total number of outbound audio packets. example: '0' type: string skip_packet_count: description: Number of skipped outbound packets (packet loss). example: '0' type: string type: object type: object call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 custom_headers: description: Custom headers set on answer command example: - name: head_1 value: val_1 - name: head_2 value: val_2 items: $ref: '#/components/schemas/CustomSipHeader' type: array 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 sip_headers: description: User-to-User and Diversion headers from sip invite. example: - name: User-to-User value: '1234' - name: Diversion value: <sip:111@192.168.1.1> items: $ref: '#/components/schemas/SipHeader' type: array 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 tags: description: Array of tags associated to number. example: - tag-01 - tag-02 items: type: string type: array 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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_screening_result: description: Call screening result. example: spam_likely type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1 type: string caller_id_name: description: Caller id. example: '+35319605860' type: string client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string connection_codecs: description: The list of comma-separated codecs enabled for the connection. example: G722,PCMU,PCMA type: string connection_id: description: Call Control App ID (formerly Telnyx connection ID) used in the call. example: 7267xxxxxxxxxxxxxx type: string custom_headers: description: Custom headers from sip invite example: - name: head_1 value: val_1 - name: head_2 value: val_2 items: $ref: '#/components/schemas/CustomSipHeader' type: array 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 offered_codecs: description: The list of comma-separated codecs offered by caller. example: G722,PCMU,PCMA type: string shaken_stir_attestation: description: SHAKEN/STIR attestation level. example: A type: string shaken_stir_validated: description: Whether attestation was successfully validated or not. example: true type: boolean sip_headers: description: User-to-User and Diversion headers from sip invite. example: - name: User-to-User value: '1234' - name: Diversion value: <sip:111@192.168.1.1> items: $ref: '#/components/schemas/SipHeader' type: array start_time: description: ISO 8601 datetime of when the call started. example: '2018-02-02T22:25:27.521992Z' format: date-time type: string state: description: State received from a command. enum: - parked - bridging example: parked type: string tags: description: Array of tags associated to number. example: - tag-01 - tag-02 items: type: string type: array 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.dequeued id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 occurred_at: '2018-02-02T22:25:27.521992Z' payload: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx queue: support queue_position: 3 reason: leave record_type: event properties: event_type: description: The type of event being delivered. enum: - call.dequeued example: call.dequeued 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 queue: description: The name of the queue example: support type: string queue_position: description: Last position of the call in the queue. example: 7 type: integer reason: description: The reason for leaving the queue enum: - bridged - bridging-in-process - hangup - leave - timeout example: bridged type: string wait_time_secs: description: Time call spent in the queue in seconds. example: 60 type: integer 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: - beep_detected - 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 CallMachinePremiumDetectionEnded: example: event_type: call.machine.premium.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: machine to: '+35319605860' record_type: event properties: event_type: description: The type of event being delivered. enum: - call.machine.premium.detection.ended example: call.machine.premium.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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: Premium Answering Machine Detection result. enum: - human_residence - human_business - machine - silence - fax_detected - 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 Premium Detection Ended type: object CallMachinePremiumDetectionEndedEvent: properties: data: $ref: '#/components/schemas/CallMachinePremiumDetectionEnded' title: Call Machine Premium Detection Ended Event type: object CallMachinePremiumGreetingEnded: example: event_type: call.machine.premium.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: beep_detected to: '+35319605860' record_type: event properties: event_type: description: The type of event being delivered. enum: - call.machine.premium.greeting.ended example: call.machine.premium.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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: Premium Answering Machine Greeting Ended result. enum: - beep_detected - no_beep_detected example: beep_detected 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 Premium Greeting Ended type: object CallMachinePremiumGreetingEndedEvent: properties: data: $ref: '#/components/schemas/CallMachinePremiumGreetingEnded' title: Call Machine Premium 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: completed 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 stopped audio was in overlay mode or not. example: false type: boolean status: description: Reflects how command ended. enum: - file_not_found - call_hangup - unknown - cancelled - cancelled_amd - completed - failed example: completed type: string status_detail: description: Provides details in case of failure. example: Received curl error 22 HTTP error code 404 trying to fetch http://mediaurl.com. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 Refer Completed 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 Refer Failed 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 bridge_intent: true bridge_on_answer: true client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 conference_config: conference_name: telnyx-conference start_conference_on_enter: true connection_id: 7267xxxxxxxxxxxxxx custom_headers: - name: head_1 value: val_1 - name: head_2 value: val_2 dialogflow_config: analyze_sentiment: false partial_automated_agent_reply: false enable_dialogflow: false from: '+18005550101' from_display_name: Company Name link_to: ilditnZK_eVysupV21KzmzN_sM29ygfauQojpm4BgFtfX5hXAcjotg== media_encryption: SRTP send_silence_when_idle: true sip_auth_password: password sip_auth_username: username sip_headers: - name: User-to-User value: '12345' sip_transport_protocol: TLS stream_track: both_tracks stream_url: wss://www.example.com/websocket 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. Telnyx offers Premium and Standard detections. With Premium detection, when a call is answered, Telnyx runs real-time detection and sends a `call.machine.premium.detection.ended` webhook with one of the following results: `human_residence`, `human_business`, `machine`, `silence` or `fax_detected`. If we detect a beep, we also send a `call.machine.premium.greeting.ended` webhook with the result of `beep_detected`. If we detect a beep before `call.machine.premium.detection.ended` we only send `call.machine.premium.greeting.ended`, and if we detect a beep after `call.machine.premium.detection.ended`, we send both webhooks. With Standard 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: - premium - 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 bridge_intent: default: false description: Indicates the intent to bridge this call with the call specified in link_to. When bridge_intent is true, link_to becomes required and the from number will be overwritten by the from number from the linked call. example: true type: boolean bridge_on_answer: default: false description: Whether to automatically bridge answered call to the call specified in link_to. When bridge_on_answer is true, link_to becomes required. example: true type: boolean 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 others Dial commands with the same `command_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string conference_config: description: Optional configuration parameters to dial new participant into a conference. 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 conference_name: description: Conference name to be joined example: telnyx-conference type: string early_media: default: true description: Controls the moment when dialled call is joined into conference. If set to `true` user will be joined as soon as media is available (ringback). If `false` user will be joined when call is answered. Defaults to `true` example: false type: boolean 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 id: description: Conference ID to be joined example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid 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_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 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 type: object 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 dialogflow_config: $ref: '#/components/schemas/DialogflowConfig' enable_dialogflow: default: false description: Enables Dialogflow for the current call. The default value is false. example: true type: boolean 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. 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_encryption: default: disabled description: Defines whether media should be encrypted on the call. enum: - disabled - SRTP - DTLS 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 preferred_codecs: description: The list of comma-separated codecs in a preferred order for the forked media to be received. example: G722,PCMU,PCMA,G729,OPUS,VP8,H264 type: string record: description: Start recording automatically after an event. Disabled by default. enum: - record-from-answer example: record-from-answer type: string record_channels: default: dual description: Defines which channel should be recorded ('single' or 'dual') when `record` is specified. enum: - single - dual example: single type: string record_custom_file_name: description: The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix. example: my_recording_file_name maxLength: 40 minLength: 1 type: string record_format: default: mp3 description: Defines the format of the recording ('wav' or 'mp3') when `record` is specified. enum: - wav - mp3 example: wav type: string record_max_length: default: 0 description: Defines the maximum length for the recording in seconds when `record` is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite). example: 1000 format: int32 type: integer record_timeout_secs: default: 0 description: The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when `record` is specified. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite). example: 100 format: int32 type: integer record_track: default: both description: The audio track to be recorded. Can be either `both`, `inbound` or `outbound`. If only single track is specified (`inbound`, `outbound`), `channels` configuration is ignored and it will be recorded as mono (single channel). enum: - both - inbound - outbound example: outbound type: string record_trim: description: When set to `trim-silence`, silence will be removed from the beginning and end of the recording. enum: - trim-silence example: trim-silence type: string send_silence_when_idle: default: false description: Generate silence RTP packets when no transmission available. example: true type: boolean 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 sip_headers: description: SIP headers to be added to the SIP INVITE request. Currently only User-to-User header is supported. example: - name: User-to-User value: value items: $ref: '#/components/schemas/SipHeader' type: array sip_transport_protocol: default: UDP description: Defines SIP transport protocol to be used on the call. enum: - UDP - TCP - TLS type: string sound_modifications: $ref: '#/components/schemas/SoundModifications' stream_bidirectional_codec: $ref: '#/components/schemas/StreamBidirectionalCodec' stream_bidirectional_mode: $ref: '#/components/schemas/StreamBidirectionalMode' stream_bidirectional_sampling_rate: $ref: '#/components/schemas/StreamBidirectionalSamplingRate' stream_bidirectional_target_legs: $ref: '#/components/schemas/StreamBidirectionalTargetLegs' stream_codec: $ref: '#/components/schemas/StreamCodec' stream_establish_before_call_originate: default: false description: Establish websocket connection before dialing the destination. This is useful for cases where the websocket connection takes a long time to establish. example: true type: boolean stream_track: default: inbound_track description: Specifies which track should be streamed. enum: - inbound_track - outbound_track - both_tracks example: both_tracks type: string stream_url: description: The destination WebSocket address where the stream is going to be delivered. example: wss://www.example.com/websocket type: string supervise_call_control_id: description: The call leg which will be supervised by the new call. example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg type: string supervisor_role: default: barge description: The role of the supervisor call. 'barge' means that supervisor call hears and is being heard by both ends of the call (caller & callee). 'whisper' means that only supervised_call_control_id hears supervisor but supervisor can hear everything. 'monitor' means that nobody can hear supervisor call, but supervisor can hear everything on the call. enum: - barge - whisper - monitor 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 maximum: 14400 minimum: 30 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 600 seconds. example: 60 format: int32 type: integer to: description: The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided using an array of strings oneOf: - example: +18005550100 or sip:username@sip.telnyx.com type: string - example: '["+18005550100", "sip:username@sip.telnyx.com"]' items: type: string type: array transcription: default: false description: Enable transcription upon call answer. The default value is false. example: true type: boolean transcription_config: $ref: '#/components/schemas/TranscriptionStartRequest' 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 CallResource: example: account_sid: 61bf923e-5e4d-4595-a110-56190ea18a1b answered_by: null caller_name: '+13122010094' date_created: Thu, 15 Jun 2023 09:56:45 +0000 date_updated: Thu, 15 Jun 2023 09:56:56 +0000 direction: inbound duration: '11' end_time: Thu, 15 Jun 2023 09:56:56 +0000 from: '+13123456789' from_formatted: (312) 345-6789 price: null price_unit: null sid: v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA start_time: Thu, 15 Jun 2023 09:56:45 +0000 status: completed to: '+13987654321' to_formatted: (398) 765-4321 uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA.json properties: account_sid: description: The id of the account the resource belongs to. example: 61bf923e-5e4d-4595-a110-56190ea18a1b type: string answered_by: description: The value of the answering machine detection result, if this feature was enabled for the call. enum: - human - machine - not_sure example: human type: string caller_name: description: Caller ID, if present. example: CALLER type: string date_created: description: The timestamp of when the resource was created. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string date_updated: description: The timestamp of when the resource was last updated. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string direction: description: The direction of this call. enum: - inbound - outbound example: inbound type: string duration: description: The duration of this call, given in seconds. example: '12' type: string end_time: description: The end time of this call. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string from: description: The phone number or SIP address that made this call. example: '+13123456789' type: string from_formatted: description: The from number formatted for display. example: (312) 345-6789 type: string price: description: The price of this call, the currency is specified in the price_unit field. Only populated when the call cost feature is enabled for the account. example: '0.10' type: string price_unit: description: The unit in which the price is given. example: USD type: string sid: description: The identifier of this call. example: v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA type: string start_time: description: The start time of this call. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string status: description: The status of this call. enum: - ringing - in-progress - canceled - completed - failed - busy - no-answer example: completed' type: string to: description: The phone number or SIP address that received this call. example: '+13987654321' type: string to_formatted: description: The to number formatted for display. example: (398) 765-4321 type: string uri: description: The relative URI for this call. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA.json type: string title: Call resource type: object CallResourceIndex: example: calls: [] end: 0 first_page_uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1 next_page_uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ page: 0 page_size: 1 start: 0 uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1 properties: calls: items: $ref: '#/components/schemas/CallResource' type: array end: description: The number of the last element on the page, zero-indexed. example: 19 type: integer first_page_uri: description: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1 example: accepted type: string next_page_uri: description: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ example: accepted type: string page: description: Current page number, zero-indexed. example: 0 type: integer page_size: description: The number of items on the page example: 20 type: integer start: description: The number of the first element on the page, zero-indexed. example: 0 type: integer uri: description: The URI of the current page. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1 type: string title: Multiple call resources type: object CallSiprecFailed: example: event_type: siprec.failed id: 25dc3731-e51e-4927-a50d-a61cc25984b1 occurred_at: '2021-12-15T14:11:24.613295Z' payload: call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx failure_cause: no_answer record_type: event properties: event_type: description: The type of event being delivered. enum: - siprec.failed example: siprec.failed type: string id: description: Identifies the type of resource. example: 25dc3731-e51e-4927-a50d-a61cc25984b1 format: uuid type: string occurred_at: description: ISO 8601 datetime of when the event occurred. example: '2021-12-15T14:11:24.613295Z' format: date-time type: string payload: properties: call_control_id: description: Call ID used to issue commands via Call Control API. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_leg_id: description: ID that is unique to the call and can be used to correlate webhook events. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 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 failure_cause: description: Q850 reason why siprec session failed. example: no_answer type: string type: object record_type: description: Identifies the resource. enum: - event example: event type: string title: Siprec Failed type: object CallSiprecFailedEvent: properties: data: $ref: '#/components/schemas/CallSiprecFailed' title: Siprec Failed Event type: object CallSiprecStarted: example: event_type: siprec.started id: 7d743d69-f7e8-4761-b7d4-8cacf9d3c031 occurred_at: '2021-12-15T14:06:32.059436Z' payload: call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx record_type: event properties: event_type: description: The type of event being delivered. enum: - siprec.started example: siprec.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: '2021-12-15T14:06:32.059436Z' format: date-time type: string payload: properties: call_control_id: description: Call ID used to issue commands via Call Control API. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_leg_id: description: ID that is unique to the call and can be used to correlate webhook events. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 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: Siprec Started type: object CallSiprecStartedEvent: properties: data: $ref: '#/components/schemas/CallSiprecStarted' title: Siprec Started Event type: object CallSiprecStopped: example: event_type: siprec.stopped id: 25dc3731-e51e-4927-a50d-a61cc25984b1 occurred_at: '2021-12-15T14:11:24.613295Z' payload: call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx hangup_cause: normal_clearing record_type: event properties: event_type: description: The type of event being delivered. enum: - siprec.stopped example: siprec.stopped type: string id: description: Identifies the type of resource. example: 25dc3731-e51e-4927-a50d-a61cc25984b1 format: uuid type: string occurred_at: description: ISO 8601 datetime of when the event occurred. example: '2021-12-15T14:11:24.613295Z' format: date-time type: string payload: properties: call_control_id: description: Call ID used to issue commands via Call Control API. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_leg_id: description: ID that is unique to the call and can be used to correlate webhook events. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 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 hangup_cause: description: Q850 reason why the SIPREC session was stopped. example: normal_clearing type: string type: object record_type: description: Identifies the type of the resource. enum: - event example: event type: string title: Siprec Stopped type: object CallSiprecStoppedEvent: properties: data: $ref: '#/components/schemas/CallSiprecStopped' title: Siprec Stopped Event 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 the command ended. enum: - completed - call_hangup - cancelled_amd 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 CallStreamingFailed: example: event_type: streaming.failed id: 25dc3731-e51e-4927-a50d-a61cc25984b1 occurred_at: '2021-12-15T14:11:24.613295Z' payload: call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx failure_reason: connection_failed stream_id: 1edb94f9-7ef0-4150-b502-e0ebadfd9491 stream_params: stream_track: inbound_track stream_url: wss://www.example.com/websocket stream_type: websocket record_type: event properties: event_type: description: The type of event being delivered. enum: - streaming.failed example: streaming.failed type: string id: description: Identifies the type of resource. example: 25dc3731-e51e-4927-a50d-a61cc25984b1 format: uuid type: string occurred_at: description: ISO 8601 datetime of when the event occurred. example: '2021-12-15T14:11:24.613295Z' format: date-time type: string payload: properties: call_control_id: description: Call ID used to issue commands via Call Control API. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_leg_id: description: ID that is unique to the call and can be used to correlate webhook events. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 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 failure_reason: description: A short description explaning why the media streaming failed. example: connection_failed type: string stream_id: description: Identifies the streaming. example: 1edb94f9-7ef0-4150-b502-e0ebadfd9491 format: uuid type: string stream_params: description: Streaming parameters as they were originally given to the Call Control API. properties: stream_url: description: The destination WebSocket address where the stream is going to be delivered. example: wss://www.example.com/websocket type: string track: default: inbound_track description: Specifies which track should be streamed. enum: - inbound_track - outbound_track - both_tracks example: inbound_track type: string type: object stream_type: description: The type of stream connection the stream is performing. enum: - websocket - dialogflow example: websocket type: string type: object record_type: description: Identifies the resource. enum: - event example: event type: string title: Streaming Failed type: object CallStreamingFailedEvent: properties: data: $ref: '#/components/schemas/CallStreamingFailed' title: Streaming Failed Event type: object CallStreamingStarted: example: event_type: streaming.started id: 7d743d69-f7e8-4761-b7d4-8cacf9d3c031 occurred_at: '2021-12-15T14:06:32.059436Z' payload: call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx stream_url: wss://www.example.com/websocket record_type: event properties: event_type: description: The type of event being delivered. enum: - streaming.started example: streaming.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: '2021-12-15T14:06:32.059436Z' format: date-time type: string payload: properties: call_control_id: description: Call ID used to issue commands via Call Control API. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_leg_id: description: ID that is unique to the call and can be used to correlate webhook events. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 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 stream_url: description: Destination WebSocket address where the stream is going to be delivered. example: wss://www.example.com/websocket type: string type: object record_type: description: Identifies the type of the resource. enum: - event example: event type: string title: Streaming Started type: object CallStreamingStartedEvent: properties: data: $ref: '#/components/schemas/CallStreamingStarted' title: Streaming Started Event type: object CallStreamingStopped: example: event_type: streaming.stopped id: 25dc3731-e51e-4927-a50d-a61cc25984b1 occurred_at: '2021-12-15T14:11:24.613295Z' payload: call_control_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_leg_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 call_session_id: 31f19208-5db0-11ec-9ea7-02420a0d3a69 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx stream_url: wss://www.example.com/websocket record_type: event properties: event_type: description: The type of event being delivered. enum: - streaming.stopped example: streaming.stopped type: string id: description: Identifies the type of resource. example: 25dc3731-e51e-4927-a50d-a61cc25984b1 format: uuid type: string occurred_at: description: ISO 8601 datetime of when the event occurred. example: '2021-12-15T14:11:24.613295Z' format: date-time type: string payload: properties: call_control_id: description: Call ID used to issue commands via Call Control API. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_leg_id: description: ID that is unique to the call and can be used to correlate webhook events. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 31f19208-5db0-11ec-9ea7-02420a0d3a69 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 stream_url: description: Destination WebSocket address where the stream is going to be delivered. example: wss://www.example.com/websocket type: string type: object record_type: description: Identifies the type of the resource. enum: - event example: event type: string title: Streaming Stopped type: object CallStreamingStoppedEvent: properties: data: $ref: '#/components/schemas/CallStreamingStopped' title: Streaming Stopped Event type: object CallWithRecordingId: example: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_duration: 50 call_leg_id: 2dc6fc34-f9e0-11ea-b68e-02420a0f7768 call_session_id: 2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d end_time: '2019-01-23T18:11:52.574Z' is_alive: false record_type: call recording_id: d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a start_time: '2019-01-23T18:10:02.574Z' properties: call_control_id: description: Unique identifier and token for controlling the call. example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg type: string call_duration: description: Indicates the duration of the call in seconds example: 50 type: integer 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call example: 428c31b6-7af4-4bcb-b68e-5013ef9657c1 type: string client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string end_time: description: ISO 8601 formatted date indicating when the call ended. Only present when the call is not alive example: '2019-01-23T18:11:52.574Z' 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 recording_id: description: The ID of the recording. Only present when the record parameter is set to record-from-answer. example: d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a format: uuid type: string start_time: description: ISO 8601 formatted date indicating when the call started example: '2019-01-23T18:10:02.574Z' type: string required: - call_control_id - call_leg_id - call_session_id - is_alive - record_type title: Call With Recording ID type: object CallbackWebhookMeta: properties: attempt: description: The number of times the callback webhook has been attempted. example: 1 type: integer delivered_to: description: The URL that the callback webhook was delivered to. example: https://example.com/webhook type: string 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 CampaignCost: properties: campaignUsecase: title: Campaignusecase type: string description: title: Description type: string monthlyCost: title: Monthlycost type: string upFrontCost: title: Upfrontcost type: string required: - campaignUsecase - monthlyCost - upFrontCost - description title: CampaignCost type: object CampaignDeletionResponse: properties: message: title: Message type: string record_type: title: Record Type type: string time: title: Time type: number required: - time title: CampaignDeletionResponse type: object CampaignRecordSet_CSP: properties: page: title: Page type: integer records: items: $ref: '#/components/schemas/TelnyxCampaignWithAssignedCount_CSP' title: Records type: array totalRecords: title: Totalrecords type: integer title: CampaignRecordSet_CSP type: object CampaignRequest: description: CampaignRequest object describes the campaign to be submitted via '/campaignBuilder/brand/{brandId}/usecase/{usecase}' operation. It is also used in operations for retrieving status of campaign request and for updating a pending request. properties: ageGated: description: Age gated message content in campaign. title: Agegated type: boolean autoRenewal: description: Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle. title: Autorenewal type: boolean brandId: description: Alphanumeric identifier of the brand associated with this campaign. title: Brandid type: string description: description: Summary description of this campaign. title: Description type: string directLending: description: Direct lending or loan arrangement title: Directlending type: boolean embeddedLink: description: Does message generated by the campaign include URL link in SMS? title: Embeddedlink type: boolean embeddedLinkSample: description: Sample of an embedded link that will be sent to subscribers. title: EmbeddedLinkSample type: string embeddedPhone: description: Does message generated by the campaign include phone number in SMS? title: Embeddedphone type: boolean helpKeywords: description: Subscriber help keywords. Multiple keywords are comma separated without space. title: Helpkeywords type: string helpMessage: description: Help message of the campaign. title: Helpmessage type: string messageFlow: description: Message flow description. title: Messageflow type: string mnoIds: description: Submit campaign to given list of MNOs by MNO's network ID. Default is all MNOs if no value provided. items: type: integer title: Mnoids type: array uniqueItems: true numberPool: description: Does campaign utilize pool of phone numbers? title: Numberpool type: boolean optinKeywords: description: Subscriber opt-in keywords. Multiple keywords are comma separated without space. title: Optinkeywords type: string optinMessage: description: Subscriber opt-in message. title: Optinmessage type: string optoutKeywords: description: Subscriber opt-out keywords. Multiple keywords are comma separated without space. title: Optoutkeywords type: string optoutMessage: description: Subscriber opt-out message. title: Optoutmessage type: string privacyPolicyLink: description: Link to the campaign's privacy policy. title: PrivacyPolicyLink type: string referenceId: description: Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. title: Referenceid type: string resellerId: description: Alphanumeric identifier of the reseller that you want to associate with this campaign. title: Resellerid type: string sample1: description: Message sample. Some campaign tiers require 1 or more message samples. title: Sample1 type: string sample2: description: Message sample. Some campaign tiers require 2 or more message samples. title: Sample2 type: string sample3: description: Message sample. Some campaign tiers require 3 or more message samples. title: Sample3 type: string sample4: description: Message sample. Some campaign tiers require 4 or more message samples. title: Sample4 type: string sample5: description: Message sample. Some campaign tiers require 5 or more message samples. title: Sample5 type: string subUsecases: description: Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases items: type: string title: Subusecases type: array uniqueItems: true subscriberHelp: description: Does campaign responds to help keyword(s)? title: Subscriberhelp type: boolean subscriberOptin: description: Does campaign require subscriber to opt-in before SMS is sent to subscriber? title: Subscriberoptin type: boolean subscriberOptout: description: Does campaign support subscriber opt-out keyword(s)? title: Subscriberoptout type: boolean tag: description: Tags to be set on the Campaign. items: type: string title: Tag type: array uniqueItems: true termsAndConditions: description: Is terms and conditions accepted? title: Termsandconditions type: boolean termsAndConditionsLink: description: Link to the campaign's terms and conditions. title: TermsAndConditionsLink type: string usecase: description: Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. title: Usecase type: string webhookFailoverURL: description: Failover webhook to which campaign status updates are sent. example: https://webhook.com/93711262-23e5-4048-a966-c0b2a16d5963 title: WebhookFailoverURL type: string webhookURL: description: Webhook to which campaign status updates are sent. example: https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93 title: WebhookURL type: string required: - brandId - description - usecase title: CampaignRequest type: object CampaignSharingChain: properties: sharedByMe: $ref: '#/components/schemas/CampaignSharingStatus' sharedWithMe: $ref: '#/components/schemas/CampaignSharingStatus' title: CampaignSharingChain type: object CampaignSharingStatus: properties: downstreamCnpId: title: Downstreamcnpid type: string sharedDate: title: Shareddate type: string sharingStatus: title: Sharingstatus type: string statusDate: title: Statusdate type: string upstreamCnpId: title: Upstreamcnpid type: string title: CampaignSharingStatus type: object CampaignStatusUpdateEvent: properties: brandId: description: Brand ID associated with the campaign. example: d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5 title: Brandid type: string campaignId: description: The ID of the campaign. example: 4b300178-131c-d902-d54e-72d90ba1620j title: Campaignid type: string createDate: description: Unix timestamp when campaign was created. title: CreateDate type: string cspId: description: Alphanumeric identifier of the CSP associated with this campaign. title: Cspid type: string isTMobileRegistered: description: Indicates whether the campaign is registered with T-Mobile. title: IsTMobileRegistered type: boolean title: Campaign Status Update Event type: object CanaryDeployRequest: description: Request model for creating or updating canary deploys. properties: versions: description: List of version configurations items: $ref: '#/components/schemas/VersionConfig' title: Versions type: array required: - versions title: CanaryDeployRequest type: object CanaryDeployResponse: description: Response model for canary deploy operations. properties: assistant_id: title: Assistant Id type: string created_at: format: date-time title: Created At type: string updated_at: format: date-time title: Updated At type: string versions: items: $ref: '#/components/schemas/VersionConfig' title: Versions type: array required: - assistant_id - versions - created_at - updated_at title: CanaryDeployResponse 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: 0866 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 normalized_carrier: description: If known to Telnyx and applicable, the primary network carrier. example: AT&T 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 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: additionalProperties: true 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 ChatCompletionRequest: properties: api_key_ref: description: If you are using an external inference provider like xAI or OpenAI, this field allows you to pass along a reference to your API key. After creating an [integration secret](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) for you API key, pass the secret's `identifier` in this field. type: string best_of: description: This is used with `use_beam_search` to determine how many candidate beams to explore. type: integer early_stopping: default: false description: This is used with `use_beam_search`. If `true`, generation stops as soon as there are `best_of` complete candidates; if `false`, a heuristic is applied and the generation stops when is it very unlikely to find better candidates. type: boolean frequency_penalty: default: 0 description: Higher values will penalize the model from repeating the same output tokens. type: number guided_choice: description: If specified, the output will be exactly one of the choices. items: type: string type: array guided_json: additionalProperties: true description: Must be a valid JSON schema. If specified, the output will follow the JSON schema. type: object guided_regex: description: If specified, the output will follow the regex pattern. type: string length_penalty: default: 1 description: This is used with `use_beam_search` to prefer shorter or longer completions. type: number logprobs: default: false description: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`. type: boolean max_tokens: description: Maximum number of completion tokens the model should generate. type: integer messages: description: A list of the previous chat messages for context. example: - content: You are a friendly chatbot. role: system - content: Hello, world! role: user items: $ref: '#/components/schemas/ChatCompletionSystemMessageParam' type: array min_p: description: This is an alternative to `top_p` that [many prefer](https://github.com/huggingface/transformers/issues/27670). Must be in [0, 1]. type: number model: default: meta-llama/Meta-Llama-3.1-8B-Instruct description: The language model to chat with. If you are optimizing for speed + price, try `meta-llama/Meta-Llama-3.1-8B-Instruct`. For quality, try `meta-llama/Meta-Llama-3.1-70B-Instruct`. Or explore our [LLM Library](https://telnyx.com/products/llm-library). type: string n: description: This will return multiple choices for you instead of a single chat completion. type: number presence_penalty: default: 0 description: Higher values will penalize the model from repeating the same output tokens. type: number response_format: $ref: '#/components/schemas/ChatCompletionResponseFormatParam' description: Use this is you want to guarantee a JSON output without defining a schema. For control over the schema, use `guided_json`. stream: default: false description: Whether or not to stream data-only server-sent events as they become available. type: boolean temperature: default: 0.1 description: Adjusts the "creativity" of the model. Lower values make the model more deterministic and repetitive, while higher values make the model more random and creative. type: number tool_choice: enum: - none - auto - required type: string tools: description: The `function` tool type follows the same schema as the [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat). The `retrieval` tool type is unique to Telnyx. You may pass a list of [embedded storage buckets](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding) for retrieval-augmented generation. items: oneOf: - $ref: '#/components/schemas/ChatCompletionToolParam' - $ref: '#/components/schemas/Retrieval' type: array top_logprobs: description: This is used with `logprobs`. An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. type: integer top_p: description: An alternative or complement to `temperature`. This adjusts how many of the top possibilities to consider. type: number use_beam_search: default: false description: Setting this to `true` will allow the model to [explore more completion options](https://huggingface.co/blog/how-to-generate#beam-search). This is not supported by OpenAI. type: boolean required: - messages title: ChatCompletionRequest type: object ChatCompletionResponseFormatParam: properties: type: enum: - text - json_object type: string required: - type title: ChatCompletionResponseFormatParam type: object ChatCompletionSystemMessageParam: properties: content: oneOf: - title: Content String type: string - items: additionalProperties: false properties: image_url: type: string text: type: string type: enum: - text - image_url type: string required: - type type: object title: Text and Image Array type: array role: enum: - system - user - assistant - tool type: string required: - content - role title: ChatCompletionSystemMessageParam type: object ChatCompletionToolParam: properties: function: $ref: '#/components/schemas/FunctionDefinition' type: enum: - function type: string required: - function - type title: Function type: object CheckAvailabilityTool: properties: check_availability: $ref: '#/components/schemas/CheckAvailabilityToolParams' type: enum: - check_availability type: string required: - type - check_availability title: CheckAvailabilityTool type: object CheckAvailabilityToolParams: properties: api_key_ref: description: Reference to an integration secret that contains your Cal.com API key. You would pass the `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your Cal.com API key. example: my_calcom_api_key type: string event_type_id: description: Event Type ID for which slots are being fetched. [cal.com](https://cal.com/docs/api-reference/v2/slots/get-available-slots#parameter-event-type-id) type: integer required: - event_type_id - api_key_ref title: CheckAvailabilityToolParams type: object CivicAddress: example: city_or_town: Austin city_or_town_alias: null company_name: Telnyx country: US county_or_district: US default_location_id: 18ded4bb-b694-44c1-a89b-a35b7acd4c9e description: Austin Office house_number: '600' house_number_suffix: null id: 07a4dc5d-9b3b-4ba2-88a4-6ba172316c65 locations: - additional_info: null description: Austin Office id: 18ded4bb-b694-44c1-a89b-a35b7acd4c9e is_default: true - additional_info: 14th Floor description: null id: d420a57f-c4ae-4697-87e1-fbefd9e86f72 is_default: false postal_or_zip_code: '78701' record_type: civic_address state_or_province: TX street_name: Congress Street street_suffix: null properties: city_or_town: example: Chicago type: string city_or_town_alias: type: string company_name: example: Telnyx type: string country: example: US type: string country_or_district: example: US type: string default_location_id: description: Identifies what is the default location in the list of locations. format: uuid type: string description: example: Texas Office type: string house_number: example: '600' type: string house_number_suffix: type: string id: $ref: '#/components/schemas/UUID' locations: items: $ref: '#/components/schemas/Location' type: array postal_or_zip_code: example: '78701' type: string record_type: description: Identifies the type of the resource. example: civic_address type: string state_or_province: example: TX type: string street_name: example: Congress type: string street_suffix: example: St type: string title: Civic Address type: object ClientStateUpdateRequest: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d 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 required: - client_state title: Update client state Request type: object CloudflareSyncStatus: description: An enumeration. enum: - pending - added title: CloudflareSyncStatus type: string ClusterNode: properties: filename: description: The corresponding source file of your embedded storage bucket that the node is from. type: string text: description: The text of the node. type: string required: - filename - text title: ClusterNode type: object ClusteringRequestInfo: properties: bucket: type: string created_at: format: date-time type: string finished_at: format: date-time type: string min_cluster_size: type: integer min_subcluster_size: type: integer status: $ref: '#/components/schemas/TaskStatus' task_id: type: string required: - task_id - status - bucket - created_at - finished_at - min_cluster_size - min_subcluster_size title: ClusteringRequestInfo type: object ClusteringRequestInfoData: properties: data: items: $ref: '#/components/schemas/ClusteringRequestInfo' type: array meta: $ref: '#/components/schemas/Meta' required: - data - meta title: ClusteringRequestInfoData type: object ClusteringStatusResponse: properties: bucket: type: string clusters: items: $ref: '#/components/schemas/RecursiveCluster' type: array status: $ref: '#/components/schemas/TaskStatus' required: - status - bucket - clusters title: ClusteringStatusResponse type: object ClusteringStatusResponseData: properties: data: $ref: '#/components/schemas/ClusteringStatusResponse' required: - data title: ClusteringStatusResponseData 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: - sub_number_order - requirement_group 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: date-time 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: '2018-01-01T00:00:00.000000Z' format: date-time 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: date-time readOnly: true type: string type: object ComparativeLine: properties: alias: description: Service alias example: local type: string existing_this_month: $ref: '#/components/schemas/MonthDetail' name: description: Service name example: Local DIDs type: string new_this_month: $ref: '#/components/schemas/MonthDetail' type: enum: - comparative example: comparative type: string required: - type - name - alias - new_this_month - existing_this_month type: object 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_network_operators_preferences: - mobile_network_operator_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 mobile_network_operator_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_network_operators_preferences: $ref: '#/components/schemas/MobileNetworkOperatorsPreferencesResponse' 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 CompositionCompleted: example: event_type: video.room.composition.completed id: d51754fc-6888-4b0e-8f29-fc3ae41250cd occurred_at: '2022-03-02 04:47:29.980874Z' payload: composition_id: 5970ce77-4aeb-4e18-ac8c-3effca0c145a download_url: https://www.example.com duration_secs: 53 format: mp4 resolution: 1280x720 room_id: 2fbf2c0d-b6aa-463f-aeed-83ce298be978 session_id: 7c4da191-2600-4df6-a35e-0ecae6caa5d3 size_mb: 2.6 record_type: event properties: event_type: description: The type of event being delivered. enum: - video.room.composition.completed example: video.room.composition.completed type: string id: description: Uniquely identify the event. 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: composition_id: description: Composition ID that identifies the room composition. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string download_url: description: Url to download the room composition. example: https://www.example.com type: string duration_secs: description: Room composition duration in seconds. example: 67 type: integer format: description: Format of the room composition. example: mp4 type: string resolution: description: Format of the room composition. example: 1280x720 type: string room_id: description: Room ID associated with the room composition. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string session_id: description: Session ID associated with the room composition. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string size_mb: description: Room composition size in MB. example: 10.5 format: float type: number type: object record_type: description: An identifier for the type of the resource. enum: - event example: event type: string title: Composition Completed type: object CompositionCompletedEvent: properties: data: $ref: '#/components/schemas/CompositionCompleted' title: Composition Completed Event 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 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 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: 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 Floor Changed type: object ConferenceHoldRequest: example: audio_url: http://example.com/message.wav call_control_ids: - v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: - v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 ConferenceRecordingResource: example: account_sid: 4e71926f-8f13-450e-b91c-23c2ef786aa6 call_sid: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ channels: 1 conference_sid: 6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f date_created: Fri, 27 Oct 2023 07:41:58 +0000 date_updated: Fri, 27 Oct 2023 07:41:58 +0000 duration: 5 error_code: null media_url: https://www.example.com/download.mp3 sid: 136285da-4b74-46f1-a016-fe2982fa77c3 source: StartConferenceRecordingAPI start_time: Fri, 27 Oct 2023 07:41:58 +0000 status: completed subresource_uris: transcriptions: null uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/136285da-4b74-46f1-a016-fe2982fa77c3.json properties: account_sid: description: The id of the account the resource belongs to. example: 61bf923e-5e4d-4595-a110-56190ea18a1b type: string call_sid: description: The identifier of the related participant's call. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string channels: description: The number of channels in the recording. example: 1 type: integer conference_sid: description: The identifier of the related conference. example: 6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f type: string date_created: description: The timestamp of when the resource was created. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string date_updated: description: The timestamp of when the resource was last updated. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string duration: description: Duratin of the recording in seconds. example: 10 type: integer error_code: description: The recording error, if any. example: null type: string media_url: description: The URL to use to download the recording. example: https://www.example.com/download.mp3 type: string sid: description: The unique identifier of the recording. example: 136285da-4b74-46f1-a016-fe2982fa77c3 type: string source: description: How the recording was started. enum: - DialVerb - Conference - OutboundAPI - Trunking - RecordVerb - StartCallRecordingAPI - StartConferenceRecordingAPI example: StartConferenceRecordingAPI type: string start_time: description: The timestamp of when the recording was started. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string status: description: The status of the recording. enum: - processing - absent - completed - deleted example: completed type: string subresource_uris: additionalProperties: true description: A list of related resources identified by their relative URIs. example: transcriptions: null type: object uri: description: The relative URI for this recording. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/136285da-4b74-46f1-a016-fe2982fa77c3.json type: string title: Conference recording resource type: object ConferenceRecordingResourceIndex: example: end: 0 first_page_uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?page=0&pagesize=20 next_page_uri: null page: 0 page_size: 20 participants: [] start: 0 uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?page=0&pagesize=20 properties: end: description: The number of the last element on the page, zero-indexed. example: 19 type: integer first_page_uri: description: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?page=0&pagesize=20 example: accepted type: string next_page_uri: description: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ example: accepted type: string page: description: Current page number, zero-indexed. example: 0 type: integer page_size: description: The number of items on the page example: 20 type: integer recordings: items: $ref: '#/components/schemas/ConferenceRecordingResource' type: array start: description: The number of the first element on the page, zero-indexed. example: 0 type: integer uri: description: The URI of the current page. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?Page=0&PageSize=1 type: string title: Multiple conference recording resources 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 channels: single client_state: aGF2ZSBhIG5pY2UgZGF5ID1d 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 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 ConferenceResource: example: account_sid: 4e71926f-8f13-450e-b91c-23c2ef786aa6 api_version: v2/texml call_sid_ending_conference: null date_created: Fri, 27 Oct 2023 07:41:58 +0000 date_updated: Fri, 27 Oct 2023 07:41:58 +0000 friendly_name: weekly_review_call reason_conference_ended: null region: dc2 sid: cd5a70f4-759b-4d5e-9c06-88c00f16f3c1 status: in-progress subresource_uris: participants: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants.json recordings: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Recordings.json uri: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1.json properties: account_sid: description: The id of the account the resource belongs to. example: 61bf923e-5e4d-4595-a110-56190ea18a1b type: string api_version: description: The version of the API that was used to make the request. example: v2/texml type: string call_sid_ending_conference: description: Caller ID, if present. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string date_created: description: The timestamp of when the resource was created. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string date_updated: description: The timestamp of when the resource was last updated. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string friendly_name: description: A string that you assigned to describe this conference room. example: weekly_review_call type: string reason_conference_ended: description: The reason why a conference ended. When a conference is in progress, will be null. enum: - participant-with-end-conference-on-exit-left - last-participant-left - conference-ended-via-api - time-exceeded example: time-exceeded type: string region: description: A string representing the region where the conference is hosted. example: dc2 type: string sid: description: The unique identifier of the conference. example: cd5a70f4-759b-4d5e-9c06-88c00f16f3c1 type: string status: description: The status of this conference. enum: - init - in-progress - completed example: in-progress type: string subresource_uris: additionalProperties: true description: A list of related resources identified by their relative URIs. example: participants: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants.json recordings: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Recordings.json type: object uri: description: The relative URI for this conference. example: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1.json type: string title: Conference resource type: object ConferenceResourceIndex: example: conferences: [] end: 0 first_page_uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1 next_page_uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ page: 0 page_size: 1 start: 0 uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1 properties: conferences: items: $ref: '#/components/schemas/ConferenceResource' type: array end: description: The number of the last element on the page, zero-indexed. example: 19 type: integer first_page_uri: description: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1 example: accepted type: string next_page_uri: description: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ example: accepted type: string page: description: Current page number, zero-indexed. example: 0 type: integer page_size: description: The number of items on the page example: 20 type: integer start: description: The number of the first element on the page, zero-indexed. example: 0 type: integer uri: description: The URI of the current page. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1 type: string title: Multiple conference resources type: object ConferenceSid: example: cd5a70f4-759b-4d5e-9c06-88c00f16f3c1 format: uuid nullable: true type: string 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: - v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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 you want spoken. This parameter is ignored when a `Polly.*` voice is specified. 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 3,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: "Specifies the voice used in speech synthesis.\n\n- Define\ \ voices using the format `<Provider>.<Model>.<VoiceId>`. Specifying only\ \ the provider will give default values for voice_id and model_id.\n\n\ \ **Supported Providers:**\n- **AWS:** Use `AWS.Polly.<VoiceId>` (e.g.,\ \ `AWS.Polly.Joanna`). For neural voices, which provide more realistic,\ \ human-like speech, append `-Neural` to the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`).\ \ Check the [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)\ \ for compatibility.\n- **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,\ \ Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural, Azure.en-US-Ava:DragonHDLatestNeural.\ \ For a complete list of voices, go to [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)\n\ - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g., `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`).\ \ The `ModelId` part is optional. To use ElevenLabs, you must provide\ \ your ElevenLabs API key as an integration identifier secret in `\"voice_settings\"\ : {\"api_key_ref\": \"<secret_identifier>\"}`. See [integration secrets\ \ documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)\ \ for details. Check [available voices](https://elevenlabs.io/docs/api-reference/get-voices).\n\ \ - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`\n\nFor service_level\ \ basic, you may define the gender of the speaker (male or female)." example: Telnyx.KokoroTTS.af type: string voice_settings: description: The settings associated with the voice selected oneOf: - $ref: '#/components/schemas/ElevenLabsVoiceSettings' - $ref: '#/components/schemas/TelnyxVoiceSettings' - $ref: '#/components/schemas/AWSVoiceSettings' required: - payload - voice 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: - v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: - v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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/connections_OutboundVoiceProfileId' record_type: description: Identifies the type of the resource. example: ip_connection type: string tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri 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 ConnectionAndroidPushCredentialId: default: null description: The uuid of the push credential for Android example: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e nullable: true title: Android Push Credential Id type: string ConnectionId: description: The ID of the connection used to send the fax. example: '234423' type: string ConnectionIdCredentials: description: Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource. example: '1234567890' type: string ConnectionIosPushCredentialId: default: null description: The uuid of the push credential for Ios example: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 nullable: true title: Ios Push Credential Id type: string 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 type: string 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 ConsentTokenResponse: properties: data: properties: client_id: description: Client ID type: string logo_uri: description: URL of the client logo format: uri nullable: true type: string name: description: Client name type: string policy_uri: description: URL of the client's privacy policy format: uri nullable: true type: string redirect_uri: description: The redirect URI for this authorization format: uri type: string requested_scopes: items: properties: description: description: Scope description type: string id: description: Scope ID type: string name: description: Scope name type: string type: object type: array tos_uri: description: URL of the client's terms of service format: uri nullable: true type: string verified: description: Whether the client is verified type: boolean type: object type: object ConsumedData: description: Represents the amount of data consumed. properties: amount: example: '2048.1' type: string unit: default: MB example: MB type: string title: ConsumedData type: object Conversation: properties: created_at: description: The datetime the conversation was created. example: '2025-04-15T13:07:28.764Z' format: date-time type: string id: example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 format: uuid type: string last_message_at: description: The datetime of the latest message in the conversation. example: '2025-04-15T13:07:28.764Z' format: date-time type: string metadata: additionalProperties: type: string description: Metadata associated with the conversation. Telnyx provides several pieces of metadata, but customers can also add their own. example: assistant_id: assistant-123 telnyx_agent_target: '+13128675309' telnyx_conversation_channel: phone_call telnyx_end_user_target: '+13128675309' type: object name: example: '' type: string required: - id - created_at - metadata - last_message_at type: object ConversationChannelType: enum: - phone_call - sms_chat title: ConversationChannelType type: string ConversationInsight: properties: conversation_insights: description: List of insights extracted from the conversation. items: properties: insight_id: description: Unique identifier for the insight configuration. type: string result: description: Insight result from the conversation. If the insight has a JSON schema, this will be stringified JSON object. type: string required: - result - insight_id type: object type: array created_at: description: Timestamp of when the object was created. format: date-time type: string id: description: Unique identifier for the conversation insight. type: string status: description: Current status of the insight generation for the conversation. enum: - pending - in_progress - completed - failed type: string required: - id - status - created_at - conversation_insights type: object ConversationInsightListData: properties: data: items: $ref: '#/components/schemas/ConversationInsight' title: Data type: array meta: $ref: '#/components/schemas/Meta' required: - data - meta title: ConversationInsightListData type: object ConversationMessage: properties: created_at: description: The datetime the message was created on the conversation. This does not necesarily correspond to the time the message was sent. The best field to use to determine the time the end user experienced the message is `sent_at`. example: '2025-04-15T13:07:28.764Z' format: date-time type: string role: description: The role of the message sender. enum: - user - assistant - tool type: string sent_at: description: The datetime the message was sent to the end user. example: '2025-04-15T13:07:28.764Z' format: date-time type: string text: description: The message content. Can be null for tool calls. type: string tool_calls: description: Optional tool calls made by the assistant. items: properties: function: properties: arguments: description: JSON-formatted arguments to pass to the function. type: string name: description: Name of the function to call. type: string required: - name - arguments type: object id: description: Unique identifier for the tool call. type: string type: description: Type of the tool call. enum: - function type: string required: - id - type - function type: object type: array required: - role - text type: object ConversationMessageListData: properties: data: items: $ref: '#/components/schemas/ConversationMessage' title: Data type: array meta: $ref: '#/components/schemas/Meta' required: - data - meta title: ConversationMessageListData type: object ConversationsListData: properties: data: items: $ref: '#/components/schemas/Conversation' title: Data type: array required: - data title: ConversationsListData 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 Country: properties: code: description: ISO 3166-1 Alpha-2 Country Code. example: US type: string name: description: The name of the country. example: United States of America type: string required: - code - name title: Country type: object CountryCode: description: ISO 3166-1 Alpha-2 Country Code. example: US type: string CountryCoverage: example: United States of America: code: US features: - hd_voice - emergency - voice - mms - fax - sms - international_sms international_sms: true inventory_coverage: true local: features: - hd_voice - voice - international_sms - mms - fax - sms - emergency international_sms: true p2p: true quickship: false reservable: true mobile: {} national: {} numbers: true p2p: true phone_number_type: - local - local - local - local - toll_free quickship: true reservable: true shared_cost: {} toll_free: features: - voice - mms - fax - sms - emergency international_sms: false p2p: false quickship: true reservable: true properties: code: description: Country ISO code type: string features: description: Set of features supported items: type: string type: array international_sms: type: boolean inventory_coverage: description: Indicates whether country can be queried with inventory coverage endpoint type: boolean local: properties: features: items: type: string type: array international_sms: type: boolean p2p: type: boolean quickship: type: boolean reservable: type: boolean type: object mobile: additionalProperties: true type: object national: additionalProperties: true type: object numbers: type: boolean p2p: type: boolean phone_number_type: description: Phone number type items: type: string type: array quickship: description: Supports quickship type: boolean reservable: description: Supports reservable type: boolean shared_cost: additionalProperties: true type: object toll_free: properties: features: items: type: string type: array international_sms: type: boolean p2p: type: boolean quickship: type: boolean reservable: type: boolean type: object type: object CreateAndroidPushCredentialRequest: properties: alias: description: Alias to uniquely identify the credential example: LucyAndroidCredential type: string project_account_json_file: additionalProperties: true description: Private key file in JSON format example: client_email: account@customer.org private_key: BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja... type: object type: description: Type of mobile push credential. Should be <code>android</code> here enum: - android type: string required: - type - project_account_json_file - alias title: Create Android Push Credential Request type: object CreateAssistantRequest: properties: description: type: string dynamic_variables: additionalProperties: true description: Map of dynamic variables and their default values type: object dynamic_variables_webhook_url: description: If the dynamic_variables_webhook_url is set for the assistant, we will send a request at the start of the conversation. See our [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) for more information. type: string enabled_features: items: $ref: '#/components/schemas/EnabledFeatures' type: array greeting: description: Text that the assistant will use to start the conversation. This may be templated with [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) type: string insight_settings: $ref: '#/components/schemas/InsightSettings' instructions: description: System instructions for the assistant. These may be templated with [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) type: string llm_api_key_ref: description: 'This is only needed when using third-party inference providers. The `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your LLM provider''s API key. Warning: Free plans are unlikely to work with this integration.' type: string messaging_settings: $ref: '#/components/schemas/MessagingSettings' model: description: ID of the model to use. You can use the [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get) to see all of your available models, type: string name: type: string privacy_settings: $ref: '#/components/schemas/PrivacySettings' telephony_settings: $ref: '#/components/schemas/TelephonySettings' tools: $ref: '#/components/schemas/AssistantTools' transcription: $ref: '#/components/schemas/TranscriptionSettings' voice_settings: $ref: '#/components/schemas/VoiceSettings' required: - name - model - instructions title: CreateAssistantRequest type: object CreateAssistantTestRequest: description: 'Request model for creating a new assistant test. This model defines all the required and optional parameters needed to create a comprehensive test for an AI assistant, including test configuration, evaluation criteria, and scheduling options.' properties: description: description: Optional detailed description of what this test evaluates and its purpose. Helps team members understand the test's objectives. maxLength: 1000 title: Description type: string destination: description: 'The target destination for the test conversation. Format depends on the channel: phone number for SMS/voice, webhook URL for web chat, etc.' example: - '+15551234567' - assistant-id minLength: 1 title: Destination type: string instructions: description: Detailed instructions that define the test scenario and what the assistant should accomplish. This guides the test execution and evaluation. example: - Act as a frustrated customer who received a damaged product. Ask for a refund and escalate if not satisfied with the initial response. maxLength: 5000 minLength: 1 title: Instructions type: string max_duration_seconds: description: Maximum duration in seconds that the test conversation should run before timing out. If not specified, uses system default timeout. maximum: 3600.0 minimum: 1.0 title: Max Duration Seconds type: integer name: description: A descriptive name for the assistant test. This will be used to identify the test in the UI and reports. example: - Customer Support Bot Test - Sales Assistant Evaluation maxLength: 255 minLength: 1 title: Name type: string rubric: description: Evaluation criteria used to assess the assistant's performance. Each rubric item contains a name and specific criteria for evaluation. example: - - criteria: Assistant responds within 30 seconds name: Response Time - criteria: Provides correct product information name: Accuracy items: additionalProperties: false properties: criteria: description: "Specific guidance on how to assess the assistant\u2019\ s performance for this rubric item." type: string name: description: Label for the evaluation criterion, e.g., Empathy, Accuracy, Clarity. type: string required: - name - criteria type: object minItems: 1 title: Rubric type: array telnyx_conversation_channel: allOf: - $ref: '#/components/schemas/TelnyxConversationChannel' default: web_chat description: The communication channel through which the test will be conducted. Determines how the assistant will receive and respond to test messages. example: - web_chat - sms_chat test_suite: description: Optional test suite name to group related tests together. Useful for organizing tests by feature, team, or release cycle. maxLength: 100 title: Test Suite type: string required: - name - destination - instructions - rubric title: CreateAssistantTestRequest type: object CreateBrand: properties: businessContactEmail: description: 'Business contact email. Required if `entityType` is `PUBLIC_PROFIT`.' example: name@example.com title: BusinessContactEmail type: string city: description: City name example: New York maxLength: 100 title: City type: string companyName: description: (Required for Non-profit/private/public) Legal company name. example: ABC Inc. maxLength: 100 title: Companyname type: string country: description: 'ISO2 2 characters country code. Example: US - United States' example: US maxLength: 2 title: Country type: string displayName: description: Display name, marketing name, or DBA name of the brand. example: ABC Mobile maxLength: 100 title: Displayname type: string ein: description: (Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S. example: '111111111' maxLength: 20 title: Ein type: string email: description: Valid email address of brand support contact. maxLength: 100 title: Email type: string entityType: allOf: - $ref: '#/components/schemas/EntityType' description: Entity type behind the brand. This is the form of business establishment. firstName: description: First name of business contact. example: John maxLength: 100 title: Firstname type: string ipAddress: description: IP address of the browser requesting to create brand identity. maxLength: 50 title: Ipaddress type: string isReseller: default: false title: Isreseller type: boolean lastName: description: Last name of business contact. example: Smith maxLength: 100 title: Lastname type: string mobilePhone: description: Valid mobile phone number in e.164 international format. example: '+12024567890' maxLength: 20 title: Mobilephone type: string mock: default: false description: Mock brand for testing purposes. Defaults to false. title: Mock type: boolean phone: description: Valid phone number in e.164 international format. example: '+12024567890' maxLength: 20 title: Phone type: string postalCode: description: Postal codes. Use 5 digit zipcode for United States example: '10001' maxLength: 10 title: Postalcode type: string state: description: State. Must be 2 letters code for United States. example: NY maxLength: 20 title: State type: string stockExchange: allOf: - $ref: '#/components/schemas/StockExchange' description: (Required for public company) stock exchange. example: NASDAQ stockSymbol: description: (Required for public company) stock symbol. example: ABC maxLength: 10 title: Stocksymbol type: string street: description: Street number and name. example: '123' maxLength: 100 title: Street type: string vertical: allOf: - $ref: '#/components/schemas/Vertical' description: Vertical or industry segment of the brand. webhookFailoverURL: description: Webhook failover URL for brand status updates. example: https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6 title: WebhookFailoverURL type: string webhookURL: description: Webhook URL for brand status updates. example: https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93 title: WebhookURL type: string website: description: Brand website URL. example: http://www.abcmobile.com maxLength: 100 title: Website type: string required: - entityType - displayName - country - email - vertical title: CreateBrand type: object CreateBucketRequest: properties: LocationConstraint: type: string type: object xml: name: CreateBucketConfiguration wrapped: true 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 shaken_stir_enabled: true sip_subdomain: example sip_subdomain_receive_settings: only_my_connections outbound: channel_limit: 10 outbound_voice_profile_id: '1293384261075731499' redact_dtmf_debug_logging: true 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' redact_dtmf_debug_logging: default: false description: When enabled, DTMF digits entered by users will be redacted in debug logs to protect PII data entered through IVR interactions. example: true type: boolean 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 duration_minutes: 5 hold_audio_url: http://www.example.com/audio.wav max_participants: 250 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. The client_state will be updated for the creator call leg and will be used for all webhooks related to the created conference. 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 max_participants: description: The maximum number of active conference participants to allow. Must be between 2 and 800. Defaults to 250 example: 3 type: integer 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 CreateConversationRequest: properties: metadata: additionalProperties: type: string description: Metadata associated with the conversation. type: object name: type: string title: CreateConversationRequest type: object CreateCredentialConnectionRequest: example: active: true anchorsite_override: Latency android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_enabled: true sip_compact_headers_enabled: true timeout_1xx_secs: 10 timeout_2xx_secs: 20 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 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: customer 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' android_push_credential_id: $ref: '#/components/schemas/ConnectionAndroidPushCredentialId' connection_name: $ref: '#/components/schemas/ConnectionName' 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' ios_push_credential_id: $ref: '#/components/schemas/ConnectionIosPushCredentialId' 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: 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 tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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, v2 or texml. Note - texml can only be set when the outbound object parameter call_parking_enabled is included and set to true. enum: - '1' - '2' - texml 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: uri 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: uri 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' CreateExternalConnectionRequest: example: active: false external_sip_connection: zoom outbound: outbound_voice_profile_id: '1911630617284445511' properties: active: $ref: '#/components/schemas/ConnectionActive' external_sip_connection: $ref: '#/components/schemas/ExternalSipConnectionZoomOnly' 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 required: - outbound_voice_profile_id 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/external-voice-integrations_OutboundVoiceProfileId' type: object tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri 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: - external_sip_connection - outbound title: Create External Connection Request type: object CreateExternalConnectionUploadRequest: example: location_id: 67ea7693-9cd5-4a68-8c76-abb3aa5bf5d2 number_ids: - '3920457616934164700' - '3920457616934164701' - '3920457616934164702' - '3920457616934164703' usage: first_party_app_assignment properties: additional_usages: items: description: Additional use cases of the upload request. If not provided, all supported usages will be used. enum: - calling_user_assignment - first_party_app_assignment type: string type: array civic_address_id: description: Identifies the civic address to assign all phone numbers to. format: uuid type: string location_id: description: Identifies the location to assign all phone numbers to. format: uuid type: string number_ids: items: description: Phone number ID from the Telnyx API. type: string minItems: 1 type: array usage: description: 'The use case of the upload request. NOTE: `calling_user_assignment` is not supported for toll free numbers.' enum: - calling_user_assignment - first_party_app_assignment type: string required: - number_ids title: Create Upload Request type: object 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' tags: - tag1 - tag2 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 tags: default: [] description: Tags associated with the Fax Application. example: - tag1 - tag2 items: type: string type: array 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 CreateFineTuningJobRequest: properties: hyperparameters: description: The hyperparameters used for the fine-tuning job. properties: n_epochs: default: 3 description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. 'auto' decides the optimal number of epochs based on the size of the dataset. If setting the number manually, we support any number between 1 and 50 epochs. maximum: 10 minimum: 1 type: integer type: object model: description: The base model that is being fine-tuned. type: string suffix: description: Optional suffix to append to the fine tuned model's name. type: string training_file: description: The storage bucket or object used for training. type: string required: - model - training_file title: CreateFineTuningJobRequest type: object CreateFqdnConnectionRequest: example: active: true anchorsite_override: Latency android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_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 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 onnet_t38_passthrough_enabled: true outbound: ani_override: '+1234567890' ani_override_type: always call_parking_enabled: true channel_limit: 10 encrypted_media: string generate_ringback_tone: true instant_ringback_enabled: true ip_authentication_method: token ip_authentication_token: aBcD1234 localization: string outbound_voice_profile_id: '1293384261075731499' t38_reinvite_source: customer tech_prefix: '0123' timeout_1xx_secs: 10 timeout_2xx_secs: 10 rtcp_settings: capture_enabled: true port: rtcp-mux report_frequency_secs: 10 tags: - tag1 - tag2 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' android_push_credential_id: $ref: '#/components/schemas/ConnectionAndroidPushCredentialId' connection_name: $ref: '#/components/schemas/ConnectionName' 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' ios_push_credential_id: $ref: '#/components/schemas/ConnectionIosPushCredentialId' microsoft_teams_sbc: default: false description: When enabled, the connection will be created for Microsoft Teams Direct Routing. A *.mstsbc.telnyx.tech FQDN will be created for the connection automatically. type: boolean 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/OutboundFqdn' rtcp_settings: $ref: '#/components/schemas/ConnectionRtcpSettings' tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array transport_protocol: $ref: '#/components/schemas/FqdnConnectionTransportProtocol' webhook_api_version: $ref: '#/components/schemas/WebhookApiVersion' webhook_event_failover_url: $ref: '#/components/schemas/WebhookEventFailoverUrl' webhook_event_url: $ref: '#/components/schemas/WebhookEventUrl' webhook_timeout_secs: $ref: '#/components/schemas/WebhookTimeoutSecs' required: - connection_name title: Create FQDN Connection Request type: object 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 CreateGrantResponse: properties: redirect_uri: description: Redirect URI with authorization code or error format: uri type: string required: - redirect_uri type: object CreateGroupMMSMessageRequest: example: from: '+13125551234' media_urls: - http://example.com subject: From Telnyx! text: Hello, World! to: - '+18655551234' - '+14155551234' use_profile_webhooks: true webhook_failover_url: https://backup.example.com/hooks webhook_url: http://example.com/webhooks properties: 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. 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. type: string to: description: A list of destinations. No more than 8 destinations are allowed. items: $ref: '#/components/schemas/ToNumber' type: array 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 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 shaken_stir_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 shaken_stir_enabled: default: false description: When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport. 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 CreateIntegrationSecretRequest: properties: identifier: description: The unique identifier of the secret. title: Identifier type: string password: description: The password for the secret. Required for basic type secrets, ignored otherwise. title: Password type: string token: description: The token for the secret. Required for bearer type secrets, ignored otherwise. title: Token type: string type: description: The type of secret. enum: - bearer - basic title: Type type: string username: description: The username for the secret. Required for basic type secrets, ignored otherwise. title: Username type: string required: - identifier - type title: CreateIntegrationSecretRequest type: object CreateIosPushCredentialRequest: properties: alias: description: Alias to uniquely identify the credential example: LucyIosCredential type: string certificate: description: Certificate as received from APNs example: '-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----' type: string private_key: description: Corresponding private key to the certificate as received from APNs example: '-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----' type: string type: description: Type of mobile push credential. Should be <code>ios</code> here enum: - ios type: string required: - type - certificate - private_key - alias title: Create iOS push credential request type: object CreateIpConnectionRequest: example: active: true anchorsite_override: Latency android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_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 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 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: customer tech_prefix: string rtcp_settings: capture_enabled: true port: rtcp-mux report_frequency_secs: 10 tags: - tag1 - tag2 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' android_push_credential_id: $ref: '#/components/schemas/ConnectionAndroidPushCredentialId' 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' ios_push_credential_id: $ref: '#/components/schemas/ConnectionIosPushCredentialId' 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' tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri 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 type: object 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 managed_account_allow_custom_pricing: false password: 3jVjLq!tMuWKyWx4NN*CvhnB rollup_billing: false 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 managed_account_allow_custom_pricing: description: Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed after creation, but there may be time lag between when the value is changed and pricing changes take effect. example: false type: boolean 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 rollup_billing: description: Boolean value that indicates if the billing information and charges to the managed account "roll up" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false. example: false type: boolean required: - business_name title: Create Managed Account Request type: object 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 send_at: description: ISO 8601 formatted date indicating when to send the message - accurate up till a minute. format: date-time nullable: true 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 CreateMessageTemplateRequest: description: The request body when creating a message template. properties: text: description: The text content of the message template. example: 'Your {{app_name}} verification code is: {{code}}.' type: string required: - text title: CreateMessageTemplateRequest 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 whitelisted_destinations: - US properties: alpha_sender: description: The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID. nullable: true pattern: ^[A-Za-z0-9 ]{1,11}$ type: string daily_spend_limit: description: The maximum amount of money (in USD) that can be spent by this profile before midnight UTC. pattern: ^[0-9]+(?:\.[0-9]+)?$ type: string daily_spend_limit_enabled: description: Whether to enforce the value configured by `daily_spend_limit`. type: boolean enabled: default: true description: Specifies whether the messaging profile is enabled or not. type: boolean mms_fall_back_to_sms: default: false description: enables SMS fallback for MMS messages. type: boolean mms_transcoding: default: false description: enables automated resizing of MMS media. 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 whitelisted_destinations: description: Destinations to which the messaging profile is allowed to send. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]` all destinations will be allowed. items: description: ISO 3166-1 alpha-2 country code. pattern: ^[A-Z]{2}$ type: string type: array required: - name - whitelisted_destinations type: object CreateMsgReq: properties: content: default: '' title: Content type: string metadata: additionalProperties: anyOf: - type: string - type: integer - type: boolean - items: anyOf: - type: string - type: integer - type: boolean type: array title: Metadata type: object name: title: Name type: string role: title: Role type: string sent_at: format: date-time title: Sent At type: string tool_call_id: title: Tool Call Id type: string tool_calls: items: additionalProperties: true type: object title: Tool Calls type: array tool_choice: anyOf: - type: string - title: ToolChoiceObject type: object title: Tool Choice required: - role title: CreateMsgReq type: object CreateMultiPartDocServiceDocumentRequest: properties: customer_reference: description: Optional reference string for customer tracking. example: MY REF 001 type: string 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: date-time 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' 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: date-time readOnly: true type: string required: - starting_number - range type: object 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: date-time 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 type: object CreateNumberOrderRequest: example: billing_group_id: abc85f64-5717-4562-b3fc-2c9600 connection_id: '346789098765567' customer_reference: MY REF 001 messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600 phone_numbers: - bundle_id: bc8e4d67-33a0-4cbb-af74-7b58f05bd494 phone_number: '+19705555098' - phone_number: '+492111609539' requirement_group_id: dbbd94ee-9079-488f-80ba-f566b247fd79 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 customer_reference: description: A customer reference string for customer look ups. example: MY REF 001 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: properties: bundle_id: description: ID of bundle to associate the number to example: bc8e4d67-33a0-4cbb-af74-7b58f05bd494 type: string phone_number: description: e164_phone_number example: '+19705555098' type: string requirement_group_id: description: ID of requirement group to use to satisfy number requirements example: dbbd94ee-9079-488f-80ba-f566b247fd7 type: string required: - phone_number type: object type: array writeOnly: true type: object 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: date-time 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: date-time readOnly: true type: string type: object CreateOAuthGrantRequest: additionalProperties: false properties: allowed: description: Whether the grant is allowed type: boolean consent_token: description: Consent token type: string required: - allowed - consent_token type: object 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: customer_reference: description: A customer-specified reference number for customer bookkeeping purposes example: Acct 123abc type: string 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 CreateRoomCompositionRequest: properties: format: default: mp4 description: The desired format of the room composition. example: mp4 nullable: true type: string resolution: default: 1280x720 description: The desired resolution (width/height in pixels) of the resulting video of the room composition. Both width and height are required to be between 16 and 1280; and width * height should not exceed 1280 * 720 example: 800x600 nullable: true type: string session_id: description: id of the room session associated with the room composition. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0 format: uuid nullable: true type: string video_layout: additionalProperties: $ref: '#/components/schemas/VideoRegion' description: Describes the video layout of the room composition in terms of regions. type: object webhook_event_failover_url: default: '' description: The failover URL where webhooks related to this room composition will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. example: https://failover.example.com format: uri nullable: true type: string webhook_event_url: description: The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'. example: https://example.com format: uri 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 type: object CreateRoomRequest: properties: enable_recording: default: false description: Enable or disable recording for that room. example: true type: boolean 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 webhook_event_failover_url: default: '' description: The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. example: https://failover.example.com format: uri nullable: true type: string webhook_event_url: description: The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'. example: https://example.com format: uri 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 type: object CreateScheduledEventRequest: properties: conversation_metadata: additionalProperties: anyOf: - type: string - type: integer - type: boolean description: Metadata associated with the conversation. Telnyx provides several pieces of metadata, but customers can also add their own. title: Conversation Metadata type: object scheduled_at_fixed_datetime: description: The datetime at which the event should be scheduled. Formatted as ISO 8601. example: '2025-04-15T13:07:28.764Z' format: date-time title: Scheduled At Fixed Datetime type: string telnyx_agent_target: description: The phone number, SIP URI, to schedule the call or text from. title: Telnyx Agent Target type: string telnyx_conversation_channel: $ref: '#/components/schemas/ConversationChannelType' telnyx_end_user_target: description: The phone number, SIP URI, to schedule the call or text to. title: Telnyx End User Target type: string text: description: Required for sms scheduled events. The text to be sent to the end user. type: string required: - telnyx_conversation_channel - telnyx_end_user_target - telnyx_agent_target - scheduled_at_fixed_datetime title: CreateScheduledEventRequest type: object CreateScheduledMessageRequest: example: from: '+18445550001' messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000 send_at: '2019-01-23T18:30:00Z' subject: From Telnyx! text: Hello, World! to: '+18445550001' type: SMS 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 send_at: description: ISO 8601 formatted date indicating when to send the message - accurate up till a minute. format: date-time nullable: false 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 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 CreateSubNumberOrdersReportRequest: example: country_code: US created_at_gt: '2023-04-05T10:22:08.230549Z' created_at_lt: '2025-06-05T10:22:08.230549Z' customer_reference: STRING order_request_id: 12ade33a-21c0-473b-b055-b3c836e1c293 status: success properties: country_code: description: Filter by country code example: US type: string created_at_gt: description: Filter for orders created after this date example: '2023-04-05T10:22:08.230549Z' format: date-time type: string created_at_lt: description: Filter for orders created before this date example: '2025-06-05T10:22:08.230549Z' format: date-time type: string customer_reference: description: Filter by customer reference example: STRING type: string order_request_id: description: Filter by specific order request ID example: 12ade33a-21c0-473b-b055-b3c836e1c293 format: uuid type: string status: description: Filter by order status enum: - pending - success - failure example: success type: string type: object CreateTeXMLSecretRequest: example: name: My Secret Name value: My Secret Value properties: name: description: Name used as a reference for the secret, if the name already exists within the account its value will be replaced example: My Secret Name type: string value: description: Secret value which will be used when rendering the TeXML template example: My Secret Value type: string required: - name - value title: Create TeXML Secret request type: object CreateTeXMLSecretResult: example: name: My Secret Name value: '*****' properties: name: example: My Secret Name type: string value: enum: - REDACTED example: REDACTED type: string title: Create TeXML Secret result 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 shaken_stir_enabled: true 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 tags: - tag1 - tag2 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 shaken_stir_enabled: default: false description: When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls. example: false type: boolean 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: uri 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 tags: description: Tags associated with the Texml Application. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri type: string required: - friendly_name - voice_url title: Create Texml Application Request type: object CreateUserBundlesBulkRequest: properties: idempotency_key: description: Idempotency key for the request. Can be any UUID, but should always be unique for each request. example: 12ade33a-21c0-473b-b055-b3c836e1c292 format: uuid type: string items: items: properties: billing_bundle_id: description: Quantity of user bundles to order. example: 12ade33a-21c0-473b-b055-b3c836e1c292 format: uuid type: string quantity: description: Quantity of user bundles to order. type: integer required: - billing_bundle_id - quantity type: object type: array writeOnly: true type: object CreateVerificationRequestCall: description: The request body when creating a verification. properties: custom_code: default: null description: Send a self-generated numeric code to the end-user example: '43612' nullable: true 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 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 CreateVerificationRequestSMS: description: The request body when creating a verification. properties: custom_code: default: null description: Send a self-generated numeric code to the end-user example: '43612' nullable: true 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 title: CreateVerificationRequestSMS type: object CreateVerificationResponse: properties: data: $ref: '#/components/schemas/Verification' required: - data title: CreateVerifyVerificationResponse type: object CreateVerifiedNumberResponse: properties: phone_number: example: '+15551234567' type: string verification_method: example: sms type: string title: CreateVerifiedNumberResponse type: object CreateVerifyProfileCallRequest: properties: app_name: description: The name that identifies the application requesting 2fa in the verification message. example: Example Secure App pattern: ^[A-Za-z0-9 -]{1,30}$ type: string code_length: default: 5 description: The length of the verify code to generate. example: 6 type: integer default_verification_timeout_secs: default: 300 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_template_id: description: The message template identifier selected from /verify_profiles/templates example: 0abb5b4f-459f-445a-bfcd-488998b7572d format: uuid type: string whitelisted_destinations: description: Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. example: - US - CA items: description: ISO 3166-1 alpha-2 country code pattern: ^[A-Z]{2}$ type: string type: array title: CreateVerifyProfileCallRequest type: object CreateVerifyProfileFlashcallRequest: properties: default_verification_timeout_secs: default: 300 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 whitelisted_destinations: description: Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. example: - US - CA items: description: ISO 3166-1 alpha-2 country code pattern: ^[A-Z]{2}$ type: string type: array title: CreateVerifyProfileFlashcallRequest type: object CreateVerifyProfileSMSRequest: properties: alpha_sender: default: Telnyx description: The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID. nullable: true pattern: ^[A-Za-z0-9 ]{1,11}$ type: string app_name: description: The name that identifies the application requesting 2fa in the verification message. example: Example Secure App pattern: ^[A-Za-z0-9 -]{1,30}$ type: string code_length: default: 5 description: The length of the verify code to generate. example: 6 type: integer default_verification_timeout_secs: default: 300 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_template_id: description: The message template identifier selected from /verify_profiles/templates example: 0abb5b4f-459f-445a-bfcd-488998b7572d format: uuid type: string whitelisted_destinations: description: Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. example: - US - CA items: description: ISO 3166-1 alpha-2 country code pattern: ^[A-Z]{2}$ type: string type: array required: - whitelisted_destinations title: CreateVerifyProfileSMSRequest 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 CreatedUserBundlesResponse: properties: data: items: $ref: '#/components/schemas/UserBundle' type: array required: - data title: CreatedUserBundlesResponse type: object CreatedVerificationCodesResponse: properties: data: items: oneOf: - description: Successful verification code creation response properties: phone_number: description: Phone number for which the verification code was created format: +E.164 type: string type: description: Type of verification method used enum: - sms - call - flashcall type: string verification_code_id: description: Unique identifier for the verification code format: uuid type: string required: - phone_number - verification_code_id - type title: VerificationCodeSuccess type: object - description: Failed verification code creation response properties: error: description: Error message describing why the verification code creation failed type: string phone_number: description: Phone number for which the verification code creation failed format: +E.164 type: string required: - phone_number - error title: VerificationCodeError type: object type: array required: - data type: object CredentialActive: default: false description: If the credential associated with this service is active. example: true title: Credential Active type: boolean CredentialConnection: example: active: true anchorsite_override: Latency android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_enabled: true sip_compact_headers_enabled: true timeout_1xx_secs: 10 timeout_2xx_secs: 15 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 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: customer password: my123secure456password789 record_type: credential_connection rtcp_settings: capture_enabled: true port: rtp+1 report_frequency_seconds: 10 sip_uri_calling_preference: disabled tags: - tag1 - tag2 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: 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 tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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). At least one of the first 5 characters must be a letter. 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: uri 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: uri 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 shaken_stir_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 shaken_stir_enabled: default: false description: When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport. 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: integer 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: customer 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. nullable: true 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/connections_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 Credentials: description: Opaque credential token used to authenticate and authorize with storage provider. example: OPAQUE_CREDENTIALS_TOKEN type: string CredentialsResponse: properties: connection_id: $ref: '#/components/schemas/ConnectionIdCredentials' data: $ref: '#/components/schemas/CustomStorageConfiguration' record_type: $ref: '#/components/schemas/RecordType' required: - data - connection_id - record_type title: CredentialsResponse 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 Cursor: properties: after: description: Opaque identifier of next page. example: v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI= type: string before: description: Opaque identifier of previous page. example: v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI= type: string type: object CursorPaginationMeta: properties: cursors: $ref: '#/components/schemas/Cursor' next: description: Path to next page. example: /v2/connections/1234567890/active_calls?page[after]=v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI= type: string previous: description: Path to previous page. example: /v2/connections/1234567890/active_calls?page[before]=v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI= type: string total_items: example: 50 type: integer title: Cursor Pagination Meta 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 CustomStorageConfiguration: properties: backend: enum: - gcs - s3 - azure example: gcs type: string configuration: oneOf: - $ref: '#/components/schemas/GCSConfigurationData' - $ref: '#/components/schemas/S3ConfigurationData' - $ref: '#/components/schemas/AzureConfigurationData' required: - backend - configuration title: Custom Storage Configuration type: object CustomerServiceRecord: 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 error_message: description: The error message in case status is `failed`. This field would be null in case of `pending` or `completed` status. example: CSR information not available. type: string id: description: Uniquely identifies this customer service record example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid readOnly: true type: string phone_number: description: The phone number of the customer service record. example: '+12065551212' type: string record_type: description: Identifies the type of the resource. example: customer_service_record readOnly: true type: string result: description: The result of the CSR request. This field would be null in case of `pending` or `failed` status. properties: address: description: The address of the customer service record properties: administrative_area: description: The state of the address example: NY type: string full_address: description: The full address example: 123 Main St; New York; NY; 10001 type: string locality: description: The city of the address example: New York type: string postal_code: description: The zip code of the address example: '10001' type: string street_address: description: The street address example: 123 Main St type: string type: object admin: description: The admin of the customer service record. properties: account_number: description: The account number of the customer service record. example: '1234567890' type: string authorized_person_name: description: The authorized person name of the customer service record. example: John Doe type: string billing_phone_number: description: The billing phone number of the customer service record. example: '+12065551212' type: string name: description: The name of the customer service record. example: John Doe type: string type: object associated_phone_numbers: description: The associated phone numbers of the customer service record. items: example: '+12065551212' type: string type: array carrier_name: description: The name of the carrier that the customer service record is for. example: ABC CARRIER, INC. type: string type: object status: description: The status of the customer service record enum: - pending - completed - failed example: completed 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 CustomerServiceRecordAdditionalData: properties: account_number: description: The account number of the customer service record. example: '123456789' type: string address_line_1: description: The first line of the address of the customer service record. example: 123 Main St type: string authorized_person_name: description: The name of the authorized person. example: John Doe type: string billing_phone_number: description: The billing phone number of the customer service record. example: '+12065551212' pattern: ^\+1\d{10}$ type: string city: description: The city of the customer service record. example: New York type: string customer_code: description: The customer code of the customer service record. example: '123456789' type: string name: description: The name of the administrator of CSR. example: Entity Inc. type: string pin: description: The PIN of the customer service record. example: '1234' type: string state: description: The state of the customer service record. example: NY maxLength: 2 pattern: ^[A-Z]{2}$ type: string zip_code: description: The zip code of the customer service record. example: '10001' maxLength: 5 pattern: ^\d{5}$ type: string type: object CustomerServiceRecordPhoneNumberCoverage: properties: additional_data_required: description: Additional data required to perform CSR for the phone number. Only returned if `has_csr_coverage` is true. items: enum: - name - authorized_person_name - account_number - customer_code - pin - address_line_1 - city - state - zip_code - billing_phone_number example: name type: string type: array has_csr_coverage: description: Indicates whether the phone number is covered or not. example: true type: boolean phone_number: description: The phone number that is being verified. example: '+12223334444' type: string reason: description: The reason why the phone number is not covered. Only returned if `has_csr_coverage` is false. example: The phone number '+19999999999' is invalid. type: string record_type: description: Identifies the type of the resource. example: customer_service_record_phone_number_coverage type: string type: object CustomerServiceRecordStatusChangedEvent: properties: event_type: description: The type of the callback event. enum: - customer_service_record.status_changed example: customer_service_record.status_changed type: string id: description: Uniquely identifies the callback event. example: d3c462b5-8afa-4d48-9af1-4f9b1f00e7bd format: uuid type: string occurred_at: description: ISO 8601 formatted date indicating when the callback event occurred. example: '2021-03-19T10:07:15.527Z' format: date-time type: string payload: properties: id: description: Uniquely identifies the customer service record. example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string phone_number: description: The phone number of the customer service record. example: '+12065551212' type: string status: description: The status of the customer service record enum: - pending - completed - failed example: completed type: string updated_at: description: ISO 8601 formatted date indicating the last time where the resource was updated. example: '2021-03-19T10:07:15.527Z' format: date-time type: string type: object record_type: description: Identifies the type of the resource. enum: - event example: event type: string type: object DTMFTool: properties: send_dtmf: additionalProperties: true type: object type: enum: - send_dtmf type: string required: - type - send_dtmf title: DTMFTool type: object DateTimeRFC2822: example: Fri, 11 Aug 2023 19:12:11 +0000 format: date-time type: string DefaultGateway: allOf: - $ref: '#/components/schemas/Record' - properties: network_id: description: Network ID. example: e66c496d-4a85-423b-8b2a-8e63fac20320 format: uuid readOnly: true type: string record_type: description: Identifies the type of the resource. example: default_gateway readOnly: true type: string status: $ref: '#/components/schemas/InterfaceStatus' wireguard_peer_id: description: Wireguard peer ID. example: e66c496d-4a85-423b-8b2a-8e63fac20320 format: uuid type: string title: DefaultGateway type: object DeleteObjectsRequest: items: properties: Key: type: string type: object xml: name: Object type: array xml: name: Delete wrapped: true DeleteObjectsResponse: type: object DeprecatedInitiateCallRequest: example: From: '+13120001234' StatusCallback: https://www.example.com/statuscallback-listener To: '+13121230000' Url: https://www.example.com/texml.xml properties: AsyncAmd: default: false description: Select whether to perform answering machine detection in the background. By default execution is blocked until Answering Machine Detection is completed. example: true type: boolean AsyncAmdStatusCallback: description: URL destination for Telnyx to send AMD callback events to for the call. example: https://www.example.com/callback type: string AsyncAmdStatusCallbackMethod: default: POST description: HTTP request type used for `AsyncAmdStatusCallback`. The default value is inherited from TeXML Application setting. enum: - GET - POST example: GET type: string CallerId: description: 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: Info type: string CancelPlaybackOnDetectMessageEnd: default: true description: Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`. example: false type: boolean CancelPlaybackOnMachineDetection: default: true description: Whether to cancel ongoing playback on `machine` detection. Defaults to `true`. example: false type: boolean DetectionMode: default: Regular description: Allows you to chose between Premium and Standard detections. enum: - Premium - Regular example: Premium type: string FallbackUrl: description: A failover URL for which Telnyx will retrieve the TeXML call instructions if the `Url` is not responding. example: https://www.example.com/instructions-fallback.xml type: string From: description: The phone number of the party that initiated the call. Phone numbers are formatted with a `+` and country code. example: '+16175551212' type: string MachineDetection: default: Disable description: Enables Answering Machine Detection. enum: - Enable - Disable - DetectMessageEnd example: Enable type: string MachineDetectionSilenceTimeout: default: 3500 description: If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionSpeechEndThreshold: default: 800 description: Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionSpeechThreshold: default: 3500 description: Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionTimeout: default: 30000 description: Maximum timeout threshold in milliseconds for overall detection. example: 5000 maximum: 60000 minimum: 500 type: integer PreferredCodecs: description: The list of comma-separated codecs to be offered on a call. example: PCMA,PCMU type: string Record: description: Whether to record the entire participant's call leg. Defaults to `false`. example: false type: boolean RecordingChannels: description: The number of channels in the final recording. Defaults to `mono`. enum: - mono - dual example: dual type: string RecordingStatusCallback: description: The URL the recording callbacks will be sent to. example: https://example.com/recording_status_callback type: string RecordingStatusCallbackEvent: description: 'The changes to the recording''s state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.' example: in-progress completed absent type: string RecordingStatusCallbackMethod: description: HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`. enum: - GET - POST example: GET type: string RecordingTimeout: default: 0 description: The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite) example: 5 type: integer RecordingTrack: description: The audio track to record for the call. The default is `both`. enum: - inbound - outbound - both example: inbound type: string SipAuthPassword: description: The password to use for SIP authentication. example: '1234' type: string SipAuthUsername: description: The username to use for SIP authentication. example: user type: string StatusCallback: description: URL destination for Telnyx to send status callback events to for the call. example: https://www.example.com/callback type: string StatusCallbackEvent: default: completed description: The call events for which Telnyx should send a webhook. Multiple events can be defined when separated by a space. enum: - initiated - ringing - answered - completed example: iniated ringing type: string StatusCallbackMethod: default: POST description: HTTP request type used for `StatusCallback`. enum: - GET - POST example: GET type: string To: description: The phone number of the called party. Phone numbers are formatted with a `+` and country code. example: '+16175551212' type: string Trim: description: Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`. enum: - trim-silence - do-not-trim example: false type: string Url: description: The URL from which Telnyx will retrieve the TeXML call instructions. example: https://www.example.com/instructions.xml type: string UrlMethod: default: POST description: HTTP request type used for `Url`. The default value is inherited from TeXML Application setting. enum: - GET - POST example: GET type: string required: - To - From title: Initiate Call Request 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' title: Message - $ref: '#/components/schemas/ConferenceDetailRecord' title: Conference - $ref: '#/components/schemas/ConferenceParticipantDetailRecord' title: Conference Participant - $ref: '#/components/schemas/AmdDetailRecord' title: AMD - $ref: '#/components/schemas/VerifyDetailRecord' title: Verify 2FA - $ref: '#/components/schemas/SimCardUsageDetailRecord' title: Sim Card Usage - $ref: '#/components/schemas/MediaStorageDetailRecord' title: Media Storage required: - record_type type: object DetailRecordsSearchResponse: properties: data: items: $ref: '#/components/schemas/DetailRecord' type: array meta: $ref: '#/components/schemas/detail-records_PaginationMeta' type: object DialConferenceParticipantRequest: example: From: '+12065550200' To: '+12065550100' properties: AmdStatusCallback: description: The URL the result of answering machine detection will be sent to. example: https://www.example.com/amd_result type: string AmdStatusCallbackMethod: description: HTTP request type used for `AmdStatusCallback`. Defaults to `POST`. enum: - GET - POST example: GET type: string Beep: description: Whether to play a notification beep to the conference when the participant enters and exits. enum: - 'true' - 'false' - onEnter - onExit example: onExit type: string CallSidToCoach: description: The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string CallerId: description: 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: Info type: string CancelPlaybackOnDetectMessageEnd: default: true description: Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`. example: false type: boolean CancelPlaybackOnMachineDetection: default: true description: Whether to cancel ongoing playback on `machine` detection. Defaults to `true`. example: false type: boolean Coaching: description: Whether the participant is coaching another call. When `true`, `CallSidToCoach` has to be given. example: false type: boolean ConferenceRecord: description: Whether to record the conference the participant is joining. Defualts to `do-not-record`. The boolean values `true` and `false` are synonymous with `record-from-start` and `do-not-record` respectively. enum: - 'true' - 'false' - record-from-start - do-not-record example: record-from-start type: string ConferenceRecordingStatusCallback: description: The URL the conference recording callbacks will be sent to. example: https://example.com/conference_recording_status_callback type: string ConferenceRecordingStatusCallbackEvent: description: 'The changes to the conference recording''s state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`. `failed` and `absent` are synonymous.' example: in-progress completed failed absent type: string ConferenceRecordingStatusCallbackMethod: description: HTTP request type used for `ConferenceRecordingStatusCallback`. Defaults to `POST`. enum: - GET - POST example: GET type: string ConferenceRecordingTimeout: default: 0 description: The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite) example: 5 type: integer ConferenceStatusCallback: description: The URL the conference callbacks will be sent to. example: https://example.com/conference_status_callback type: string ConferenceStatusCallbackEvent: description: 'The changes to the conference''s state that should generate a call to `ConferenceStatusCallback`. Can be: `start`, `end`, `join` and `leave`. Separate multiple values with a space. By default no callbacks are sent.' example: start end join leave type: string ConferenceStatusCallbackMethod: description: HTTP request type used for `ConferenceStatusCallback`. Defaults to `POST`. enum: - GET - POST example: GET type: string ConferenceTrim: description: Whether to trim any leading and trailing silence from the conference recording. Defaults to `trim-silence`. enum: - trim-silence - do-not-trim example: false type: string EarlyMedia: default: false description: Whether participant shall be bridged to conference before the participant answers (from early media if available). Defaults to `false`. example: true type: boolean EndConferenceOnExit: description: Whether to end the conference when the participant leaves. Defaults to `false`. example: true type: boolean From: description: The phone number of the party that initiated the call. Phone numbers are formatted with a `+` and country code. example: '+16175551212' type: string MachineDetection: description: Whether to detect if a human or an answering machine picked up the call. Use `Enable` if you would like to ne notified as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. enum: - Enable - DetectMessageEnd example: Enable type: string MachineDetectionSilenceTimeout: default: 3500 description: If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionSpeechEndThreshold: default: 800 description: Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionSpeechThreshold: default: 3500 description: Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionTimeout: description: How long answering machine detection should go on for before sending an `Unknown` result. Given in milliseconds. example: 1000 type: integer MaxParticipants: description: The maximum number of participants in the conference. Can be a positive integer from 2 to 800. The default value is 250. example: 30 type: integer Muted: description: Whether the participant should be muted. example: true type: boolean PreferredCodecs: description: The list of comma-separated codecs to be offered on a call. example: PCMA,PCMU type: string Record: description: Whether to record the entire participant's call leg. Defaults to `false`. example: false type: boolean RecordingChannels: description: The number of channels in the final recording. Defaults to `mono`. enum: - mono - dual example: dual type: string RecordingStatusCallback: description: The URL the recording callbacks will be sent to. example: https://example.com/recording_status_callback type: string RecordingStatusCallbackEvent: description: 'The changes to the recording''s state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.' example: in-progress completed absent type: string RecordingStatusCallbackMethod: description: HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`. enum: - GET - POST example: GET type: string RecordingTrack: description: The audio track to record for the call. The default is `both`. enum: - inbound - outbound - both example: inbound type: string SipAuthPassword: description: The password to use for SIP authentication. example: '1234' type: string SipAuthUsername: description: The username to use for SIP authentication. example: user type: string StartConferenceOnEnter: description: Whether to start the conference when the participant enters. Defaults to `true`. example: false type: boolean StatusCallback: description: URL destination for Telnyx to send status callback events to for the call. example: https://www.example.com/callback type: string StatusCallbackEvent: description: 'The changes to the call''s state that should generate a call to `StatusCallback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.' example: answered completed type: string StatusCallbackMethod: description: HTTP request type used for `StatusCallback`. enum: - GET - POST example: GET type: string TimeLimit: description: The maximum duration of the call in seconds. example: 30 type: integer Timeout: description: The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5 and 120, inclusive. The default value is 30. example: 30 type: integer x-stainless-param: timeout_seconds To: description: The phone number of the called party. Phone numbers are formatted with a `+` and country code. example: '+16175551212' type: string Trim: description: Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`. enum: - trim-silence - do-not-trim example: false type: string WaitUrl: description: The URL to call for an audio file to play while the participant is waiting for the conference to start. example: https://www.example.com/wait_music.mp3 type: string title: Create Conference Participant Request type: object DialogflowConfig: properties: analyze_sentiment: default: false description: Enable sentiment analysis from Dialogflow. example: true type: boolean partial_automated_agent_reply: default: false description: Enable partial automated agent reply from Dialogflow. example: true type: boolean title: Dialogflow Config type: object DialogflowConnection: example: conversation_profile_id: a-VMHLWzTmKjiJw5S6O0-w dialogflow_api: cx environment: development location: global service_Account: '{"type":"service_account","project_id":"your-project-id","private_key_id":"your-private-key","private_key":"-----BEGIN PRIVATE KEY-----n-----END PRIVATE","client_email":"example@example.com","client_id":"your-client-id","auth_uri":"http://example.com","token_uri":"http://example.com","auth_provider_x509_cert_url":"http://example.com","client_x509_cert_url":"http://example.com"}' properties: conversation_profile_id: description: The id of a configured conversation profile on your Dialogflow account. (If you use Dialogflow CX, this param is required) example: a-VMHLWzTmKjiJw5S6O0-w type: string dialogflow_api: default: es description: Determine which Dialogflow will be used. enum: - cx - es example: cx type: string environment: description: Which Dialogflow environment will be used. example: development type: string location: description: The region of your agent is. (If you use Dialogflow CX, this param is required) example: global type: string service_account: additionalProperties: true description: The JSON map to connect your Dialoglow account. example: '{"service_account":{"type":"service_account","project_id":"your-project-id","private_key_id":"your-private-key","private_key":"-----BEGIN PRIVATE KEY-----n-----END PRIVATE","client_email":"example@example.com","client_id":"your-client-id","auth_uri":"http://example.com","token_uri":"http://example.com","auth_provider_x509_cert_url":"http://example.com","client_x509_cert_url":"http://example.com"}}' type: object required: - service_account title: Dialogflow Connection Params type: object DialogflowConnectionResponse: properties: data: properties: connection_id: description: Uniquely identifies a Telnyx application (Call Control). example: '1234541231' type: string conversation_profile_id: description: The id of a configured conversation profile on your Dialogflow account. (If you use Dialogflow CX, this param is required) example: a-VMHLWzTmKjiJw5S6O0-w type: string environment: description: Which Dialogflow environment will be used. example: development type: string record_type: example: dialogflow_connections type: string service_account: description: The JSON map to connect your Dialoglow account. example: '****' type: string title: Dialogflow Connection type: object required: - data title: Dialogflow Connection Response type: object Direction: description: The direction of the fax. enum: - inbound - outbound example: outbound type: string DocReqsRequirement: properties: action: description: Indicates whether this requirement applies to branded_calling, ordering, porting, or both ordering and porting enum: - both - branded_calling - 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: acceptable_characters: description: Specifies the allowed characters as a string example: abcdef0123456789 readOnly: false type: string acceptable_values: description: Specifies the list of strictly possible values for the requirement. Ignored when empty items: example: US type: string readOnly: false type: array locality_limit: description: Specifies geography-based acceptance criteria example: Issued by the same country that the phone number belongs to readOnly: false type: string max_length: description: Maximum length allowed for the value example: 20 readOnly: false type: integer min_length: description: Minimum length allowed for the value example: 16 readOnly: false type: integer 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 customer_reference: description: Optional reference string for customer tracking. example: MY REF 001 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: customer_reference: description: A customer reference string for customer look ups. example: MY REF 001 type: string file: description: The Base64 encoded contents of the file you are uploading. example: '[Base64 encoded content]' format: byte type: string filename: description: The filename of the document. example: test-document.pdf type: string required: - file type: object DocServiceDocumentUploadURL: properties: customer_reference: description: Optional reference string for customer tracking. example: MY REF 001 type: string filename: description: The filename of the document. example: test-document.pdf type: string 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 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 DynamicEmergencyAddress: properties: administrative_area: example: TX type: string country_code: enum: - US - CA - PR example: US type: string created_at: description: ISO 8601 formatted date of when the resource was created example: '2018-02-02T22:25:27.521Z' readOnly: true type: string extended_address: type: string house_number: example: 600 type: string house_suffix: type: string id: example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f1 readOnly: true type: string locality: example: Austin type: string postal_code: example: '78701' type: string record_type: description: Identifies the type of the resource. example: dynamic_emergency_address readOnly: true type: string sip_geolocation_id: description: Unique location reference string to be used in SIP INVITE from / p-asserted headers. example: XYZ123 readOnly: true type: string status: description: Status of dynamic emergency address enum: - pending - activated - rejected example: pending readOnly: true type: string street_name: example: Congress type: string street_post_directional: type: string street_pre_directional: type: string street_suffix: example: St type: string updated_at: description: ISO 8601 formatted date of when the resource was last updated example: '2018-02-02T22:25:27.521Z' readOnly: true type: string required: - house_number - street_name - locality - administrative_area - postal_code - country_code type: object DynamicEmergencyEndpoint: properties: callback_number: example: '+13125550000' type: string caller_name: example: Jane Doe Desk Phone type: string created_at: description: ISO 8601 formatted date of when the resource was created example: '2018-02-02T22:25:27.521Z' readOnly: true type: string dynamic_emergency_address_id: description: An id of a currently active dynamic emergency location. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 type: string id: example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 readOnly: true type: string record_type: description: Identifies the type of the resource. example: dynamic_emergency_endpoint readOnly: true type: string sip_from_id: example: FXDFWEDF readOnly: true type: string status: description: Status of dynamic emergency address enum: - pending - activated - rejected example: pending readOnly: true type: string updated_at: description: ISO 8601 formatted date of when the resource was last updated example: '2018-02-02T22:25:27.521Z' readOnly: true type: string required: - dynamic_emergency_address_id - callback_number - caller_name type: object ESimPurchase: properties: amount: description: The amount of eSIMs to be purchased. example: 10 minimum: 1 type: integer product: description: Type of product to be purchased, specify "whitelabel" to use a custom SPN example: whitelabel 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: default: enabled description: Status on which the SIM cards will be set after being successfully registered. enum: - enabled - disabled - standby example: standby type: string tags: description: Searchable tags associated with the SIM cards example: - personal - customers - active-customers items: type: string type: array whitelabel_name: description: Service Provider Name (SPN) for the Whitelabel eSIM product. It will be displayed as the mobile service name by operating systems of smartphones. This parameter must only contain letters, numbers and whitespaces. example: Custom SPN type: string required: - amount title: SIMCardRegistration type: object ElevenLabsVoiceSettings: properties: api_key_ref: description: 'The `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your ElevenLabs API key. Warning: Free plans are unlikely to work with this integration.' example: my_elevenlabs_api_key type: string title: ElevenLabs Voice Settings type: object EligibilityNumberResponse: properties: detail: description: Detailed information about the eligibility status. type: string eligible: description: Whether the phone number is eligible for hosted messaging. type: boolean eligible_status: description: The eligibility status of the phone number. enum: - NUMBER_CAN_NOT_BE_REPEATED - NUMBER_CAN_NOT_BE_VALIDATED - NUMBER_CAN_NOT_BE_WIRELESS - NUMBER_CAN_NOT_BE_ACTIVE_IN_YOUR_ACCOUNT - NUMBER_CAN_NOT_HOSTED_WITH_A_TELNYX_SUBSCRIBER - NUMBER_CAN_NOT_BE_IN_TELNYX - NUMBER_IS_NOT_A_US_NUMBER - NUMBER_IS_NOT_A_VALID_ROUTING_NUMBER - NUMBER_IS_NOT_IN_E164_FORMAT - BILLING_ACCOUNT_CHECK_FAILED - BILLING_ACCOUNT_IS_ABOLISHED - ELIGIBLE type: string phone_number: description: The phone number in e164 format. type: string type: object EligibilityNumbersRequest: properties: phone_numbers: description: List of phone numbers to check eligibility items: description: Phone number to check eligibility format: +E.164 type: string type: array required: - phone_numbers type: object EligibilityNumbersResponse: properties: phone_numbers: description: List of phone numbers with their eligibility status. items: $ref: '#/components/schemas/EligibilityNumberResponse' type: array type: object EmbeddingBucketRequest: properties: bucket_name: title: Bucket Name type: string document_chunk_overlap_size: default: 512 title: Document Chunk Overlap Size type: integer document_chunk_size: default: 1024 title: Document Chunk Size type: integer embedding_model: allOf: - $ref: '#/components/schemas/SupportedEmbeddingModels' default: thenlper/gte-large loader: allOf: - $ref: '#/components/schemas/SupportedEmbeddingLoaders' default: default required: - bucket_name title: EmbeddingBucketRequest type: object EmbeddingMetadata: properties: certainty: title: Certainty type: number checksum: title: Checksum type: string embedding: title: Embedding type: string filename: title: Filename type: string loader_metadata: additionalProperties: true title: Loader Metadata type: object source: title: Source type: string required: - source - checksum - embedding - filename title: EmbeddingMetadata type: object EmbeddingResponse: properties: data: properties: created_at: title: Created At type: string finished_at: nullable: true title: Finished At type: string status: title: Status type: string task_id: format: uuid title: Task ID type: string task_name: title: Task Name type: string user_id: format: uuid title: User ID type: string type: object required: - data title: EmbeddingResponse type: object EmbeddingSimilaritySearchDocument: description: "Example document response from embedding service\n{\n \"document_chunk\"\ : \"your status? This is Vanessa Bloome...\",\n \"distance\": 0.18607724,\n\ \ \"metadata\": {\n \"source\": \"https://us-central-1.telnyxstorage.com/scripts/bee_movie_script.txt\"\ ,\n \"checksum\": \"343054dd19bab39bbf6761a3d20f1daa\",\n \"embedding\"\ : \"openai/text-embedding-ada-002\",\n \"filename\": \"bee_movie_script.txt\"\ ,\n \"certainty\": 0.9069613814353943,\n \"loader_metadata\": {}\n \ \ }\n}" properties: distance: title: Distance type: number document_chunk: title: Document Chunk type: string metadata: $ref: '#/components/schemas/EmbeddingMetadata' required: - document_chunk - distance - metadata title: EmbeddingSimilaritySearchDocument type: object EmbeddingSimilaritySearchRequest: properties: bucket_name: title: Bucket Name type: string num_of_docs: default: 3 title: Num Of Docs type: integer query: title: Query type: string required: - bucket_name - query title: EmbeddingSimilaritySearchRequest type: object EmbeddingSimilaritySearchResponse: properties: data: items: $ref: '#/components/schemas/EmbeddingSimilaritySearchDocument' title: Data type: array required: - data title: EmbeddingSimilaritySearchResponse type: object EmbeddingUrlRequest: properties: bucket_name: description: Name of the bucket to store the embeddings. This bucket must already exist. title: Bucket Name type: string url: description: The URL of the webpage to embed title: URL type: string required: - url - bucket_name title: EmbeddingUrlRequest type: object EmbeddingsBucketFiles: properties: created_at: format: date-time title: Created At type: string error_reason: title: Error Reason type: string filename: title: Filename type: string last_embedded_at: format: date-time title: Last Embedded At type: string status: title: Status type: string updated_at: format: date-time title: Updated At type: string required: - filename - status - created_at title: EmbeddingsBucketFiles type: object EmbeddingsBucketFilesData: properties: data: items: $ref: '#/components/schemas/EmbeddingsBucketFiles' title: Data type: array required: - data title: EmbeddingsBucketFilesData type: object EmergencySettings: description: The emergency services settings for a phone number. example: emergency_address_id: '1315261609962112019' emergency_enabled: true emergency_status: active properties: emergency_address_id: description: Identifies the address to be used with emergency services. 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 - provisioning-failed type: string type: object EnabledFeatures: description: If `telephony` is enabled, the assistant will be able to make and receive calls. If `messaging` is enabled, the assistant will be able to send and receive messages. enum: - telephony - messaging type: string EncryptedMedia: description: Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS. enum: - SRTP 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_name: 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 any command with the same `command_id` for the same `call_control_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 required: - queue_name title: Enqueue Request type: object EntityType: description: Entity type behind the brand. This is the form of business establishment. enum: - PRIVATE_PROFIT - PUBLIC_PROFIT - NON_PROFIT - GOVERNMENT example: PRIVATE_PROFIT title: EntityType type: string EnumListResponse: example: '["BASIC_ACCOUNT", "SMALL_ACCOUNT", "MEDIUM_ACCOUNT", "LARGE_ACCOUNT", "KEY_ACCOUNT"]' items: anyOf: - type: string - type: object title: EnumListResponse type: array EnumObjectResponse: example: '{"AREIS": "AREIS", "BANDW": "Bandwidth", "SINCH": "Sinch"}' title: EnumObjectResponse type: object EnumPaginatedResponse: example: '{"page": 1, "records": [{"isin": "US68243Q1067", "iso2": "US", "symbol": "FLWS", "exchange": "NASDAQ", "displayName": "1-800 FLOWERS.COM, Inc."}, {"isin": "US88025U1097", "iso2": "US", "symbol": "TXG", "exchange": "NASDAQ", "displayName": "10X GENOMICS INC CLASS A"}], "totalRecords": 2}' title: EnumPaginatedResponse type: object Error: example: code: '20207' description: The street address provided is invalid. source: pointer: /street_address title: Invalid street address properties: code: format: int64 type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. format: json-pointer type: string type: object title: type: string required: - code - title type: object ErrorRecord: properties: code: description: an application-specific error code, expressed as a stringified 5-digit integer example: '10003' type: string detail: description: "a human-readable explanation specific to this occurrence of\ \ the problem. Like title, this field\u2019s value can be localized" example: 'Available metrics values for sip-trunking: connected,cost,completed,call_sec,attempted,billed_sec.' type: string meta: $ref: '#/components/schemas/MetaResponse' source: $ref: '#/components/schemas/SourceResponse' title: description: a short, human-readable summary of the problem, with NO punctuation, that SHOULD NOT CHANGE from occurrence to occurrence of the problem, except for purposes of localization example: Metrics invalid values type: string type: object ErrorResponse: properties: errors: items: properties: code: type: string detail: type: string meta: properties: url: format: uri type: string type: object source: properties: pointer: type: string type: object title: type: string type: object type: array type: object Errors: properties: errors: items: $ref: '#/components/schemas/audit-logs_Error' type: array type: object EventStatus: enum: - pending - in_progress - completed - failed title: EventStatus type: string ExportPortingOrdersCSVReport: description: The parameters for generating a porting orders CSV report. properties: filters: description: The filters to apply to the export porting order CSV report. properties: created_at__gt: description: The date and time the porting order was created after. format: date-time type: string created_at__lt: description: The date and time the porting order was created before. format: date-time type: string customer_reference__in: description: The customer reference of the porting orders to include in the report. items: example: my-customer-reference type: string type: array status__in: description: The status of the porting orders to include in the report. items: enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled type: string type: array type: object required: - filters type: object ExportPortoutsCSVReport: description: The parameters for generating a port-outs CSV report. properties: filters: description: The filters to apply to the export port-out CSV report. properties: created_at__gt: description: The date and time the port-out was created after. format: date-time type: string created_at__lt: description: The date and time the port-out was created before. format: date-time type: string customer_reference__in: description: The customer reference of the port-outs to include in the report. items: example: my-customer-reference type: string type: array end_user_name: description: The end user name of the port-outs to include in the report. example: McPortersen type: string phone_numbers__overlaps: description: A list of phone numbers that the port-outs phone numbers must overlap with. items: example: '+1234567890' type: string type: array status__in: description: The status of the port-outs to include in the report. items: enum: - pending - authorized - ported - rejected - rejected-pending - canceled type: string type: array type: object required: - filters type: object ExternalConnection: example: active: false created_at: '2022-06-29T19:23:59Z' credential_active: false external_sip_connection: zoom id: '1930241863466354012' outbound: outbound_voice_profile_id: '1911630617284445511' record_type: external_connection updated_at: '2022-06-29T19:39:47Z' properties: active: $ref: '#/components/schemas/ConnectionActive' created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2018-02-02T22:25:27.521Z' type: string credential_active: $ref: '#/components/schemas/CredentialActive' external_sip_connection: $ref: '#/components/schemas/ExternalSipConnection' id: $ref: '#/components/schemas/external-voice-integrations_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 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/external-voice-integrations_OutboundVoiceProfileId' type: object record_type: description: Identifies the type of the resource. example: external_connection type: string tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri 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: External Connection type: object ExternalConnectionPhoneNumber: properties: acquired_capabilities: items: description: The capabilities that are available for this phone number on Microsoft Teams. enum: - FirstPartyAppAssignment - InboundCalling - Office365 - OutboundCalling - UserAssignment type: string type: array civic_address_id: description: Identifies the civic address assigned to the phone number. format: uuid type: string displayed_country_code: description: The iso country code that will be displayed to the user when they receive a call from this phone number. type: string location_id: description: Identifies the location assigned to the phone number. format: uuid type: string number_id: description: Phone number ID from the Telnyx API. type: string telephone_number: description: Phone number in E164 format. type: string ticket_id: $ref: '#/components/schemas/UUID' title: Phone number details with relation to an external connection type: object ExternalSipConnection: default: zoom description: The service that will be consuming this connection. enum: - zoom - operator_connect example: zoom title: External SIP Connection type: string ExternalSipConnectionZoomOnly: default: zoom description: The service that will be consuming this connection. enum: - zoom example: zoom title: External SIP Connection type: string ExternalVetting: properties: createDate: description: Vetting submission date. This is the date when the vetting request is generated in ISO 8601 format. title: createDate type: string evpId: description: External vetting provider ID for the brand. maxLength: 10 title: Evpid type: string vettedDate: description: Vetting effective date. This is the date when vetting was completed, or the starting effective date in ISO 8601 format. If this date is missing, then the vetting was not complete or not valid. title: vettedDate type: string vettingClass: description: Identifies the vetting classification. title: Vettingclass type: string vettingId: description: Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting. title: vettingId type: string vettingScore: description: Vetting score ranging from 0-100. title: vettingScore type: integer vettingToken: description: Required by some providers for vetting record confirmation. title: vettingToken type: string title: ExternalVetting 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/wireless-public_PaginationMeta' type: object FailClusteringProcessRequest: properties: error: type: string required: - error title: FailClusteringProcessRequest type: object Fax: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d 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 preview_url: https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b_preview.tiff?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 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: client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string connection_id: $ref: '#/components/schemas/ConnectionId' created_at: description: ISO 8601 timestamp when resource was created format: date-time type: string direction: $ref: '#/components/schemas/Direction' from: $ref: '#/components/schemas/From' from_display_name: description: The string used as the caller id name (SIP From Display Name) presented to the destination (`to` number). example: Company Name type: string id: $ref: '#/components/schemas/Id' media_name: $ref: '#/components/schemas/MediaName' media_url: $ref: '#/components/schemas/MediaUrl' preview_url: description: If `store_preview` was set to `true`, this is a link to temporary location. Link expires after 10 minutes. type: string quality: $ref: '#/components/schemas/Quality' 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 - originated - sending - delivered - failed - initiated - receiving - media.processing - received example: queued type: string store_media: description: Should fax media be stored on temporary URL. It does not support media_name. type: boolean stored_media_url: description: If store_media was set to true, this is a link to temporary location. Link expires after 10 minutes. type: string to: $ref: '#/components/schemas/To' updated_at: description: ISO 8601 timestamp when resource was updated format: date-time 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 tags: default: [] description: Tags associated with the Fax Application. example: - tag1 - tag2 items: type: string type: array 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 client_state: aGF2ZSBhIG5pY2UgZGF5ID1d 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: $ref: '#/components/schemas/Id' payload: properties: call_duration_secs: description: The duration of the call in seconds. example: 25 type: integer client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string connection_id: $ref: '#/components/schemas/ConnectionId' direction: $ref: '#/components/schemas/Direction' fax_id: $ref: '#/components/schemas/FaxId' from: $ref: '#/components/schemas/From' media_name: $ref: '#/components/schemas/MediaName' original_media_url: $ref: '#/components/schemas/OriginalMediaUrl' 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: $ref: '#/components/schemas/To' user_id: $ref: '#/components/schemas/UserId' type: object record_type: $ref: '#/components/schemas/programmable-fax_RecordType' type: object FaxEmailRecipient: default: null description: Specifies an email address where faxes sent to this application will be forwarded to (as pdf or tiff attachments) example: user@example.com nullable: true title: Fax Email Recipient type: string FaxFailed: example: data: event_type: fax.failed id: 95479a2e-b947-470a-a88f-2da6dd07ae0f occurred_at: '2020-05-05T13:08:22.039204Z' payload: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d 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: $ref: '#/components/schemas/Id' payload: properties: client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string connection_id: $ref: '#/components/schemas/ConnectionId' direction: $ref: '#/components/schemas/Direction' failure_reason: description: Cause of the sending failure enum: - rejected type: string fax_id: $ref: '#/components/schemas/FaxId' from: $ref: '#/components/schemas/From' media_name: $ref: '#/components/schemas/MediaName' original_media_url: $ref: '#/components/schemas/OriginalMediaUrl' status: description: The status of the fax. enum: - failed example: failed type: string to: $ref: '#/components/schemas/To' user_id: $ref: '#/components/schemas/UserId' type: object record_type: $ref: '#/components/schemas/programmable-fax_RecordType' type: object FaxId: description: Identifies the fax. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string FaxMediaProcessed: example: data: event_type: fax.media.processed id: 95479a2e-b947-470a-a88f-2da6dd07ae0f occurred_at: '2020-05-05T13:08:22.039204Z' payload: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d 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: $ref: '#/components/schemas/Id' payload: properties: client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string connection_id: $ref: '#/components/schemas/ConnectionId' direction: $ref: '#/components/schemas/Direction' fax_id: $ref: '#/components/schemas/FaxId' from: $ref: '#/components/schemas/From' media_name: $ref: '#/components/schemas/MediaName' original_media_url: $ref: '#/components/schemas/OriginalMediaUrl' status: description: The status of the fax. enum: - media.processed example: media.processed type: string to: $ref: '#/components/schemas/To' user_id: $ref: '#/components/schemas/UserId' type: object record_type: $ref: '#/components/schemas/programmable-fax_RecordType' type: object FaxQueued: example: data: event_type: fax.queued id: 95479a2e-b947-470a-a88f-2da6dd07ae0f occurred_at: '2020-05-05T13:08:22.039204Z' payload: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d 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: $ref: '#/components/schemas/Id' payload: properties: client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string connection_id: $ref: '#/components/schemas/ConnectionId' direction: $ref: '#/components/schemas/Direction' fax_id: $ref: '#/components/schemas/FaxId' from: $ref: '#/components/schemas/From' media_name: $ref: '#/components/schemas/MediaName' original_media_url: $ref: '#/components/schemas/OriginalMediaUrl' status: description: The status of the fax. enum: - queued example: queued type: string to: $ref: '#/components/schemas/To' user_id: $ref: '#/components/schemas/UserId' type: object record_type: $ref: '#/components/schemas/programmable-fax_RecordType' 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: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d 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: $ref: '#/components/schemas/Id' payload: properties: client_state: description: State received from a command. example: aGF2ZSBhIG5pY2UgZGF5ID1d type: string connection_id: $ref: '#/components/schemas/ConnectionId' direction: $ref: '#/components/schemas/Direction' fax_id: $ref: '#/components/schemas/FaxId' from: $ref: '#/components/schemas/From' media_name: $ref: '#/components/schemas/MediaName' original_media_url: $ref: '#/components/schemas/OriginalMediaUrl' status: description: The status of the fax. enum: - sending example: sending type: string to: $ref: '#/components/schemas/To' user_id: $ref: '#/components/schemas/UserId' type: object record_type: $ref: '#/components/schemas/programmable-fax_RecordType' type: object Feature: example: name: sms properties: name: example: sms type: string type: object FineTuningJob: description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API. properties: created_at: description: The Unix timestamp (in seconds) for when the fine-tuning job was created. type: integer finished_at: description: The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running. nullable: true type: integer hyperparameters: description: The hyperparameters used for the fine-tuning job. properties: n_epochs: default: 3 description: The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. maximum: 10 minimum: 1 type: integer required: - n_epochs type: object id: description: The name of the fine-tuned model that is being created. type: string model: description: The base model that is being fine-tuned. type: string organization_id: description: The organization that owns the fine-tuning job. type: string status: description: The current status of the fine-tuning job. enum: - queued - running - succeeded - failed - cancelled type: string trained_tokens: description: The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running. nullable: true type: integer training_file: description: The storage bucket or object used for training. type: string required: - created_at - finished_at - hyperparameters - id - model - organization_id - status - trained_tokens - training_file title: FineTuningJob type: object FineTuningJobsListData: properties: data: items: $ref: '#/components/schemas/FineTuningJob' type: array required: - data title: FineTuningJobListData 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 ForbiddenError: allOf: - $ref: '#/components/schemas/GenericError' - properties: code: example: '10010' type: string detail: example: You do not have permission to perform the requested action on the specified resource or resources. type: string meta: properties: url: example: https://developers.telnyx.com/docs/overview/errors/10010 type: string type: object title: example: Authorization failed type: string type: object 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 android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_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 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 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: customer tech_prefix: string record_type: fqdn_connection rtcp_settings: capture_enabled: true port: rtcp-mux report_frequency_secs: 10 tags: - tag1 - tag2 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 adjust_dtmf_timestamp: description: Indicates whether DTMF timestamp adjustment is enabled. type: boolean anchorsite_override: $ref: '#/components/schemas/AnchorsiteOverride' call_cost_enabled: description: Indicates whether call cost calculation is enabled. type: boolean connection_name: $ref: '#/components/schemas/ConnectionName' created_at: $ref: '#/components/schemas/CreatedAt' 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 ignore_dtmf_duration: description: Indicates whether DTMF duration should be ignored. type: boolean ignore_mark_bit: description: Indicates whether the mark bit should be ignored. type: boolean inbound: $ref: '#/components/schemas/InboundFqdn' microsoft_teams_sbc: default: false description: The connection is enabled for Microsoft Teams Direct Routing. type: boolean noise_suppression: description: Indicates whether noise suppression is enabled. type: boolean 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 outbound: $ref: '#/components/schemas/OutboundFqdn' password: description: The password for the FQDN connection. type: string record_type: description: Identifies the type of the resource. example: fqdn_connection type: string rtcp_settings: $ref: '#/components/schemas/ConnectionRtcpSettings' rtp_pass_codecs_on_stream_change: description: Defines if codecs should be passed on stream change. type: boolean send_normalized_timestamps: description: Indicates whether normalized timestamps should be sent. type: boolean tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array third_party_control_enabled: description: Indicates whether third-party control is enabled. type: boolean transport_protocol: $ref: '#/components/schemas/FqdnConnectionTransportProtocol' txt_name: description: The name for the TXT record associated with the FQDN connection. type: string txt_ttl: description: The time to live for the TXT record associated with the FQDN connection. type: integer txt_value: description: The value for the TXT record associated with the FQDN connection. type: string updated_at: $ref: '#/components/schemas/UpdatedAt' user_name: description: The username for the FQDN connection. type: string webhook_api_version: $ref: '#/components/schemas/WebhookApiVersion' webhook_event_failover_url: $ref: '#/components/schemas/WebhookEventFailoverUrl' webhook_event_url: $ref: '#/components/schemas/WebhookEventUrl' webhook_timeout_secs: $ref: '#/components/schemas/WebhookTimeoutSecs' 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 From: description: The phone number, in E.164 format, the fax will be sent from. example: '+13125790015' type: string FunctionDefinition: properties: description: type: string name: type: string parameters: additionalProperties: true type: object required: - name title: FunctionDefinition type: object GCSConfigurationData: properties: bucket: $ref: '#/components/schemas/Bucket' credentials: $ref: '#/components/schemas/Credentials' title: Google Cloud Storage Configuration Data type: object GatherRequest: 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string gather_id: description: An id that will be sent back in the corresponding `call.gather.ended` webhook. Will be randomly generated if not specified. example: my_gather_id maxLength: 40 minLength: 1 type: string initial_timeout_millis: default: 5000 description: The number of milliseconds to wait for the first DTMF. example: 10000 format: int32 type: integer inter_digit_timeout_millis: default: 5000 description: The number of milliseconds to wait for input between digits. example: 10000 format: int32 type: integer 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 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 to complete the request. 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 type: object GatherUsingAIRequest: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 greeting: Hello, can you tell me your age and where you live? message_history: - content: Hello, what's your name? role: assistant - content: Hello, I'm John. role: user parameters: properties: age: description: The age of the customer. type: integer location: description: The location of the customer. type: string required: - age - location type: object send_message_history_updates: true send_partial_results: true user_response_timeout_ms: 5000 voice: Telnyx.KokoroTTS.af properties: assistant: $ref: '#/components/schemas/Assistant' 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string greeting: description: Text that will be played when the gathering starts, if none then nothing will be played when the gathering starts. The greeting can be text for any voice or SSML for `AWS.Polly.<voice_id>` voices. There is a 3,000 character limit. example: Hello, can you tell me your age and where you live? type: string interruption_settings: $ref: '#/components/schemas/InterruptionSettings' language: discriminator: mapping: google: '#/components/schemas/GoogleTranscriptionLanguage' propertyName: transcription.model oneOf: - $ref: '#/components/schemas/GoogleTranscriptionLanguage' message_history: description: The message history you want the voice assistant to be aware of, this can be useful to keep the context of the conversation, or to pass additional information to the voice assistant. items: properties: content: description: The content of the message example: Hello, I'm 29 and I live in Paris. type: string role: description: The role of the message sender enum: - assistant - user example: user type: string type: object type: array parameters: description: The parameters described as a JSON Schema object that needs to be gathered by the voice assistant. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format example: properties: age: description: The age of the customer. type: integer location: description: The location of the customer. type: string required: - age - location type: object type: object send_message_history_updates: description: Default is `false`. If set to `true`, the voice assistant will send updates to the message history via the `call.ai_gather.message_history_updated` [callback](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks) in real time as the message history is updated. example: false type: boolean send_partial_results: description: Default is `false`. If set to `true`, the voice assistant will send partial results via the `call.ai_gather.partial_results` [callback](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks) in real time as individual fields are gathered. If set to `false`, the voice assistant will only send the final result via the `call.ai_gather.ended` callback. example: false type: boolean transcription: $ref: '#/components/schemas/TranscriptionConfig' user_response_timeout_ms: default: 10000 description: The number of milliseconds to wait for a user response before the voice assistant times out and check if the user is still there. example: 5000 type: integer voice: $ref: '#/components/schemas/VoiceConfig' voice_settings: description: The settings associated with the voice selected oneOf: - $ref: '#/components/schemas/ElevenLabsVoiceSettings' - $ref: '#/components/schemas/TelnyxVoiceSettings' - $ref: '#/components/schemas/AWSVoiceSettings' required: - parameters title: Gather Using AI Request type: object 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 any command with the same `command_id` for the same `call_control_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 any command with the same `command_id` for the same `call_control_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 3,000 character limit. example: Say this on the call type: string language: description: The language you want spoken. This parameter is ignored when a `Polly.*` voice is specified. 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 3,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: "Specifies the voice used in speech synthesis.\n\n- Define\ \ voices using the format `<Provider>.<Model>.<VoiceId>`. Specifying only\ \ the provider will give default values for voice_id and model_id.\n\n\ \ **Supported Providers:**\n- **AWS:** Use `AWS.Polly.<VoiceId>` (e.g.,\ \ `AWS.Polly.Joanna`). For neural voices, which provide more realistic,\ \ human-like speech, append `-Neural` to the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`).\ \ Check the [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)\ \ for compatibility.\n- **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,\ \ Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural, Azure.en-US-Ava:DragonHDLatestNeural.\ \ For a complete list of voices, go to [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)\n\ - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g., `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`).\ \ The `ModelId` part is optional. To use ElevenLabs, you must provide\ \ your ElevenLabs API key as an integration identifier secret in `\"voice_settings\"\ : {\"api_key_ref\": \"<secret_identifier>\"}`. See [integration secrets\ \ documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)\ \ for details. Check [available voices](https://elevenlabs.io/docs/api-reference/get-voices).\n\ \ - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`\n\nFor service_level\ \ basic, you may define the gender of the speaker (male or female)." example: Telnyx.KokoroTTS.af type: string voice_settings: description: The settings associated with the voice selected oneOf: - $ref: '#/components/schemas/ElevenLabsVoiceSettings' - $ref: '#/components/schemas/TelnyxVoiceSettings' - $ref: '#/components/schemas/AWSVoiceSettings' required: - voice - payload title: Gather Using Speak Request type: object GcbChannelZone: properties: channels: example: 7 format: int64 type: integer countries: description: List of countries (in ISO 3166-2, capitalized) members of the billing channel zone example: - BE - EL - LT - PT - BG - ES - LU - RO - CZ - FR - HU - SI - DK - HR - MT - SK - DE - IT - NL - FI - EE - CY - AT - SE - IE - LV - PL items: type: string type: array created_at: description: ISO 8601 formatted date of when the channel zone was created example: '2019-01-23T18:10:02.574Z' type: string id: example: 1653e6a1-4bfd-4857-97c6-6a51e1c34477 type: string name: example: Euro channel zone type: string record_type: enum: - channel_zone example: channel_zone type: string updated_at: description: ISO 8601 formatted date of when the channel zone was updated example: '2019-01-23T18:10:02.574Z' type: string required: - record_type - countries - id - name - channels title: Channel zone object type: object GcbPhoneNumber: properties: channel_zone_id: example: 1653e6a1-4bfd-4857-97c6-6a51e1c34477 type: string created_at: description: ISO 8601 formatted date of when the phone number was created example: '2019-01-23T18:10:02.574Z' type: string id: example: 3da3c749-bb7d-4ad6-acae-ca0d415ae08b type: string phone_number: example: '+15554441234' type: string record_type: enum: - channel_zone_phone_number example: channel_zone_phone_number type: string required: - record_type - channel_zone_id - phone_number title: Phone Number object type: object GenericError: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string type: object GetInsightTemplateGroupsRespData: properties: data: items: $ref: '#/components/schemas/InsightTemplateGroupResp' title: Data type: array meta: $ref: '#/components/schemas/Meta' required: - data - meta title: GetInsightTemplateGroupsRespData type: object GetInsightTemplatesRespData: properties: data: items: $ref: '#/components/schemas/InsightTemplateResp' title: Data type: array meta: $ref: '#/components/schemas/Meta' required: - data - meta title: GetInsightTemplatesRespData type: object GetSubRequestByPortingOrder: properties: port_request_id: description: Identifies the Port Request associated with the Porting Order example: 59b0762a-b274-4f76-ac32-4d5cf0272e66 type: string sub_request_id: description: Identifies the Sub Request associated with the Porting Order example: 9787fb5f-cbe5-4de4-b765-3303774ee9fe type: string type: object GlobalIP: allOf: - $ref: '#/components/schemas/Record' - properties: description: description: A user specified description for the address. example: test interface type: string ip_address: description: The Global IP address. example: 198.51.100.1 readOnly: true type: string name: description: A user specified name for the address. example: test interface type: string ports: additionalProperties: true description: A Global IP ports grouped by protocol code. example: tcp: - 80 - 8080 udp: - 5000 - 5050 type: object record_type: description: Identifies the type of the resource. example: global_ip readOnly: true type: string title: Global IP type: object GlobalIPAllowedPort: allOf: - properties: first_port: description: First port of a range. example: 1024 type: integer id: description: Identifies the resource. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid readOnly: true type: string last_port: description: Last port of a range. example: 49151 type: integer name: description: A name for the Global IP ports range. example: TCP Registered type: string protocol_code: description: The Global IP Protocol code. example: tcp readOnly: true type: string record_type: description: Identifies the type of the resource. example: global_ip_allowed_port readOnly: true type: string title: Global IP Allowed Port Range type: object GlobalIPHealthCheck: allOf: - $ref: '#/components/schemas/Record' - properties: global_ip_id: description: Global IP ID. example: a836125b-20b6-452e-9c03-2653f09c7ed7 format: uuid type: string health_check_params: additionalProperties: true description: A Global IP health check params. example: path: / port: 8080 type: object health_check_type: description: The Global IP health check type. example: http_status_2xx type: string record_type: description: Identifies the type of the resource. example: global_ip_health_check readOnly: true type: string title: Global IP health check type: object GlobalIPProtocol: allOf: - properties: code: description: The Global IP Protocol code. example: tcp readOnly: true type: string name: description: A name for Global IP Protocol. example: TCP type: string record_type: description: Identifies the type of the resource. example: global_ip_protocol readOnly: true type: string title: Global IP Protocol type: object GlobalIpAssignment: allOf: - $ref: '#/components/schemas/Record' - properties: global_ip_id: description: Global IP ID. example: a836125b-20b6-452e-9c03-2653f09c7ed7 format: uuid type: string is_announced: description: Status of BGP announcement. readOnly: true type: boolean is_connected: description: Wireguard peer is connected. readOnly: true type: boolean is_in_maintenance: description: Enable/disable BGP announcement. type: boolean record_type: description: Identifies the type of the resource. example: global_ip_assignment readOnly: true type: string status: $ref: '#/components/schemas/InterfaceStatus' wireguard_peer_id: description: Wireguard peer ID. example: e66c496d-4a85-423b-8b2a-8e63fac20320 format: uuid type: string title: Global IP type: object GlobalIpAssignmentHealthMetric: properties: global_ip: properties: id: description: Global IP ID. example: a836125b-20b6-452e-9c03-2653f09c7ed7 format: uuid type: string ip_address: description: The Global IP address. example: null readOnly: true type: string type: object global_ip_assignment: properties: id: description: Global IP assignment ID. example: a836125b-20b6-452e-9c03-2653f09c7ed7 format: uuid type: string wireguard_peer: properties: ip_address: description: The IP address of the interface. example: 73.47.1.23 type: string name: description: A user specified name for the interface. example: Wireguard Peer 1 type: string type: object wireguard_peer_id: description: Wireguard peer ID. example: e66c496d-4a85-423b-8b2a-8e63fac20320 format: uuid type: string type: object health: properties: fail: description: The number of failed health checks. example: 0 type: number pass: description: The number of successful health checks. example: 100 type: number type: object timestamp: description: The timestamp of the metric. example: '2020-01-01T00:00:00.000Z' format: date-time type: string type: object GlobalIpAssignmentUpdate: allOf: - $ref: '#/components/schemas/GlobalIpAssignment' - properties: global_ip_id: readOnly: true type: string wireguard_peer_id: readOnly: true type: string title: Global IP type: object GlobalIpAssignmentUsageMetric: properties: global_ip: properties: id: description: Global IP ID. example: a836125b-20b6-452e-9c03-2653f09c7ed7 format: uuid type: string ip_address: description: The Global IP address. example: 64.1.4.130 readOnly: true type: string type: object global_ip_assignment: properties: id: description: Global IP assignment ID. example: a836125b-20b6-452e-9c03-2653f09c7ed7 format: uuid type: string wireguard_peer: properties: ip_address: description: The IP address of the interface. example: 172.1.0.1 type: string name: description: A user specified name for the interface. example: Wireguard Peer 1 type: string type: object wireguard_peer_id: description: Wireguard peer ID. example: e66c496d-4a85-423b-8b2a-8e63fac20320 format: uuid type: string type: object received: properties: amount: description: The amount of data received. example: 100000 type: number unit: description: The unit of the amount of data received. example: B type: string type: object timestamp: description: The timestamp of the metric. example: '2020-01-01T00:00:00.000Z' format: date-time type: string transmitted: properties: amount: description: The amount of data transmitted. example: 100000 type: number unit: description: The unit of the amount of data transmitted. example: B type: string type: object type: object GlobalIpHealthCheckType: allOf: - properties: health_check_params: additionalProperties: true description: Global IP Health check params. example: health_check_params: path: str port: int type: object health_check_type: description: Global IP Health check type. example: http_status_2xx type: string record_type: description: Identifies the type of the resource. example: global_ip_health_check_type readOnly: true type: string title: Global IP Health Check Type type: object GlobalIpLatencyMetric: properties: global_ip: properties: id: description: Global IP ID. example: a836125b-20b6-452e-9c03-2653f09c7ed7 format: uuid type: string ip_address: description: The Global IP address. example: null readOnly: true type: string type: object mean_latency: properties: amount: description: The average latency. example: 100 type: number unit: description: The unit of the average latency. example: ms type: string type: object percentile_latency: properties: '0': properties: amount: description: The minimum latency. example: 100 type: number unit: description: The unit of the minimum latency. example: ms type: string type: object '100': properties: amount: description: The maximum latency. example: 100 type: number unit: description: The unit of the maximum latency. example: ms type: string type: object '25': properties: amount: description: The 25th percentile latency. example: 100 type: number unit: description: The unit of the 25th percentile latency. example: ms type: string type: object '50': properties: amount: description: The 50th percentile latency. example: 100 type: number unit: description: The unit of the 50th percentile latency. example: ms type: string type: object '75': properties: amount: description: The 75th percentile latency. example: 100 type: number unit: description: The unit of the 75th percentile latency. example: ms type: string type: object '90': properties: amount: description: The 90th percentile latency. example: 100 type: number unit: description: The unit of the 90th percentile latency. example: ms type: string type: object '99': properties: amount: description: The 99th percentile latency. example: 100 type: number unit: description: The unit of the 99th percentile latency. example: ms type: string type: object type: object prober_location: properties: id: description: Location ID. example: 1 format: uuid type: string lat: description: Latitude. example: 52.370216 type: number lon: description: Longitude. example: 4.895168 type: number name: description: Location name. example: Amsterdam type: string type: object timestamp: description: The timestamp of the metric. example: '2020-01-01T00:00:00.000Z' format: date-time type: string type: object GlobalIpUsageMetric: properties: global_ip: properties: id: description: Global IP ID. example: a836125b-20b6-452e-9c03-2653f09c7ed7 format: uuid type: string ip_address: description: The Global IP address. example: 64.1.2.130 readOnly: true type: string type: object received: properties: amount: description: The amount of data received. example: 100000 type: number unit: description: The unit of the amount of data received. example: B type: string type: object timestamp: description: The timestamp of the metric. example: '2020-01-01T00:00:00.000Z' format: date-time type: string transmitted: properties: amount: description: The amount of data transmitted. example: 100000 type: number unit: description: The unit of the amount of data transmitted. example: B type: string type: object type: object GoogleTranscriptionLanguage: default: en description: Language to use for speech recognition enum: - af - sq - am - ar - hy - az - eu - bn - bs - bg - my - ca - yue - zh - hr - cs - da - nl - en - et - fil - fi - fr - gl - ka - de - el - gu - iw - hi - hu - is - id - it - ja - jv - kn - kk - km - ko - lo - lv - lt - mk - ms - ml - mr - mn - ne - 'no' - fa - pl - pt - pa - ro - ru - rw - sr - si - sk - sl - ss - st - es - su - sw - sv - ta - te - th - tn - tr - ts - uk - ur - uz - ve - vi - xh - zu example: en title: Google transcription engine list of languages type: string GoogleTranscriptionLanguageLong: default: en-US description: Language to use for speech recognition enum: - af-ZA - am-ET - ar-AE - ar-BH - ar-DZ - ar-EG - ar-IL - ar-IQ - ar-JO - ar-KW - ar-LB - ar-MA - ar-MR - ar-OM - ar-PS - ar-QA - ar-SA - ar-TN - ar-YE - az-AZ - bg-BG - bn-BD - bn-IN - bs-BA - ca-ES - cs-CZ - da-DK - de-AT - de-CH - de-DE - el-GR - en-AU - en-CA - en-GB - en-GH - en-HK - en-IE - en-IN - en-KE - en-NG - en-NZ - en-PH - en-PK - en-SG - en-TZ - en-US - en-ZA - es-AR - es-BO - es-CL - es-CO - es-CR - es-DO - es-EC - es-ES - es-GT - es-HN - es-MX - es-NI - es-PA - es-PE - es-PR - es-PY - es-SV - es-US - es-UY - es-VE - et-EE - eu-ES - fa-IR - fi-FI - fil-PH - fr-BE - fr-CA - fr-CH - fr-FR - gl-ES - gu-IN - hi-IN - hr-HR - hu-HU - hy-AM - id-ID - is-IS - it-CH - it-IT - iw-IL - ja-JP - jv-ID - ka-GE - kk-KZ - km-KH - kn-IN - ko-KR - lo-LA - lt-LT - lv-LV - mk-MK - ml-IN - mn-MN - mr-IN - ms-MY - my-MM - ne-NP - nl-BE - nl-NL - no-NO - pa-Guru-IN - pl-PL - pt-BR - pt-PT - ro-RO - ru-RU - rw-RW - si-LK - sk-SK - sl-SI - sq-AL - sr-RS - ss-latn-za - st-ZA - su-ID - sv-SE - sw-KE - sw-TZ - ta-IN - ta-LK - ta-MY - ta-SG - te-IN - th-TH - tn-latn-za - tr-TR - ts-ZA - uk-UA - ur-IN - ur-PK - uz-UZ - ve-ZA - vi-VN - xh-ZA - yue-Hant-HK - zh - zh-TW - zu-ZA example: en-US title: Google transcription engine list of languages type: string HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object HandoffTool: description: The handoff tool allows the assistant to hand off control of the conversation to another AI assistant. By default, this will happen transparently to the end user. properties: handoff: $ref: '#/components/schemas/HandoffToolParams' type: enum: - handoff type: string required: - type - handoff title: HandoffTool type: object HandoffToolParams: properties: ai_assistants: description: List of possible assistants that can receive a handoff. items: properties: id: description: The ID of the assistant to hand off to. example: assistant-1234567890abcdef type: string name: description: Helpful name for giving context on when to handoff to the assistant. example: Scheduling Specialist type: string required: - name - id type: object type: array voice_mode: description: With the unified voice mode all assistants share the same voice, making the handoff transparent to the user. With the distinct voice mode all assistants retain their voice configuration, providing the experience of a conference call with a team of assistants. enum: - unified - distinct type: string required: - ai_assistants title: HandoffToolParams 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string title: Hangup Request type: object HangupTool: properties: hangup: $ref: '#/components/schemas/HangupToolParams' type: enum: - hangup type: string required: - type - hangup title: HangupTool type: object HangupToolParams: properties: description: default: This tool is used to hang up the call. description: The description of the function that will be passed to the assistant. type: string title: HangupToolParams 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 - failed_activation - failed_carrier_rejected - failed_ineligible_carrier - failed_number_already_hosted - failed_number_not_found - failed_ownership_verification - failed_timeout - pending - provisioning - successful type: string type: object Id: description: Identifies the type of resource. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string ImportAssistantsRequest: properties: api_key_ref: description: Integration secret pointer that refers to the API key for the external provider. This should be an identifier for an integration secret created via /v2/integration_secrets. type: string provider: description: The external provider to import assistants from. enum: - elevenlabs - vapi type: string required: - provider - api_key_ref title: ImportAssistantsRequest type: object ImportExternalVetting: properties: evpId: description: External vetting provider ID for the brand. maxLength: 10 title: Evpid type: string vettingId: description: Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting. title: Vettingid type: string vettingToken: description: Required by some providers for vetting record confirmation. title: Vettingtoken type: string required: - evpId - vettingId title: ImportExternalVetting type: object ImportMetadata: properties: import_id: description: ID of the assistant in the provider's system. type: string import_provider: description: Provider the assistant was imported from. enum: - elevenlabs - vapi type: string type: object InboundFqdn: example: ani_number_format: +E.164 channel_limit: 10 codecs: - G722 default_primary_fqdn_id: '1293384261075731497' default_routing_method: sequential default_secondary_fqdn_id: '1293384261075731498' default_tertiary_fqdn_id: '1293384261075731499' dnis_number_format: +e164 generate_ringback_tone: true isup_headers_enabled: true prack_enabled: true shaken_stir_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_primary_fqdn_id: default: null description: 'The default primary FQDN to use for the number. Only settable if the connection is of FQDN type. Value must be the ID of an FQDN set on the connection.' format: int64 nullable: true type: string default_routing_method: default: sequential 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 default_secondary_fqdn_id: default: null description: 'The default secondary FQDN to use for the number. Only settable if the connection is of FQDN type. Value must be the ID of an FQDN set on the connection.' format: int64 nullable: true type: string default_tertiary_fqdn_id: default: null description: 'The default tertiary FQDN to use for the number. Only settable if the connection is of FQDN type. Value must be the ID of an FQDN set on the connection.' format: int64 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 shaken_stir_enabled: default: false description: When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport. 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).' maximum: 600 minimum: 1 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 shaken_stir_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\n 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\n 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\n 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 shaken_stir_enabled: default: false description: When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport. 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: cc: [] completed_at: null cost: amount: 0.0051 currency: USD cost_breakdown: carrier_fee: amount: 0.00305 currency: USD rate: amount: 0.00205 currency: USD 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 tcr_campaign_billable: true tcr_campaign_id: TCPA3X7 tcr_campaign_registered: REGISTERED 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: cc: [] completed_at: null cost: amount: 0.0051 currency: USD cost_breakdown: carrier_fee: amount: 0.00305 currency: USD rate: amount: 0.00205 currency: USD 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 tcr_campaign_billable: true tcr_campaign_id: TCPA3X7 tcr_campaign_registered: REGISTERED 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 cost_breakdown: description: Detailed breakdown of the message cost components. nullable: true properties: carrier_fee: properties: amount: description: The carrier fee amount. format: decimal type: string currency: description: The ISO 4217 currency identifier. format: iso4217 type: string type: object rate: properties: amount: description: The rate amount applied. format: decimal type: string currency: description: The ISO 4217 currency identifier. format: iso4217 type: string type: object 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/messaging_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 tcr_campaign_billable: description: Indicates whether the TCR campaign is billable. type: boolean tcr_campaign_id: description: The Campaign Registry (TCR) campaign ID associated with the message. nullable: true type: string tcr_campaign_registered: description: The registration status of the TCR campaign. example: REGISTERED nullable: true type: string 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 InitiateCallRequest: example: From: '+13120001234' StatusCallback: https://www.example.com/statuscallback-listener To: '+13121230000' Url: https://www.example.com/texml.xml properties: ApplicationSid: description: The ID of the TeXML Application. type: string AsyncAmd: default: false description: Select whether to perform answering machine detection in the background. By default execution is blocked until Answering Machine Detection is completed. example: true type: boolean AsyncAmdStatusCallback: description: URL destination for Telnyx to send AMD callback events to for the call. example: https://www.example.com/callback type: string AsyncAmdStatusCallbackMethod: default: POST description: HTTP request type used for `AsyncAmdStatusCallback`. The default value is inherited from TeXML Application setting. enum: - GET - POST example: GET type: string CallerId: description: 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: Info type: string CancelPlaybackOnDetectMessageEnd: default: true description: Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`. example: false type: boolean CancelPlaybackOnMachineDetection: default: true description: Whether to cancel ongoing playback on `machine` detection. Defaults to `true`. example: false type: boolean DetectionMode: default: Regular description: Allows you to chose between Premium and Standard detections. enum: - Premium - Regular example: Premium type: string FallbackUrl: description: A failover URL for which Telnyx will retrieve the TeXML call instructions if the `Url` is not responding. example: https://www.example.com/instructions-fallback.xml type: string From: description: The phone number of the party that initiated the call. Phone numbers are formatted with a `+` and country code. example: '+16175551212' type: string MachineDetection: default: Disable description: Enables Answering Machine Detection. enum: - Enable - Disable - DetectMessageEnd example: Enable type: string MachineDetectionSilenceTimeout: default: 3500 description: If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionSpeechEndThreshold: default: 800 description: Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionSpeechThreshold: default: 3500 description: Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used. example: 2000 type: integer MachineDetectionTimeout: default: 30000 description: Maximum timeout threshold in milliseconds for overall detection. example: 5000 maximum: 60000 minimum: 500 type: integer PreferredCodecs: description: The list of comma-separated codecs to be offered on a call. example: PCMA,PCMU type: string Record: description: Whether to record the entire participant's call leg. Defaults to `false`. example: false type: boolean RecordingChannels: description: The number of channels in the final recording. Defaults to `mono`. enum: - mono - dual example: dual type: string RecordingStatusCallback: description: The URL the recording callbacks will be sent to. example: https://example.com/recording_status_callback type: string RecordingStatusCallbackEvent: description: 'The changes to the recording''s state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.' example: in-progress completed absent type: string RecordingStatusCallbackMethod: description: HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`. enum: - GET - POST example: GET type: string RecordingTimeout: default: 0 description: The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite) example: 5 type: integer RecordingTrack: description: The audio track to record for the call. The default is `both`. enum: - inbound - outbound - both example: inbound type: string SendRecordingUrl: $ref: '#/components/schemas/SendRecordingUrl' SipAuthPassword: description: The password to use for SIP authentication. example: '1234' type: string SipAuthUsername: description: The username to use for SIP authentication. example: user type: string StatusCallback: description: URL destination for Telnyx to send status callback events to for the call. example: https://www.example.com/callback type: string StatusCallbackEvent: default: completed description: The call events for which Telnyx should send a webhook. Multiple events can be defined when separated by a space. enum: - initiated - ringing - answered - completed example: iniated ringing type: string StatusCallbackMethod: default: POST description: HTTP request type used for `StatusCallback`. enum: - GET - POST example: GET type: string To: description: The phone number of the called party. Phone numbers are formatted with a `+` and country code. example: '+16175551212' type: string Trim: description: Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`. enum: - trim-silence - do-not-trim example: false type: string Url: description: The URL from which Telnyx will retrieve the TeXML call instructions. example: https://www.example.com/instructions.xml type: string UrlMethod: default: POST description: HTTP request type used for `Url`. The default value is inherited from TeXML Application setting. enum: - GET - POST example: GET type: string required: - To - From - ApplicationSid title: Initiate Call Request type: object InitiateCallResult: example: from: '+13120001234' status: queued to: '+13121230000' properties: from: example: '+13120001234' type: string status: example: accepted type: string to: example: '+13120000000' type: string title: Initaite TeXML Call Result type: object InsightSettings: properties: insight_group_id: description: Reference to an Insight Group. Insights in this group will be run automatically for all the assistant's conversations. type: string type: object InsightTemplateCreateReq: properties: instructions: title: Instructions type: string json_schema: anyOf: - type: string - title: JsonSchemaObject type: object description: If specified, the output will follow the JSON schema. title: Json Schema name: title: Name type: string webhook: default: '' title: Webhook type: string required: - instructions - name title: InsightTemplateCreateReq type: object InsightTemplateDetailRespData: properties: data: $ref: '#/components/schemas/InsightTemplateResp' required: - data title: InsightTemplateDetailRespData type: object InsightTemplateGroupCreateReq: properties: description: title: Description type: string name: title: Name type: string webhook: default: '' title: Webhook type: string required: - name title: InsightTemplateGroupCreateReq type: object InsightTemplateGroupDetailRespData: properties: data: $ref: '#/components/schemas/InsightTemplateGroupResp' required: - data title: InsightTemplateGroupDetailRespData type: object InsightTemplateGroupResp: properties: created_at: format: date-time title: Created At type: string description: title: Description type: string id: format: uuid title: Id type: string insights: items: $ref: '#/components/schemas/InsightTemplateResp' title: Insights type: array name: title: Name type: string webhook: default: '' title: Webhook type: string required: - id - name - created_at title: InsightTemplateGroupResp type: object InsightTemplateGroupUpdateReq: properties: description: title: Description type: string name: title: Name type: string webhook: title: Webhook type: string title: InsightTemplateGroupUpdateReq type: object InsightTemplateResp: properties: created_at: format: date-time title: Created At type: string id: format: uuid title: Id type: string insight_type: $ref: '#/components/schemas/TemplateType' default: custom instructions: title: Instructions type: string json_schema: anyOf: - type: string - title: JsonSchemaObject type: object description: If specified, the output will follow the JSON schema. title: Json Schema name: default: '' title: Name type: string webhook: default: '' title: Webhook type: string required: - id - instructions - created_at title: InsightTemplateResp type: object InsightTemplateUpdateReq: properties: instructions: title: Instructions type: string json_schema: anyOf: - type: string - title: JsonSchemaObject type: object title: Json Schema name: title: Name type: string webhook: title: Webhook type: string title: InsightTemplateUpdateReq type: object IntId: description: Uniquely identifies the resource. example: '1293384261075731499' title: Int ID type: string IntegrationSecret: properties: created_at: format: date-time title: Created At type: string id: title: Id type: string identifier: title: Identifier type: string record_type: example: integration_secret title: Record Type type: string updated_at: format: date-time title: Updated At type: string required: - record_type - id - identifier - value - created_at title: IntegrationSecret type: object IntegrationSecretCreatedResponse: properties: data: $ref: '#/components/schemas/IntegrationSecret' required: - data title: IntegrationSecretCreatedResponse type: object IntegrationSecretsListData: properties: data: items: $ref: '#/components/schemas/IntegrationSecret' title: Data type: array meta: $ref: '#/components/schemas/integration-secrets_Metadata' required: - data - meta title: SecretsListData type: object Interface: properties: name: description: A user specified name for the interface. example: test interface type: string network_id: description: The id of the network associated with the interface. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string status: $ref: '#/components/schemas/InterfaceStatus' type: object InterfaceStatus: description: The current status of the interface deployment. enum: - created - provisioning - provisioned - deleting example: provisioned readOnly: true type: string InterruptionSettings: description: Settings for handling user interruptions during assistant speech properties: enable: default: true description: When true, allows users to interrupt the assistant while speaking type: boolean type: object IntrospectRequest: properties: token: description: The token to introspect type: string required: - token type: object IntrospectResponse: properties: active: description: Whether the token is active type: boolean aud: description: Audience type: string client_id: description: Client identifier type: string exp: description: Expiration timestamp type: integer iat: description: Issued at timestamp type: integer iss: description: Issuer type: string scope: description: Space-separated list of scopes type: string required: - active type: object InventoryCoverage: example: administrative_area: NJ advance_requirements: true 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: administrative_area: example: NJ type: string advance_requirements: description: Indicates if the phone number requires advance requirements. example: true type: boolean 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 Invoice: properties: file_id: example: 454ea3b0-9eaa-4fa9-992e-6d9f31c0a37e format: uuid type: string invoice_id: example: 48eff763-ea80-4345-b688-78249eb165a8 format: uuid type: string paid: example: true type: boolean period_end: example: '2023-11-30' format: date type: string period_start: example: '2023-11-01' format: date type: string url: example: https://api.telnyx.com:443/v2/invoices/48eff763-ea80-4345-b688-78249eb165a8 format: uri type: string type: object InvoiceDetail: properties: download_url: description: Present only if the query parameter `action=link` is set. example: https://us-east-1.telnyxstorage.com/porting-documents/telnyx/... format: uri type: string file_id: example: 454ea3b0-9eaa-4fa9-992e-6d9f31c0a37e format: uuid type: string invoice_id: example: 48eff763-ea80-4345-b688-78249eb165a8 format: uuid type: string paid: example: true type: boolean period_end: example: '2023-11-30' format: date type: string period_start: example: '2023-11-01' format: date type: string url: example: https://api.telnyx.com:443/v2/invoices/48eff763-ea80-4345-b688-78249eb165a8 format: uri type: string 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 android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_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 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 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: customer tech_prefix: string record_type: ip_connection rtcp_settings: capture_enabled: true port: rtcp-mux report_frequency_secs: 10 tags: - tag1 - tag2 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' tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri 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 JWKSet: properties: keys: items: properties: alg: description: Algorithm type: string kid: description: Key ID type: string kty: description: Key type type: string use: description: Key use type: string type: object type: array type: object JoinConferenceRequest: example: beep_enabled: always call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Please note that the client_state will be updated for the participient call leg and the change will not affect conferencing webhooks unless the participient is the owner of the conference. 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 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 any command with the same `command_id` for the same `call_control_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: uri nullable: true type: string status: description: Status of the ledger billing group report enum: - pending - complete - failed - deleted type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. format: date-time type: string type: object ListBucketsResponse: properties: Buckets: items: properties: CreationDate: format: date-time type: string Name: type: string type: object xml: name: Bucket type: array xml: wrapped: true type: object xml: name: ListAllMyBucketsResult ListObjectsResponse: properties: Contents: items: properties: Key: type: string LastModified: format: date-time type: string Size: type: number type: object type: array Name: type: string type: object xml: name: ListBucketResult ListPushCredentialsResponse: description: Mobile mobile push credentials properties: data: items: $ref: '#/components/schemas/PushCredential' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object ListVerificationsResponse: properties: data: items: $ref: '#/components/schemas/Verification' type: array meta: $ref: '#/components/schemas/verify_Meta' required: - data - meta title: ListVerificationsResponse type: object ListVerifiedNumbersResponse: description: A paginated list of Verified Numbers properties: data: items: $ref: '#/components/schemas/VerifiedNumberResponse' type: array meta: $ref: '#/components/schemas/verified-numbers_Meta' required: - data - meta title: ListVerifiedNumbersResponse type: object ListVerifyProfileMessageTemplateResponse: description: A list of Verify profile message templates properties: data: items: $ref: '#/components/schemas/VerifyProfileMessageTemplateResponse' type: array required: - data title: ListVerifyProfileMessageTemplateResponse type: object ListVerifyProfilesResponse: description: A paginated list of Verify profiles properties: data: items: $ref: '#/components/schemas/VerifyProfileResponse' type: array meta: $ref: '#/components/schemas/verify_Meta' required: - data - meta title: ListVerifyProfilesResponse type: object Location: properties: additional_info: example: 14th Floor type: string description: example: Austin Office type: string id: $ref: '#/components/schemas/UUID' is_default: description: Represents whether the location is the default or not. type: boolean title: Location type: object LocationResponse: properties: data: properties: accepted_address_suggestions: type: boolean location_id: format: uuid type: string static_emergency_address_id: format: uuid type: string type: object type: object LogMessage: properties: code: example: '10015' format: int64 type: string detail: example: The value provided for the attribute is not valid. Check the value used and try again. type: string meta: properties: external_connection_id: description: The external connection the log message is associated with, if any. example: '1293384261075731499' format: int64 type: string telephone_number: description: The telephone number the log message is associated with, if any. example: '+12345678' type: string ticket_id: description: The ticket ID for an operation that generated the log message, if any. example: 542c3bca-d247-42bc-8fe7-e01d16ecd761 format: uuid type: string type: object source: properties: pointer: description: JSON pointer (RFC6901) to the offending entity. example: /attribute format: json-pointer type: string type: object title: example: Invalid attribute type: string required: - code - title type: object Loopcount: oneOf: - type: string - type: integer MCC: properties: code: description: Mobile Country Code. example: '311' type: string name: description: The name of the country. example: United States of America type: string required: - code - name title: Mobile Country Code type: object MMSFallback: properties: from: description: Phone number in +E.164 format example: '+13125551234' type: string media_urls: description: List of media URLs items: type: string type: array subject: description: Subject of the message example: Test Message type: string text: description: Text example: Hello world! type: string type: object ManagedAccount: properties: api_key: description: The managed account's V2 API access key example: KEY01236170692E74656C6E79782E636F6D_YmlnIGlyb24gaXMgZGVhZA 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 managed_account_allow_custom_pricing: description: Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect. example: true type: boolean 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 rollup_billing: description: Boolean value that indicates if the billing information and charges to the managed account "roll up" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false. example: false type: boolean 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 ManagedAccountMultiListing: properties: api_user: description: The manager account's email, which serves as the V1 API user identifier example: managed_account@example.com type: string 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 managed_account_allow_custom_pricing: description: Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect. example: true type: boolean 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 rollup_billing: description: Boolean value that indicates if the billing information and charges to the managed account "roll up" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false. example: false type: boolean 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_user - manager_account_id - created_at - updated_at title: ManagedAccount type: object ManagedAccountsGlobalOutboundChannels: example: allocatable_global_outbound_channels: 500 record_type: allocatable_global_outbound_channels total_global_channels_allocated: 135 properties: allocatable_global_outbound_channels: description: The total amount of allocatable global outbound channels available to the authenticated manager. Will be 0 if the feature is not enabled for their account. example: 500 type: integer managed_account_allow_custom_pricing: description: Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed, but there may be time lag between when the value is changed and pricing changes take effect. example: false type: boolean record_type: description: The type of the data contained in this record. example: allocatable_global_outbound_channels type: string total_global_channels_allocated: description: The total number of allocatable global outbound channels currently allocated across all managed accounts for the authenticated user. This includes any amount of channels allocated by default at managed account creation time. Will be 0 if the feature is not enabled for their account. example: 135 type: integer title: Managed Accounts Global Outbound Channels type: object MdrDeleteUsageReportsResponse: properties: data: $ref: '#/components/schemas/MdrUsageReportResponse' 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 MdrGetDetailResponse: properties: data: items: $ref: '#/components/schemas/MdrDetailResponse' type: array meta: $ref: '#/components/schemas/reporting_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/reporting_PaginationMeta' 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 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 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 MediaName: 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. media_name and media_url/contents can't be submitted together. example: my_media_uploaded_to_media_storage_api type: string MediaResource: example: content_type: application/xml 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: content_type: description: Content type of the file example: application/xml type: string 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 MediaStorageDetailRecord: properties: action_type: description: Type of action performed against the Media Storage API example: upload type: string asset_id: description: Asset id example: a46f4764-4ce4-4391-804c-02f00bc4ff9b type: string cost: description: Currency amount for Telnyx billing cost example: '0.004' type: string created_at: description: Event 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 id: description: Unique identifier for the Media Storage Event example: 3ca7bd3d-7d82-4e07-9df4-009123068320 type: string link_channel_id: description: Link channel id example: 2065f482-64b9-4680-a3a9-c6d3142efdf7 type: string link_channel_type: description: Link channel type example: message type: string org_id: description: Organization owner id example: 3ca7bd3d-7d82-4e07-9df4-009123068320 type: string rate: description: Currency amount per billing unit used to calculate the Telnyx billing cost example: '0.0001' type: string rate_measured_in: description: Billing unit used to calculate the Telnyx billing cost example: events type: string record_type: default: media_storage example: media_storage type: string status: description: Request status example: failed type: string user_id: description: User id example: 3ca7bd3d-7d82-4e07-9df4-009123068320 type: string webhook_id: description: Webhook id example: b46f4764-4ce4-4391-804c-02f00bc4ff9b type: string required: - record_type type: object MediaUrl: description: The URL (or list of URLs) to the PDF used for the fax's media. media_url and media_name/contents can't be submitted together. example: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf type: string 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 MessageTemplateResponseDataWrapper: properties: data: $ref: '#/components/schemas/VerifyProfileMessageTemplateResponse' title: MessageTemplateResponseDataWrapper type: object 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: - carrier_rejected - compliance_review_failed - deleted - failed - incomplete_documentation - incorrect_billing_information - ineligible_carrier - loa_file_invalid - loa_file_successful - pending - provisioning - successful type: string type: object MessagingProfile: example: created_at: '2019-01-23T18:10:02.574Z' daily_spend_limit: '100.00' daily_spend_limit_enabled: false enabled: true health_webhook_url: null id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 mms_fall_back_to_sms: false mms_transcoding: false 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 redaction_enabled: false redaction_level: 2 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: alpha_sender: description: The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID. nullable: true pattern: ^[A-Za-z0-9 ]{1,11}$ type: string created_at: description: ISO 8601 formatted date indicating when the resource was created. format: date-time readOnly: true type: string daily_spend_limit: description: The maximum amount of money (in USD) that can be spent by this profile before midnight UTC. pattern: ^[0-9]+(?:\.[0-9]+)?$ type: string daily_spend_limit_enabled: description: Whether to enforce the value configured by `daily_spend_limit`. type: boolean 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 mms_fall_back_to_sms: default: false description: enables SMS fallback for MMS messages. type: boolean mms_transcoding: default: false description: enables automated resizing of MMS media. type: boolean 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. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. items: description: ISO 3166-1 alpha-2 country code. pattern: ^[A-Z]{2}$ type: string 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 MessagingSettings: properties: default_messaging_profile_id: description: Default Messaging Profile used for messaging exchanges with your assistant. This will be created automatically on assistant creation. type: string delivery_status_webhook_url: description: The URL where webhooks related to delivery statused for assistant messages will be sent. type: string 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: type: integer page_size: type: integer total_pages: type: integer total_results: type: integer required: - total_pages - total_results - page_number - page_size title: Meta type: object MetaResponse: properties: url: description: This should likely be a URL to the relevant documentation example: https://developers.telnyx.com/docs/overview/errors/10001 type: string 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 MigrationParams: properties: bytes_migrated: description: Total amount of data that has been succesfully migrated. readOnly: true type: integer bytes_to_migrate: description: Total amount of data found in source bucket to migrate. readOnly: true type: integer created_at: description: Time when data migration was created example: - '2020-01-01T00:00:00Z' format: date-time readOnly: true type: string eta: description: Estimated time the migration will complete. example: - '2020-01-01T00:00:00Z' format: date-time readOnly: true type: string id: description: Unique identifier for the data migration. readOnly: true type: string last_copy: description: Time when data migration was last copied from the source. example: - '2020-01-01T00:00:00Z' format: date-time readOnly: true type: string refresh: description: If true, will continue to poll the source bucket to ensure new data is continually migrated over. type: boolean source_id: description: ID of the Migration Source from which to migrate data. type: string speed: description: Current speed of the migration. readOnly: true type: integer status: description: Status of the migration. enum: - pending - checking - migrating - complete - error - stopped readOnly: true type: string target_bucket_name: description: Bucket name to migrate the data into. Will default to the same name as the `source_bucket_name`. type: string target_region: description: Telnyx Cloud Storage region to migrate the data to. type: string required: - source_id - target_bucket_name - target_region type: object MigrationSourceCoverageParams: properties: provider: description: Cloud provider from which to migrate data. enum: - aws type: string source_region: description: Provider region from which to migrate data. type: string type: object MigrationSourceParams: properties: bucket_name: description: Bucket name to migrate the data from. type: string id: description: Unique identifier for the data migration source. readOnly: true type: string provider: description: Cloud provider from which to migrate data. Use 'telnyx' if you want to migrate data from one Telnyx bucket to another. enum: - aws - telnyx type: string provider_auth: properties: access_key: description: AWS Access Key. For Telnyx-to-Telnyx migrations, use your Telnyx API key here. type: string secret_access_key: description: AWS Secret Access Key. For Telnyx-to-Telnyx migrations, use your Telnyx API key here as well. type: string type: object source_region: description: For intra-Telnyx buckets migration, specify the source bucket region in this field. type: string required: - provider - provider_auth - bucket_name type: object MnoMetadata: properties: '10999': $ref: '#/components/schemas/MnoMetadataItem' title: MnoMetadata type: object MnoMetadataItem: properties: minMsgSamples: example: 1 type: integer mno: type: string mnoReview: type: boolean mnoSupport: type: boolean noEmbeddedLink: type: boolean noEmbeddedPhone: type: boolean qualify: type: boolean reqSubscriberHelp: type: boolean reqSubscriberOptin: type: boolean reqSubscriberOptout: type: boolean required: - qualify - mno - noEmbeddedLink - reqSubscriberHelp - reqSubscriberOptout - mnoReview - noEmbeddedPhone - mnoSupport - reqSubscriberOptin - minMsgSamples title: MnoMetadataItem type: object MobileCountryCode: description: Mobile Country Code. example: '311' type: string MobileNetworkOperator: 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/>\n 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 network operator name. example: AT&T Mobility (USACG) type: string network_preferences_enabled: description: Indicate whether the mobile network operator can be set as preferred in the Network Preferences API. example: true readOnly: true type: boolean record_type: description: Identifies the type of the resource. example: mobile_network_operator 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: MobileNetworkOperator type: object MobileNetworkOperatorPreferencesResponse: description: '' properties: mobile_network_operator_id: description: The mobile network operator resource identification UUID. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string mobile_network_operator_name: description: The mobile network operator resource name. example: AT&T Mobility (USACG) type: string priority: description: It determines what is the priority of a specific network operator 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 MobileNetworkOperatorsPreferencesResponse: description: A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network. items: $ref: '#/components/schemas/MobileNetworkOperatorPreferencesResponse' type: array ModelMetadata: properties: created: title: Created type: integer id: title: Id type: string object: default: model title: Object type: string owned_by: title: Owned By type: string required: - id - created - owned_by title: ModelMetadata type: object ModelsResponse: properties: data: items: $ref: '#/components/schemas/ModelMetadata' title: Data type: array object: default: list title: Object type: string required: - data title: ModelsResponse type: object Monochrome: default: false description: The flag to enable monochrome, true black and white fax results. type: boolean MonthDetail: properties: mrc: description: Monthly recurring charge amount as decimal string example: '25.50' type: string otc: description: One-time charge amount as decimal string example: '5.00' nullable: true type: string quantity: description: Number of items example: 10 type: integer required: - quantity - mrc type: object MonthlyChargesBreakdownResponse: properties: data: $ref: '#/components/schemas/BreakdownData' required: - data type: object MonthlyChargesSummaryResponse: properties: data: $ref: '#/components/schemas/SummaryAndTotal' required: - data type: object Network: allOf: - $ref: '#/components/schemas/Record' - properties: name: description: A user specified name for the network. example: test network type: string record_type: description: Identifies the type of the resource. example: network readOnly: true type: string title: Network type: object NetworkCoverage: properties: available_services: description: List of interface types supported in this region. items: oneOf: - $ref: '#/components/schemas/AvailableService' type: array location: $ref: '#/components/schemas/netapps_Location' record_type: description: Identifies the type of the resource. example: network_coverage readOnly: true type: string title: NetworkCoverage type: object NetworkCreate: allOf: - $ref: '#/components/schemas/Network' - required: - name title: NetworkCreate type: object NetworkInterface: allOf: - $ref: '#/components/schemas/Record' - $ref: '#/components/schemas/Interface' - $ref: '#/components/schemas/RegionOut' - properties: record_type: description: Identifies the type of the resource. example: network_interface readOnly: true type: string type: description: Identifies the type of the interface. example: wireguard_interface readOnly: true type: string title: NetworkInterface type: object NewBillingGroup: example: name: string properties: name: description: A name for the billing group type: string type: object 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 type: object NewParticipantResource: example: account_sid: 4e71926f-8f13-450e-b91c-23c2ef786aa6 call_sid: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ coaching: false coaching_call_sid: null conference_sid: cd5a70f4-759b-4d5e-9c06-88c00f16f3c1 end_conference_on_exit: false hold: false muted: false status: completed uri: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json properties: account_sid: description: The id of the account the resource belongs to. example: 61bf923e-5e4d-4595-a110-56190ea18a1b type: string call_sid: description: The identifier of this participant's call. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string coaching: description: Whether the participant is coaching another call. example: false type: boolean coaching_call_sid: description: The identifier of the coached participant's call. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string end_conference_on_exit: description: Whether the conference ends when the participant leaves. example: false type: boolean hold: description: Whether the participant is on hold. example: false type: boolean muted: description: Whether the participant is muted. example: false type: boolean status: description: The status of the participant's call in the conference. enum: - connecting - connected - completed example: in-progress type: string uri: description: The relative URI for this participant. example: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json type: string title: New participant resource type: object NoiseSuppressionDirection: default: inbound description: The direction of the audio stream to be noise suppressed. enum: - inbound - outbound - both example: outbound title: Noise Suppression Direction type: string NoiseSuppressionEngine: default: A description: "The engine to use for noise suppression. \nA - rnnoise engine\ \ \nB - deepfilter engine." enum: - A - B example: A title: Noise Suppression Engine type: string NoiseSuppressionStart: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 direction: both noise_suppression_engine: A 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string direction: $ref: '#/components/schemas/NoiseSuppressionDirection' noise_suppression_engine: $ref: '#/components/schemas/NoiseSuppressionEngine' title: Noise Suppression Start Request type: object NoiseSuppressionStop: 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string title: Noise Suppression Stop Request type: object NotFoundError: properties: code: title: Telnyx error code type: string detail: title: Error details type: string title: title: Error title type: string required: - detail title: NotFoundError type: object 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 type: object 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 type: object 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 type: object 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 type: object 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 type: object 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: date-time 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' 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: date-time readOnly: true type: string type: object NumberBreakdownResult: properties: charge_type: description: Type of charge for the number example: local type: string service_owner_email: description: Email address of the service owner example: user@example.com format: email type: string service_owner_user_id: description: User ID of the service owner example: 0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8 type: string services: description: List of services associated with this number items: $ref: '#/components/schemas/ServiceDetail' type: array tn: description: Phone number example: '+15551234567' type: string required: - tn - charge_type - service_owner_user_id - service_owner_email - services type: object 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: date-time 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/PhoneNumbersJobPhoneNumber' description: The unique phone numbers given as arguments in the job creation. type: array 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 sub_number_orders_ids: items: type: string type: array updated_at: description: An ISO 8901 datetime string for when the number order was updated. example: '2018-01-01T00:00:00.000000Z' format: date-time readOnly: true type: string title: Number Order With Phone Numbers 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: date-time 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 type: object NumberOrderPhoneNumber: properties: bundle_id: example: null format: uuid readOnly: true type: string country_code: example: US type: string deadline: example: 024-05-31T11:14:00+00:00 format: date-time type: string id: example: dc8e4d67-33a0-4cbb-af74-7b58f05bd494 format: uuid readOnly: true type: string is_block_number: example: false type: boolean locality: example: San Francisco type: string order_request_id: example: dc8e4d67-33a0-4cbb-af74-7b58f05bd495 format: uuid type: string phone_number: example: '+19705555098' type: string phone_number_type: enum: - local - toll_free - mobile - national - shared_cost - landline example: local type: string record_type: example: number_order_phone_number readOnly: true type: string regulatory_requirements: items: $ref: '#/components/schemas/SubNumberOrderRegulatoryRequirementWithValue' type: array requirements_met: description: True if all requirements are met for a phone number, false otherwise. example: true readOnly: true type: boolean requirements_status: description: Status of requirements (if applicable) enum: - pending - approved - cancelled - deleted - requirement-info-exception - requirement-info-pending - requirement-info-under-review readOnly: true type: string 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 type: object NumberOrderPhoneNumberRequirementGroupResponse: properties: bundle_id: format: uuid nullable: true type: string country_code: example: AT type: string deadline: format: date-time type: string id: example: 613d517a-0432-4bae-a785-c11033bd0985 format: uuid type: string is_block_number: example: false type: boolean locality: example: AUSTRIA type: string order_request_id: example: a11d58fe-88a4-494a-b752-8dea411993c6 format: uuid type: string phone_number: example: '+43800300238' type: string phone_number_type: example: toll_free type: string record_type: example: number_order_phone_number type: string regulatory_requirements: items: properties: field_type: example: textual type: string field_value: example: '1234567890' type: string requirement_id: format: uuid type: string status: example: pending-approval type: string type: object type: array requirements_met: example: false type: boolean requirements_status: example: requirement-info-under-review type: string status: example: pending type: string sub_number_order_id: example: f826ed66-b27c-4340-9dc0-57dc3459f1bd format: uuid type: string type: object NumberOrderWebhookEvent: properties: data: properties: event_type: description: The type of event being sent example: number_order.complete type: string id: description: Unique identifier for the event example: d578b093-a0e7-4b64-b0d3-6b689a6ff170 format: uuid type: string occurred_at: description: ISO 8601 timestamp of when the event occurred example: '2025-08-22T16:23:54.496464Z' format: date-time type: string payload: $ref: '#/components/schemas/NumberOrderWithPhoneNumbers' record_type: description: Type of record example: event type: string required: - event_type - id - occurred_at - payload - record_type type: object meta: properties: attempt: description: Webhook delivery attempt number example: 1 type: integer delivered_to: description: URL where the webhook was delivered example: https://sample-api.com/webhook format: uri type: string required: - attempt - delivered_to type: object required: - data - meta title: Number Order Event type: object NumberOrderWebhookPayload: properties: billing_group_id: description: Identifies the billing group associated with the phone number. example: null nullable: true type: string connection_id: description: Identifies the connection associated with this phone number. example: null nullable: true type: string created_at: example: '2025-08-22T16:23:50.762227+00:00' format: date-time type: string customer_reference: example: null nullable: true type: string id: description: Unique identifier for the number order example: b1425b7e-92a2-4a24-a709-fdd0cc4293e8 format: uuid type: string messaging_profile_id: description: Identifies the messaging profile associated with the phone number. example: null nullable: true type: string phone_numbers: items: properties: bundle_id: example: null format: uuid nullable: true type: string country_code: description: Country code of the phone number example: US type: string id: example: c7d55dc7-bca4-47d1-a739-9a45bbf8717f format: uuid type: string phone_number: example: '+14803935977' type: string phone_number_type: enum: - local - mobile - national - shared_cost - toll_free example: local type: string record_type: example: number_order_phone_number type: string regulatory_requirements: items: type: object type: array requirements_met: example: true type: boolean requirements_status: enum: - pending - approved - cancelled - deleted - requirement-info-exception - requirement-info-pending - requirement-info-under-review example: approved type: string status: enum: - pending - success - failure example: success type: string type: object type: array phone_numbers_count: description: The count of phone numbers in the number order. example: 1 type: integer record_type: description: Type of record example: number_order type: string requirements_met: example: true type: boolean status: enum: - pending - success - failure example: success type: string sub_number_orders_ids: example: - 01bdf068-363d-4878-8210-051761613cf0 items: type: string type: array updated_at: example: '2025-08-22T16:23:50.762227+00:00' format: date-time type: string title: Number Order Webhook Payload type: object NumberOrderWithPhoneNumbers: 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: date-time 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' description: The unique phone numbers given as arguments in the job creation. type: array 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 sub_number_orders_ids: items: type: string type: array updated_at: description: An ISO 8901 datetime string for when the number order was updated. example: '2018-01-01T00:00:00.000000Z' format: date-time readOnly: true type: string title: NumberOrder 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: date-time 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: date-time readOnly: true type: string type: object OAuthClient: properties: allowed_grant_types: description: List of allowed OAuth grant types items: enum: - client_credentials - authorization_code - refresh_token type: string type: array allowed_scopes: description: List of allowed OAuth scopes items: type: string type: array client_id: description: OAuth client identifier type: string client_secret: description: Client secret (only included when available, for confidential clients) nullable: true type: string client_type: description: OAuth client type enum: - public - confidential type: string created_at: description: Timestamp when the client was created format: date-time type: string logo_uri: description: URL of the client logo format: uri nullable: true type: string name: description: Human-readable name for the OAuth client type: string org_id: description: Organization ID that owns this OAuth client type: string policy_uri: description: URL of the client's privacy policy format: uri nullable: true type: string record_type: description: Record type identifier enum: - oauth_client type: string redirect_uris: description: List of allowed redirect URIs items: format: uri type: string type: array require_pkce: description: Whether PKCE (Proof Key for Code Exchange) is required for this client type: boolean tos_uri: description: URL of the client's terms of service format: uri nullable: true type: string updated_at: description: Timestamp when the client was last updated format: date-time type: string user_id: description: User ID that created this OAuth client type: string required: - record_type - client_id - name - org_id - user_id - client_type - require_pkce - created_at - updated_at type: object OAuthClientCreateRequest: additionalProperties: false properties: allowed_grant_types: description: List of allowed OAuth grant types items: enum: - client_credentials - authorization_code - refresh_token type: string type: array allowed_scopes: description: List of allowed OAuth scopes example: - admin items: type: string type: array client_type: description: OAuth client type enum: - public - confidential type: string logo_uri: description: URL of the client logo format: uri type: string name: description: The name of the OAuth client example: My OAuth client type: string policy_uri: description: URL of the client's privacy policy format: uri type: string redirect_uris: default: [] description: List of redirect URIs (required for authorization_code flow) items: format: uri type: string type: array require_pkce: default: false description: Whether PKCE (Proof Key for Code Exchange) is required for this client type: boolean tos_uri: description: URL of the client's terms of service format: uri type: string required: - name - allowed_scopes - client_type - allowed_grant_types type: object OAuthClientUpdateRequest: additionalProperties: false properties: allowed_grant_types: description: List of allowed OAuth grant types items: enum: - client_credentials - authorization_code - refresh_token type: string type: array allowed_scopes: description: List of allowed OAuth scopes example: - admin items: type: string type: array logo_uri: description: URL of the client logo format: uri type: string name: description: The name of the OAuth client type: string policy_uri: description: URL of the client's privacy policy format: uri type: string redirect_uris: description: List of redirect URIs items: format: uri type: string type: array require_pkce: description: Whether PKCE (Proof Key for Code Exchange) is required for this client type: boolean tos_uri: description: URL of the client's terms of service format: uri type: string type: object OAuthDynamicRegistrationRequest: additionalProperties: false properties: client_name: description: Human-readable string name of the client to be presented to the end-user example: My OAuth Application type: string grant_types: default: - authorization_code description: Array of OAuth 2.0 grant type strings that the client may use items: enum: - authorization_code - client_credentials - refresh_token type: string type: array logo_uri: description: URL of the client logo format: uri type: string policy_uri: description: URL of the client's privacy policy format: uri type: string redirect_uris: description: Array of redirection URI strings for use in redirect-based flows example: - https://example.com/callback items: format: uri type: string type: array response_types: default: - code description: Array of the OAuth 2.0 response type strings that the client may use items: type: string type: array scope: description: Space-separated string of scope values that the client may use example: admin type: string token_endpoint_auth_method: default: client_secret_basic description: Authentication method for the token endpoint enum: - none - client_secret_basic - client_secret_post type: string tos_uri: description: URL of the client's terms of service format: uri type: string type: object OAuthDynamicRegistrationResponse: properties: client_id: description: Unique client identifier example: abc123def456 type: string client_id_issued_at: description: Unix timestamp of when the client ID was issued type: integer client_name: description: Human-readable client name type: string client_secret: description: Client secret (only for confidential clients) type: string grant_types: description: Array of allowed grant types items: type: string type: array logo_uri: description: URL of the client logo format: uri type: string policy_uri: description: URL of the client's privacy policy format: uri type: string redirect_uris: description: Array of redirection URIs items: format: uri type: string type: array response_types: description: Array of allowed response types items: type: string type: array scope: description: Space-separated scope values type: string token_endpoint_auth_method: description: Token endpoint authentication method type: string tos_uri: description: URL of the client's terms of service format: uri type: string required: - client_id - client_id_issued_at type: object OAuthGrant: properties: client_id: description: OAuth client identifier type: string created_at: description: Timestamp when the grant was created format: date-time type: string id: description: Unique identifier for the OAuth grant format: uuid type: string last_used_at: description: Timestamp when the grant was last used format: date-time nullable: true type: string record_type: description: Record type identifier enum: - oauth_grant type: string scopes: description: List of granted OAuth scopes items: type: string type: array required: - id - record_type - client_id - scopes - created_at type: object OptOutItem: properties: created_at: description: The timestamp when the opt-out was created example: '2025-04-28 12:00:38.631252' format: date-time type: string from: description: Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code). format: address type: string keyword: description: The keyword that triggered the opt-out. example: STOP nullable: true type: string messaging_profile_id: description: Unique identifier for a messaging profile. nullable: true type: string to: $ref: '#/components/schemas/ToNumber' type: object OptOutListResponse: properties: data: items: $ref: '#/components/schemas/OptOutItem' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object OrderExternalVetting: properties: evpId: description: External vetting provider ID for the brand. maxLength: 10 title: Evpid type: string vettingClass: description: Identifies the vetting classification. title: Vettingclass type: string required: - evpId - vettingClass title: OrderExternalVetting type: object OriginalMediaUrl: 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 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 OutboundFqdn: properties: ani_override: description: Set a phone number as the ani_override value to override caller id number on outbound calls. format: E.164 title: ANI override type type: string ani_override_type: default: always description: Specifies when we should apply your ani_override setting. Only applies when ani_override is not blank. enum: - always - normal - emergency example: normal title: ANI override type 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. nullable: true type: boolean channel_limit: description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection. type: integer encrypted_media: $ref: '#/components/schemas/EncryptedMedia' generate_ringback_tone: default: false description: Generate ringback tone through 183 session progress message with early media. type: boolean instant_ringback_enabled: default: false description: When set, ringback will not wait for indication before sending ringback tone to calling party. type: boolean ip_authentication_method: default: ip-authentication enum: - credential-authentication - ip-authentication example: credential-authentication type: string ip_authentication_token: type: string 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/connections_OutboundVoiceProfileId' t38_reinvite_source: default: customer description: This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite. 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: description: Numerical chars only, exactly 4 characters. 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).' maximum: 600 minimum: 1 type: integer title: Connection Outbound Settings 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: customer 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. nullable: true 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/connections_OutboundVoiceProfileId' t38_reinvite_source: default: customer 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: Outbound Ip type: object OutboundMessage: example: event_type: message.sent id: 86f58db9-0fe3-4adc-9d1f-46e66e6e9323 occurred_at: date-time payload: cc: [] completed_at: null cost: amount: 0.0051 currency: USD cost_breakdown: carrier_fee: amount: 0.00305 currency: USD rate: amount: 0.00205 currency: USD 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 tcr_campaign_billable: true tcr_campaign_id: TCPA3X7 tcr_campaign_registered: REGISTERED 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: cc: [] completed_at: null cost: amount: 0.0051 currency: USD cost_breakdown: carrier_fee: amount: 0.00305 currency: USD rate: amount: 0.00205 currency: USD 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 tcr_campaign_billable: true tcr_campaign_id: TCPA3X7 tcr_campaign_registered: REGISTERED 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 cost_breakdown: description: Detailed breakdown of the message cost components. nullable: true properties: carrier_fee: properties: amount: description: The carrier fee amount. format: decimal type: string currency: description: The ISO 4217 currency identifier. format: iso4217 type: string type: object rate: properties: amount: description: The rate amount applied. format: decimal type: string currency: description: The ISO 4217 currency identifier. format: iso4217 type: string type: object 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/messaging_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 tcr_campaign_billable: description: Indicates whether the TCR campaign is billable. type: boolean tcr_campaign_id: description: The Campaign Registry (TCR) campaign ID associated with the message. nullable: true type: string tcr_campaign_registered: description: The registration status of the TCR campaign. example: REGISTERED nullable: true type: string 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 OutboundMessagePayloadCancelled: example: cc: [] completed_at: null cost: amount: 0.0 currency: null cost_breakdown: null direction: outbound encoding: GSM-7 errors: [] from: carrier: TELNYX LLC line_type: VoIP phone_number: '+18445550001' id: 40385f64-5717-4562-b3fc-2c963f66afa6 media: [] 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 tcr_campaign_billable: true tcr_campaign_id: TCPA3X7 tcr_campaign_registered: REGISTERED text: Hello, World! to: - carrier: T-MOBILE USA, INC. line_type: Wireless phone_number: '+18665550001' status: cancelled type: SMS 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 cost_breakdown: description: Detailed breakdown of the message cost components. nullable: true properties: carrier_fee: properties: amount: description: The carrier fee amount. format: decimal type: string currency: description: The ISO 4217 currency identifier. format: iso4217 type: string type: object rate: properties: amount: description: The rate amount applied. format: decimal type: string currency: description: The ISO 4217 currency identifier. format: iso4217 type: string type: object 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/messaging_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 tcr_campaign_billable: description: Indicates whether the TCR campaign is billable. type: boolean tcr_campaign_id: description: The Campaign Registry (TCR) campaign ID associated with the message. nullable: true type: string tcr_campaign_registered: description: The registration status of the TCR campaign. example: REGISTERED nullable: true type: string 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: - scheduled - queued - sending - sent - cancelled - 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' 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' title: Outbound Voice Profile ID type: string PLMN: properties: code: description: Public land mobile network code (MCC + MNC). example: '311210' type: string name: description: The name of the network. example: Telnyx, LLC type: string required: - code - name title: Public land mobile network type: object PLMNCode: description: Public land mobile network code (MCC + MNC). example: '311210' type: string PWGAssignedResourcesSummary: description: The summary of the resource that have been assigned to the Private Wireless Gateway. properties: count: description: The current count of a resource type assigned to the Private Wireless Gateway. example: 1 readOnly: true type: integer record_type: description: The type of the resource assigned to the Private Wireless Gateway. example: sim_card_group readOnly: true type: string type: object PaginatedAssistantTestList: description: 'Paginated list of assistant tests with metadata. Returns a subset of tests based on pagination parameters along with metadata for implementing pagination controls in the UI.' properties: data: description: Array of assistant test objects for the current page. items: $ref: '#/components/schemas/AssistantTestResponse' title: Data type: array meta: allOf: - $ref: '#/components/schemas/Meta' description: Pagination metadata including total counts and current page info. required: - meta - data title: PaginatedAssistantTestList type: object PaginatedBillingBundlesResponse: properties: data: items: $ref: '#/components/schemas/BillingBundleSummary' title: Data type: array meta: $ref: '#/components/schemas/PaginationResponse' required: - meta - data title: PaginatedBillingBundlesResponse type: object PaginatedScheduledEventList: properties: data: items: anyOf: - $ref: '#/components/schemas/ScheduledPhoneCallEventResponse' - $ref: '#/components/schemas/ScheduledSmsEventResponse' title: Data type: array meta: $ref: '#/components/schemas/Meta' required: - meta - data title: PaginatedScheduledEventList type: object PaginatedTestRunList: description: 'Paginated list of test runs with metadata. Returns test run execution results with pagination support for handling large numbers of test executions.' properties: data: description: Array of test run objects for the current page. items: $ref: '#/components/schemas/TestRunResponse' title: Data type: array meta: $ref: '#/components/schemas/Meta' description: Pagination metadata including total counts and current page info. required: - meta - data title: PaginatedTestRunList type: object PaginatedUserBundlesResponse: properties: data: items: $ref: '#/components/schemas/UserBundle' title: Data type: array meta: $ref: '#/components/schemas/PaginationResponse' required: - meta - data title: PaginatedUserBundlesResponse type: object Paginated_VerificationRequestStatus_: description: A paginated response properties: records: default: [] description: The records yielded by this request items: $ref: '#/components/schemas/VerificationRequestStatus' title: Records type: array total_records: default: 0 description: The total amount of records for these query parameters title: Total Records type: integer title: Paginated[VerificationRequestStatus] type: object PaginationData: properties: page_number: description: Selected page number. example: '1' type: integer page_size: description: Records per single page example: '20' type: integer total_pages: description: Total number of pages. example: '5' type: integer total_results: description: Total number of results. example: '100' type: integer type: object 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 PaginationResponse: properties: page_number: description: The current page number. example: 2 title: Page Number type: integer page_size: description: The number of results per page. example: 25 title: Page Size type: integer total_pages: description: Total number of pages from the results. example: 3 title: Total Pages type: integer total_results: description: Total number of results returned. example: 55 title: Total Results type: integer required: - total_results - total_pages - page_number - page_size title: PaginationResponse type: object Participant: example: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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 ParticipantJoined: example: event_type: video.room.session.started id: 6b61621f-62e0-4aad-ab11-9fd19e272e73 occurred_at: '2018-02-02T22:25:27.521992Z' payload: context: Alice participant_id: 5ccc7b54-4df3-4bca-a65a-35a1ecc777f0 room_id: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73 record_type: event properties: event_type: description: The type of event being delivered. enum: - video.room.participant.joined example: video.room.participant.joined type: string id: description: Uniquely identify the event. 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: context: description: Context provided to the given participant through the client SDK example: Alice type: string participant_id: description: Participant ID that identifies the participant that joined. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string room_id: description: Room ID that identifies the room where the participant joined. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string session_id: description: Session ID that identifies the session where the participant joined. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string type: object record_type: description: An identifier for the type of the resource. enum: - event example: event type: string title: Participant Joined type: object ParticipantJoinedEvent: properties: data: $ref: '#/components/schemas/ParticipantJoined' title: Participant Joined Event type: object ParticipantLeft: example: event_type: video.room.session.started id: 6b61621f-62e0-4aad-ab11-9fd19e272e73 occurred_at: '2018-02-02T22:25:27.521992Z' payload: context: Alice duration_secs: 34 left_reason: kick participant_id: 5ccc7b54-4df3-4bca-a65a-35a1ecc777f0 room_id: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73 record_type: event properties: event_type: description: The type of event being delivered. enum: - video.room.participant.left example: video.room.participant.left type: string id: description: Uniquely identify the event. 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: context: description: Context provided to the given participant through the client SDK example: Alice type: string duration_secs: description: The duration in seconds of the participant in the session example: 245 type: integer left_reason: description: The reason why the participant left example: kicked type: string participant_id: description: Participant ID that identifies the participant that left. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string room_id: description: Room ID that identifies the room where the participant left. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string session_id: description: Session ID that identifies the session where the participant left. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string type: object record_type: description: An identifier for the type of the resource. enum: - event example: event type: string title: Participant Left type: object ParticipantLeftEvent: properties: data: $ref: '#/components/schemas/ParticipantLeft' title: Participant Left Event type: object ParticipantResource: example: account_sid: 4e71926f-8f13-450e-b91c-23c2ef786aa6 api_version: v2/texml call_sid: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ call_sid_legacy: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ coaching: false coaching_call_sid: null coaching_call_sid_legacy: null conference_sid: cd5a70f4-759b-4d5e-9c06-88c00f16f3c1 date_created: Fri, 27 Oct 2023 07:41:58 +0000 date_updated: Fri, 27 Oct 2023 07:41:58 +0000 end_conference_on_exit: false hold: false muted: false status: completed uri: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json properties: account_sid: description: The id of the account the resource belongs to. example: 61bf923e-5e4d-4595-a110-56190ea18a1b type: string api_version: description: The version of the API that was used to make the request. example: v2/texml type: string call_sid: description: The identifier of this participant's call. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string call_sid_legacy: description: The identifier of this participant's call. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string coaching: description: Whether the participant is coaching another call. example: false type: boolean coaching_call_sid: description: The identifier of the coached participant's call. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string coaching_call_sid_legacy: description: The identifier of the coached participant's call. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string date_created: description: The timestamp of when the resource was created. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string date_updated: description: The timestamp of when the resource was last updated. example: Thu, 15 Jun 2023 09:56:45 +0000 type: string end_conference_on_exit: description: Whether the conference ends when the participant leaves. example: false type: boolean hold: description: Whether the participant is on hold. example: false type: boolean muted: description: Whether the participant is muted. example: false type: boolean status: description: The status of the participant's call in the conference. enum: - connecting - connected - completed example: in-progress type: string uri: description: The relative URI for this participant. example: /v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json type: string title: Participant resource type: object ParticipantResourceIndex: example: end: 0 first_page_uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20 next_page_uri: null page: 0 page_size: 20 participants: [] start: 0 uri: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20 properties: end: description: The number of the last element on the page, zero-indexed. example: 19 type: integer first_page_uri: description: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20 example: accepted type: string next_page_uri: description: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ example: accepted type: string page: description: Current page number, zero-indexed. example: 0 type: integer page_size: description: The number of items on the page example: 20 type: integer participants: items: $ref: '#/components/schemas/ParticipantResource' type: array start: description: The number of the first element on the page, zero-indexed. example: 0 type: integer uri: description: The URI of the current page. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?Page=0&PageSize=1 type: string title: Multiple participant resources type: object PatchRoomRequest: properties: enable_recording: default: false description: Enable or disable recording for that room. example: true type: boolean 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 webhook_event_failover_url: default: '' description: The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. example: https://failover.example.com format: uri nullable: true type: string webhook_event_url: description: The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'. example: https://example.com format: uri 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 type: object PauseConferenceRecordingRequest: properties: command_id: description: Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string recording_id: description: Use this field to pause specific recording. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string title: Pause Recording Request 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string recording_id: description: Uniquely identifies the resource. example: 6e00ab49-9487-4364-8ad6-23965965afb2 format: uuid type: string title: Pause Recording Request type: object PhoneNumber: example: bundle_id: bc8e4d67-33a0-4cbb-af74-7b58f05bd474 id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494 phone_number: '+19705555098' record_type: number_order_phone_number 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: bundle_id: example: bc8e4d67-33a0-4cbb-af74-7b58f05bd494 format: uuid readOnly: true type: string country_code: description: Country code of the phone number example: US readOnly: true type: string country_iso_alpha2: description: The ISO 3166-1 alpha-2 country code of the phone number. example: US readOnly: true type: string id: example: dc8e4d67-33a0-4cbb-af74-7b58f05bd494 format: uuid readOnly: true type: string phone_number: example: '+19705555098' type: string phone_number_type: description: Phone number type enum: - local - mobile - national - shared_cost - toll_free readOnly: true type: string record_type: example: number_order_phone_number readOnly: true type: string regulatory_requirements: items: $ref: '#/components/schemas/SubNumberOrderRegulatoryRequirementWithValue' type: array requirements_met: description: True if all requirements are met for a phone number, false otherwise. example: true readOnly: true type: boolean requirements_status: description: Status of document requirements (if applicable) enum: - pending - approved - cancelled - deleted - requirement-info-exception - requirement-info-pending - requirement-info-under-review readOnly: true type: string status: description: The status of the phone number in the order. enum: - pending - success - failure readOnly: true type: string type: object 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/numbers_Error' type: array id: description: The phone number's ID type: string phone_number: description: The phone number in e164 format. type: string type: object PhoneNumberBlocksJobSuccessfulOperation: properties: id: description: The phone number's ID type: string phone_number: description: The phone number in e164 format. type: string type: object PhoneNumberBundleStatusChangeRequest: example: bundle_id: 5194d8fc-87e6-4188-baa9-1c434bbe861b properties: bundle_id: description: The new bundle_id setting for the number. If you are assigning the number to a bundle, this is the unique ID of the bundle you wish to use. If you are removing the number from a bundle, this must be null. You cannot assign a number from one bundle to another directly. You must first remove it from a bundle, and then assign it to a new bundle. type: string required: - bundle_id type: object PhoneNumberCampaign: properties: assignmentStatus: description: The assignment status of the number. enum: - FAILED_ASSIGNMENT - PENDING_ASSIGNMENT - ASSIGNED - PENDING_UNASSIGNMENT - FAILED_UNASSIGNMENT example: ASSIGNED title: AssignmentStatus type: string brandId: description: Brand ID. Empty if the number is associated to a shared campaign. example: 7ba705b7-22af-493f-addc-ac04b7ca071c title: BrandId type: string campaignId: description: 'For shared campaigns, this is the TCR campaign ID, otherwise it is the campaign ID ' title: Campaignid type: string createdAt: example: '2021-03-08T17:57:48.801186' title: Createdat type: string failureReasons: description: Extra info about a failure to assign/unassign a number. Relevant only if the assignmentStatus is either FAILED_ASSIGNMENT or FAILED_UNASSIGNMENT type: string phoneNumber: example: '+18005550199' title: Phonenumber type: string tcrBrandId: description: TCR's alphanumeric ID for the brand. example: BBRAND1 title: TcrBrandId type: string tcrCampaignId: description: TCR's alphanumeric ID for the campaign. example: CCAMPA1 title: TcrCampaignid type: string telnyxCampaignId: description: Campaign ID. Empty if the number is associated to a shared campaign. example: 3008dd9f-66d7-40e0-bf23-bf2d8d1a96ba title: Telnyxcampaignid type: string updatedAt: example: '2021-03-08T17:57:48.801186' title: Updatedat type: string required: - phoneNumber - campaignId - createdAt - updatedAt title: PhoneNumberCampaign type: object PhoneNumberCampaignCreate: properties: campaignId: description: The ID of the campaign you want to link to the specified phone number. example: 4b300178-131c-d902-d54e-72d90ba1620j title: Campaignid type: string phoneNumber: description: The phone number you want to link to a specified campaign. example: '+18005550199' title: Phonenumber type: string required: - phoneNumber - campaignId title: PhoneNumberCampaignCreate type: object PhoneNumberCampaignPaginated: properties: page: title: Page type: integer records: items: $ref: '#/components/schemas/PhoneNumberCampaign' title: Records type: array totalRecords: title: Totalrecords type: integer required: - records - page - totalRecords title: PhoneNumberCampaignPaginated type: object 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' hd_voice_enabled: true id: '1293384261075731499' messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000 messaging_profile_name: regional-customers phone_number: '+19705555098' phone_number_type: local 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. 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/numbers_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 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: - local - toll_free - mobile - national - shared_cost - landline 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 country_iso_alpha2: US created_at: '2019-10-23T18:10:00.000Z' customer_reference: customer-reference emergency_address_id: '1315261609962112019' emergency_enabled: true emergency_status: active external_pin: '1234' hd_voice_enabled: true id: '1293384261075731499' inbound_call_screening: disabled messaging_profile_id: abc85f64-5717-4562-b3fc-2c9600000000 messaging_profile_name: regional-customers phone_number: '+19705555098' phone_number_type: local purchased_at: '2019-10-23T18:10:00.000Z' record_type: phone_number source_type: number_order 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 country_iso_alpha2: description: The ISO 3166-1 alpha-2 country code of the phone number. example: US 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. readOnly: true type: string emergency_enabled: description: Indicates whether emergency services are enabled for this number. readOnly: true type: boolean emergency_status: description: Indicates the status of the provisioning of emergency services for the phone number. This field contains information about activity that may be ongoing for a number where it either is being provisioned or deprovisioned but is not yet enabled/disabled. enum: - active - deprovisioning - disabled - provisioning - provisioning-failed 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, 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/numbers_IntId' inbound_call_screening: default: disabled description: The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it. enum: - disabled - reject_calls - flag_calls type: string 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 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. Note: For numbers purchased prior to July 2023 or when fetching a number''s details immediately after a purchase completes, the legacy values `tollfree`, `shortcode` or `longcode` may be returned instead.' enum: - local - toll_free - mobile - national - shared_cost - landline - tollfree - shortcode - longcode 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 source_type: description: Indicates if the phone number was purchased or ported in. For some numbers this information may not be available. enum: - number_order - port_request nullable: true 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 - requirement-info-pending - requirement-info-under-review - requirement-info-exception - provision-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. type: string emergency_enabled: description: Indicates whether to enable emergency services on this number. type: boolean required: - emergency_enabled - emergency_address_id type: object PhoneNumberStatusResponsePaginated: properties: records: items: $ref: '#/components/schemas/ProfileAssignmentPhoneNumbers' title: Records type: array required: - records title: PhoneNumberStatusResponsePaginated type: object PhoneNumberVerifyOwnershipRequest: properties: phone_numbers: description: Array of phone numbers to verify ownership for items: description: Phone number in E.164 format example: '+15551234567' type: string maxItems: 1000 minItems: 1 type: array required: - phone_numbers type: object PhoneNumberVerifyOwnershipResponse: properties: found: description: The list of phone numbers which you own and are in an editable state items: properties: id: $ref: '#/components/schemas/numbers_IntId' number_val_e164: description: The phone number in E.164 format example: '+15551234567' type: string type: object type: array not_found: description: Phone numbers that are not found in the account items: description: Phone number in E.164 format example: '+15551234568' type: string type: array record_type: description: Identifies the type of the resource. example: number_ownership_verification readOnly: true 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 emergency_status: active id: '1293384261075731499' inbound_call_screening: disabled media_features: accept_any_rtp_packets_enabled: true 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 inbound_call_screening: default: disabled description: The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it. enum: - disabled - reject_calls - flag_calls 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/numbers_Error' type: array phone_number: description: The phone number in e164 format. type: string type: object 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' phone_numbers: - id: '2637816387126861836' - phone_number: '+19715555098' - phone_number: '+19705555099' - id: '3388768018273' 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 phone_numbers: items: $ref: '#/components/schemas/PhoneNumbersJobPhoneNumber' description: The unique phone numbers given as arguments in the job creation. 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: Array of phone number ids and/or phone numbers in E164 format to update type: string type: array required: - phone_numbers type: object PhoneNumbersJobFailedOperation: properties: errors: items: $ref: '#/components/schemas/numbers_Error' type: array id: description: The phone number's ID type: string phone_number: description: The phone number in e164 format. type: string type: object PhoneNumbersJobPendingOperation: properties: id: description: The phone number's ID type: string phone_number: description: The phone number in e164 format. type: string type: object PhoneNumbersJobPhoneNumber: properties: id: description: The phone number's ID type: string phone_number: description: The phone number in e164 format. example: '+19705555000' type: string type: object PhoneNumbersJobSuccessfulOperation: properties: id: description: The phone number's ID type: string phone_number: description: The phone number in e164 format. type: string type: object 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. Required if emergency_enabled is true, must be null or omitted if emergency_enabled is false. nullable: true type: string emergency_enabled: description: Indicates whether to enable or disable emergency services on the numbers. type: boolean phone_numbers: items: description: Array of phone number ids and/or phone numbers in E164 format to update type: string type: array required: - emergency_enabled - 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 voice: call_forwarding: call_forwarding_enabled: true forwarding_type: always forwards_to: '+13035559123' 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 hd_voice_enabled: description: Indicates whether to enable or disable HD Voice on each phone number. HD Voice is a paid feature and may not be available for all phone numbers, more details about it can be found in the Telnyx support documentation. type: boolean phone_numbers: description: Array of phone number ids and/or phone numbers in E164 format to update. This parameter is required if no filter parameters are provided. If you want to update specific numbers rather than all numbers matching a filter, you must use this parameter. Each item must be either a valid phone number ID or a phone number in E164 format (e.g., '+13127367254'). items: type: string type: array tags: description: A list of user-assigned tags to help organize phone numbers. items: type: string type: array voice: $ref: '#/components/schemas/UpdatePhoneNumberVoiceSettingsRequest' 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_type: default: mp3 description: Specifies the type of audio provided in `audio_url` or `playback_content`. enum: - mp3 - wav example: wav type: string 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 cache_audio: default: true description: Caches the audio file. Useful when playing the same audio file multiple times during the call. example: true type: boolean 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 any command with the same `command_id` for the same `call_control_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 playback_content: description: 'Allows a user to provide base64 encoded mp3 or wav. Note: when using this parameter, `media_url` and `media_name` in the `playback_started` and `playback_ended` webhooks will be empty' example: SUQzAwAAAAADf1... type: string stop: 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 PlayBeep: default: true description: Whether to play a beep when recording is started. example: false type: boolean PlaybackStopRequest: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 overlay: false 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string overlay: default: false description: When enabled, it stops the audio being played in the overlay queue. example: true type: boolean stop: default: all description: Use `current` to stop the current audio being played. Use `all` to stop the current audio file being played and clear all audio files from the queue. example: current type: string title: Playback Stop Request type: object PortOutSupportingDocument: example: created_at: '2018-02-02T22:25:27.521Z' document_id: f1c5e079-9d82-4f50-95bc-ae2f6b8d84d7 id: 5a16902a-2ee9-4882-a247-420fc6627b62 portout_id: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 record_type: supporting_document type: loa updated_at: '2018-02-02T22:25:27.521Z' properties: created_at: description: Supporting document creation timestamp in ISO 8601 format example: '2018-02-02T22:25:27.521Z' type: string document_id: description: Identifies the associated document example: f1c5e079-9d82-4f50-95bc-ae2f6b8d84d7 format: uuid type: string id: example: 5a16902a-2ee9-4882-a247-420fc6627b62 format: uuid type: string portout_id: description: Identifies the associated port request example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid readOnly: true type: string record_type: description: Identifies the type of the resource. example: supporting_document readOnly: true type: string type: description: Identifies the type of the document enum: - loa - invoice example: loa readOnly: true type: string updated_at: description: Supporting document last changed timestamp in ISO 8601 format example: '2018-02-02T22:25:27.521Z' type: string required: - id - record_type - type - portout_id - document_id - created_at - updated_at 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 PortingActionRequirement: properties: action_type: description: The type of action required example: document_upload type: string action_url: description: Optional URL for the action example: https://example.com/action nullable: true type: string cancel_reason: description: Reason for cancellation if status is 'cancelled' example: null nullable: true type: string created_at: description: ISO 8601 formatted date-time indicating when the resource was created example: '2018-02-02T22:25:27.521Z' format: date-time type: string id: description: Identifies the action requirement example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 type: string porting_order_id: description: The ID of the porting order this action requirement belongs to example: 12ade33a-21c0-473b-b055-b3c836e1c292 type: string record_type: description: Identifies the type of the resource enum: - porting_action_requirement example: porting_action_requirement type: string requirement_type_id: description: The ID of the requirement type example: 53970723-fbff-4f46-a975-f62be6c1a585 type: string status: description: Current status of the action requirement enum: - created - pending - completed - cancelled - failed example: created type: string updated_at: description: ISO 8601 formatted date-time indicating when the resource was updated example: '2018-02-02T22:25:27.521Z' format: date-time type: string type: object PortingAdditionalDocument: properties: content_type: description: The content type of the related document. example: text/plain type: string created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string document_id: description: Identifies the associated document example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string document_type: description: Identifies the type of additional document enum: - loa - invoice - csr - other example: loa type: string filename: description: The filename of the related document. example: file.txt type: string id: description: Uniquely identifies this additional document example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string porting_order_id: description: Identifies the associated porting order example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_additional_document readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingAssociatedPhoneNumber: properties: action: description: Specifies the action to take with this phone number during partial porting. enum: - keep - disconnect example: keep type: string country_code: description: Specifies the country code for this associated phone number. It is a two-letter ISO 3166-1 alpha-2 country code. example: GB 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 readOnly: true type: string id: description: Uniquely identifies this associated phone number. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid readOnly: true type: string phone_number_range: description: Specifies the phone number range for this associated phone number. properties: end_at: description: Specifies the end of the phone number range for this associated phone number. example: '+441234567899' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the phone number range for this associated phone number. example: '+441234567890' pattern: ^\+\d{7,15}$ type: string type: object phone_number_type: description: Specifies the phone number type for this associated phone number. enum: - landline - local - mobile - national - shared_cost - toll_free example: local type: string porting_order_id: description: Identifies the porting order associated with this phone number. example: a24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_associated_phone_number readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was last updated. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string type: object PortingEvent: properties: available_notification_methods: description: Indicates the notification methods used. items: enum: - email - webhook - webhook_v1 type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string event_type: description: Identifies the event type enum: - porting_order.deleted - porting_order.loa_updated - porting_order.messaging_changed - porting_order.status_changed - porting_order.sharing_token_expired - porting_order.new_comment - porting_order.split example: porting_order.deleted type: string id: description: Uniquely identifies the event. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string payload: oneOf: - $ref: '#/components/schemas/WebhookPortingOrderDeletedPayload' - $ref: '#/components/schemas/WebhookPortingOrderMessagingChangedPayload' - $ref: '#/components/schemas/WebhookPortingOrderStatusChangedPayload' - $ref: '#/components/schemas/WebhookPortingOrderNewCommentPayload' - $ref: '#/components/schemas/WebhookPortingOrderSplitPayload' payload_status: description: The status of the payload generation. enum: - created - completed example: created type: string porting_order_id: description: Identifies the porting order associated with the event. example: 9471c873-e3eb-4ca1-957d-f9a451334d52 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_event readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingLOAConfiguration: properties: address: description: The address of the company. properties: city: description: The locality of the company example: Austin type: string country_code: description: The country code of the company example: US pattern: ^[A-Z]{2}$ type: string extended_address: description: The extended address of the company example: 14th Floor type: string state: description: The administrative area of the company example: TX pattern: ^[A-Z]{2}$ type: string street_address: description: The street address of the company example: 600 Congress Avenue type: string zip_code: description: The postal code of the company example: '78701' pattern: ^[0-9]{5}(?:-[0-9]{4})?$ type: string type: object company_name: description: The name of the company example: Telnyx type: string contact: description: The contact information of the company. properties: email: description: The email address of the contact example: testing@telnyx.com type: string phone_number: description: The phone number of the contact example: '+12003270001' pattern: ^\+\d{11,15}$ type: string type: object created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string id: description: Uniquely identifies the LOA configuration. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string logo: description: The logo to be used in the LOA. properties: content_type: description: The content type of the logo. enum: - image/png example: image/png type: string document_id: description: Identifies the document that contains the logo. example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string type: object name: description: The name of the LOA configuration example: My LOA Configuration type: string organization_id: description: The organization that owns the LOA configuration example: f1486bae-f067-460c-ad43-73a92848f902 type: string record_type: description: Identifies the type of the resource. example: porting_loa_configuration readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingOrder: properties: activation_settings: $ref: '#/components/schemas/PortingOrderActivationSettings' additional_steps: description: For specific porting orders, we may require additional steps to be taken before submitting the porting order. items: enum: - associated_phone_numbers - phone_number_verification_codes type: string type: array 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 customer_reference: description: A customer-specified reference number for customer bookkeeping purposes example: Acct 123abc type: string description: description: A description of the porting order example: FP Telnyx readOnly: true type: string documents: $ref: '#/components/schemas/PortingOrderDocuments' end_user: $ref: '#/components/schemas/PortingOrderEndUser' id: description: Uniquely identifies this porting order example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid readOnly: true type: string messaging: $ref: '#/components/schemas/PortingOrderMessaging' misc: $ref: '#/components/schemas/PortingOrderMisc' old_service_provider_ocn: description: Identifies the old service provider example: Unreal Communications readOnly: true type: string parent_support_key: description: A key to reference for the porting order group when contacting Telnyx customer support. This information is not available for porting orders in `draft` state example: pr_123abc readOnly: true type: string phone_number_configuration: $ref: '#/components/schemas/PortingOrderPhoneNumberConfiguration' phone_number_type: description: The type of the phone number enum: - landline - local - mobile - national - shared_cost - toll_free example: local type: string 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. Can be set directly or via the `requirement_group_id` parameter. items: $ref: '#/components/schemas/PortingOrderRequirement' type: array requirements_met: description: Is true when the required documentation is met example: false type: boolean status: $ref: '#/components/schemas/PortingOrderStatus' support_key: description: A key to reference this porting order when contacting Telnyx customer support. This information is not available in draft porting orders. example: sr_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_id: description: Identifies the user (or organization) who requested the porting order example: 40d68ba2-0847-4df2-be9c-b0e0cb673e75 format: uuid type: string webhook_url: example: https://example.com/porting_webhooks format: uri type: string type: object PortingOrderActivationSettings: properties: activation_status: $ref: '#/components/schemas/PortingOrderActivationStatus' 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 PortingOrderActivationStatus: description: Activation status enum: - New - Pending - Conflict - Cancel Pending - Failed - Concurred - Activate RDY - Disconnect Pending - Concurrence Sent - Old - Sending - Active - Cancelled example: Active type: string PortingOrderDocuments: description: Can be specified directly or via the `requirement_group_id` parameter. properties: invoice: description: Returned ID of the submitted Invoice via the Documents endpoint example: ce74b771-d23d-4960-81ec-8741b3862146 format: uuid type: string loa: description: Returned ID of the submitted LOA via the Documents endpoint example: 64ffb720-04c7-455b-92d6-20fcca92e935 format: uuid type: string type: object PortingOrderEndUser: properties: admin: $ref: '#/components/schemas/PortingOrderEndUserAdmin' location: $ref: '#/components/schemas/PortingOrderEndUserLocation' 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: TX 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: 14th Floor type: string locality: description: City or municipality of billing address example: Austin type: string postal_code: description: Postal Code of billing address example: '78701' type: string street_address: description: First line of billing address example: 600 Congress Avenue type: string type: object PortingOrderMessaging: description: Information about messaging porting process. properties: enable_messaging: description: Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider. example: true type: boolean messaging_capable: description: Indicates whether the porting order can also port messaging capabilities. example: true type: boolean messaging_port_completed: description: Indicates whether the messaging porting has been completed. example: false type: boolean messaging_port_status: description: The current status of the messaging porting. enum: - not_applicable - pending - activating - exception - canceled - partial_port_complete - ported example: pending 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: 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 type: $ref: '#/components/schemas/PortingOrderType' type: object PortingOrderPhoneNumberConfiguration: properties: billing_group_id: description: identifies the billing group to set on the numbers when ported example: f1486bae-f067-460c-ad43-73a92848f902 type: string 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 PortingOrderRequirementDetail: properties: field_type: description: Type of value expected on field_value field enum: - document - textual 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_status: description: Status of the requirement example: approved type: string requirement_type: description: Identifies the requirement type that meets this requirement properties: acceptance_criteria: additionalProperties: true description: The acceptance criteria for the requirement type example: acceptable_values: [] type: object description: description: A description of the requirement type example: A copy of the latest phone bill from the current provider type: string example: description: An example of the requirement type example: Most recent phone bill type: string id: description: Identifies the requirement type example: 53970723-fbff-4f46-a975-f62be6c1a585 type: string name: description: The name of the requirement type example: Latest Invoice type: string type: description: The type of the requirement type example: document type: string type: object type: object PortingOrderSharingToken: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string expires_at: description: ISO 8601 formatted date indicating when the sharing token expires. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string expires_in_seconds: description: The number of seconds until the sharing token expires example: 3600 minimum: 1 type: integer id: description: Uniquely identifies this sharing token example: 0a4b78a0-d416-4761-94f7-46c72ec56547 format: uuid type: string permissions: description: The permissions granted to the sharing token example: - porting_order.document.read - porting_order.document.update items: enum: - porting_order.document.read - porting_order.document.update type: string type: array porting_order_id: description: Identifies the porting order resource being shared example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_order_sharing_token readOnly: true type: string token: description: A signed JWT token that can be used to access the shared resource example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODk4OTQ2NzcsImlzdCI6MTY4OTg5MTA3NywicGVybWlzc2lvbnMiOlsicG9ydGluZ19vcmRlci5kb2N1bWVudC5yZWFkIl0sInBvcnRpbmdfb3JkZXJfaWQiOiJmZDRiODZjOC00OTdkLTRjNmQtOTYwOS1hNzg5ZTRlMTRjZmUifQ.CT0HRF6OLj7VPZ8p5Y_0S8rOL8SEUznwJJkR-YReKwc 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 - cancelled - 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 cancelled, the user may rate their experience example: 5 type: integer type: object PortingOrdersActivationJob: properties: activate_at: description: ISO 8601 formatted date indicating when the activation job should be executed. This time should be between some activation window. example: '2021-03-19T10:07:15.527Z' format: date-time type: string activation_type: description: Specifies the type of this activation job enum: - scheduled - on-demand type: string activation_windows: description: List of allowed activation windows for this activation job items: properties: end_at: description: ISO 8601 formatted date indicating when the activation window ends example: '2021-03-19T10:07:15.527Z' format: date-time type: string start_at: description: ISO 8601 formatted date indicating when the activation window starts example: '2021-03-19T10:07:15.527Z' format: date-time type: string type: object type: array 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 PortingOrdersAllowedFocWindow: properties: ended_at: description: ISO 8601 formatted date indicating the end of the range of foc window example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string record_type: description: Identifies the type of the resource. example: porting_order readOnly: true type: string started_at: description: ISO 8601 formatted date indicating the start of the range of foc window. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string title: PortingOrdersAllowedFocWindow 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 - 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 PortingPhoneNumber: properties: activation_status: $ref: '#/components/schemas/PortingOrderActivationStatus' phone_number: description: E164 formatted phone number example: 13035550987 type: string phone_number_type: description: The type of the phone number enum: - landline - local - mobile - national - shared_cost - toll_free example: local type: string portability_status: $ref: '#/components/schemas/PortabilityStatus' porting_order_id: description: Identifies the associated port request example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string porting_order_status: description: The current status of the porting order enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled example: in-process type: string record_type: description: Identifies the type of the resource. example: porting_phone_number readOnly: true type: string requirements_status: description: The current status of the requirements in a INTL porting order enum: - requirement-info-pending - requirement-info-under-review - requirement-info-exception - approved example: approved type: string support_key: description: A key to reference this porting order when contacting Telnyx customer support example: sr_a12345 type: string type: object PortingPhoneNumberBlock: properties: activation_ranges: description: Specifies the activation ranges for this porting phone number block. The activation range must be within the phone number range and should not overlap with other activation ranges. items: properties: end_at: description: Specifies the end of the activation range. It must be no more than the end of the phone number range. example: '+4930244999910' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the activation range. Must be greater or equal the start of the phone number range. example: '+4930244999901' pattern: ^\+\d{7,15}$ type: string type: object type: array country_code: description: Specifies the country code for this porting phone number block. It is a two-letter ISO 3166-1 alpha-2 country code. example: DE 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 readOnly: true type: string id: description: Uniquely identifies this porting phone number block. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid readOnly: true type: string phone_number_range: description: Specifies the phone number range for this porting phone number block. properties: end_at: description: Specifies the end of the phone number range for this porting phone number block. example: '+4930244999910' pattern: ^\+\d{7,15}$ type: string start_at: description: Specifies the start of the phone number range for this porting phone number block. example: '+4930244999901' pattern: ^\+\d{7,15}$ type: string type: object phone_number_type: description: Specifies the phone number type for this porting phone number block. enum: - landline - local - mobile - national - shared_cost - toll_free example: local type: string record_type: description: Identifies the type of the resource. example: porting_phone_number_block readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was last updated. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string type: object PortingPhoneNumberConfiguration: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string id: description: Uniquely identifies this phone number configuration example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string porting_phone_number_id: description: Identifies the associated porting phone number example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_phone_number_configuration readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string user_bundle_id: description: Identifies the associated user bundle example: daa4308e-742f-4867-97f2-3073db13319a format: uuid type: string type: object PortingPhoneNumberExtension: properties: activation_ranges: description: Specifies the activation ranges for this porting phone number extension. The activation range must be within the extension range and should not overlap with other activation ranges. items: properties: end_at: description: Specifies the end of the activation range. It must be no more than the end of the extension range. example: 10 type: integer start_at: description: Specifies the start of the activation range. Must be greater or equal the start of the extension range. example: 1 type: integer type: object type: array 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 extension_range: description: Specifies the extension range for this porting phone number extension. properties: end_at: description: Specifies the end of the extension range for this porting phone number extension. example: 10 type: integer start_at: description: Specifies the start of the extension range for this porting phone number extension. example: 1 type: integer type: object id: description: Uniquely identifies this porting phone number extension. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid readOnly: true type: string porting_phone_number_id: description: Identifies the porting phone number associated with this porting phone number extension. example: f24151b6-3389-41d3-8747-7dd8c681e5e2 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_phone_number_extension readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was last updated. example: '2021-03-19T10:07:15.527Z' format: date-time readOnly: true type: string type: object PortingReport: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string document_id: description: Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status. example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string id: description: Uniquely identifies the report. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string params: oneOf: - $ref: '#/components/schemas/ExportPortingOrdersCSVReport' record_type: description: Identifies the type of the resource. example: porting_report readOnly: true type: string report_type: description: Identifies the type of report enum: - export_porting_orders_csv example: export_porting_orders_csv type: string status: description: The current status of the report generation. enum: - pending - completed example: completed type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingUKCarrier: properties: alternative_cupids: description: Alternative CUPIDs of the carrier. items: description: An alternative CUPID of the carrier. example: '895' type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string cupid: description: The CUPID of the carrier. This is a 3 digit number code that identifies the carrier in the UK. example: '895' type: string id: description: Identifies the UK carrier. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string name: description: The name of the carrier. example: Telnyx UK Limited type: string record_type: description: Identifies the type of the resource. example: porting_uk_carrier type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortingVerificationCode: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string id: description: Uniquely identifies this porting verification code example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string phone_number: description: E164 formatted phone number example: '+13035550987' type: string porting_order_id: description: Identifies the associated porting order example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string record_type: description: Identifies the type of the resource. example: porting_verification_code readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string verified: description: Indicates whether the verification code has been verified example: true type: boolean 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 type: object PortoutDetails: properties: already_ported: description: Is true when the number is already ported example: false type: boolean authorized_name: description: Name of person authorizing the porting order example: McPortersen type: string carrier_name: description: Carrier the number will be ported out to example: test type: string city: description: City or municipality of billing address example: Chicago type: string created_at: description: ISO 8601 formatted date of when the portout was created example: '2018-02-02T22:25:27.521Z' type: string current_carrier: description: The current carrier example: telnyx type: string end_user_name: description: Person name or company name requesting the port example: McPortersen type: string foc_date: description: ISO 8601 formatted Date/Time of the FOC date example: '2018-02-02T22:25:27.521Z' type: string host_messaging: default: false description: Indicates whether messaging services should be maintained with Telnyx after the port out completes example: false type: boolean id: example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 type: string inserted_at: description: ISO 8601 formatted date of when the portout was created example: '2018-02-02T22:25:27.521Z' type: string lsr: description: The Local Service Request example: - https://example.com/files/lsr.pdf items: description: A link to the Local Service Request format: uri type: string type: array phone_numbers: description: Phone numbers associated with this portout example: - '+35312345678' items: description: E164 formatted phone number type: string type: array pon: description: Port order number assigned by the carrier the number will be ported out to example: '00000000' type: string reason: description: The reason why the order is being rejected by the user. If the order is authorized, this field can be left null example: null type: string record_type: description: Identifies the type of the resource. example: portout readOnly: true type: string rejection_code: description: The rejection code for one of the valid rejections to reject a port out order example: 1002 type: integer requested_foc_date: description: ISO 8601 formatted Date/Time of the user requested FOC date example: '2018-02-02T22:25:27.521Z' type: string service_address: description: First line of billing address (street address) example: 000 Example Street type: string spid: description: New service provider spid example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 type: string state: description: State, province, or similar of billing address example: IL type: string status: description: Status of portout request enum: - pending - authorized - ported - rejected - rejected-pending - canceled example: rejected type: string support_key: description: A key to reference this port out request when contacting Telnyx customer support example: PO_764725 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 user_id: description: Identifies the user (or organization) who requested the port out example: 7865816a-ee85-4e50-b19e-52983dcc6d4a format: uuid type: string vendor: description: Telnyx partner providing network coverage example: 0e66ed3b-37e6-4fed-93d6-a30ce2493661 format: uuid type: string zip: description: Postal Code of billing address example: '00000' type: string type: object PortoutEvent: properties: available_notification_methods: description: Indicates the notification methods used. items: enum: - email - webhook type: string type: array created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string event_type: description: Identifies the event type enum: - portout.status_changed - portout.foc_date_changed - portout.new_comment example: portout.status_changed type: string id: description: Uniquely identifies the event. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string payload: oneOf: - $ref: '#/components/schemas/WebhookPortoutStatusChangedPayload' - $ref: '#/components/schemas/WebhookPortoutNewCommentPayload' - $ref: '#/components/schemas/WebhookPortoutFocDateChangedPayload' payload_status: description: The status of the payload generation. enum: - created - completed example: created type: string portout_id: description: Identifies the port-out order associated with the event. example: 9471c873-e3eb-4ca1-957d-f9a451334d52 format: uuid type: string record_type: description: Identifies the type of the resource. example: portout_event readOnly: true type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PortoutRejection: properties: code: example: 1002 type: integer description: example: Invalid PIN type: string reason_required: example: false type: boolean type: object PortoutReport: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string document_id: description: Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status. example: f1486bae-f067-460c-ad43-73a92848f902 format: uuid type: string id: description: Uniquely identifies the report. example: eef3340b-8903-4466-b445-89b697315a3a format: uuid type: string params: oneOf: - $ref: '#/components/schemas/ExportPortoutsCSVReport' record_type: description: Identifies the type of the resource. example: portout_report readOnly: true type: string report_type: description: Identifies the type of report enum: - export_portouts_csv example: export_portouts_csv type: string status: description: The current status of the report generation. enum: - pending - completed example: completed type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2021-03-19T10:07:15.527000Z' format: date-time type: string type: object PresignedObjectUrl: properties: content: properties: expires_at: description: The expiration time of the token format: date-time type: string presigned_url: description: The presigned URL for the object type: string token: description: The token for the object type: string type: object type: object PresignedObjectUrlParams: properties: ttl: description: The time to live of the token in seconds example: - 60 maximum: 604800 minimum: 1 type: integer type: object PrivacySettings: properties: data_retention: description: "If true, conversation history and insights will be stored.\ \ If false, they will not be stored. This in\u2011tool toggle governs\ \ solely the retention of conversation history and insights via the AI\ \ assistant. It has no effect on any separate recording, transcription,\ \ or storage configuration that you have set at the account, number, or\ \ application level. All such external settings remain in force regardless\ \ of your selection here." type: boolean type: object PrivateWirelessGateway: properties: assigned_resources: description: A list of the resources that have been assigned to the Private Wireless Gateway. items: $ref: '#/components/schemas/PWGAssignedResourcesSummary' type: array 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: null description: The name of the region where the Private Wireless Gateway is deployed. example: dc2 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 PrivateWirelessGatewayStatus: description: The current status or failure details of the Private Wireless Gateway. properties: error_code: default: null description: This attribute is an [error code](https://developers.telnyx.com/api/errors) 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>\n <li><code>provisioning</code> - the Private Wireless\ \ Gateway is being provisioned.</li>\n <li><code>provisioned</code> -\ \ the Private Wireless Gateway was provisioned and able to receive connections.</li>\n\ \ <li><code>failed</code> - the provisioning had failed for a reason and\ \ it requires an intervention.</li>\n <li><code>decommissioning</code>\ \ - the Private Wireless Gateway is being removed from the network.</li>\n\ \ </ul>\n Transitioning between the provisioning and provisioned states\ \ may take some time." enum: - provisioning - provisioned - failed - decommissioning example: provisioned readOnly: true type: string type: object ProfileAssignmentPhoneNumbers: properties: phoneNumber: description: The phone number that the status is being checked for. example: '+12024567890' title: Phonenumber type: string status: description: The status of the associated phone number assignment. example: pending title: Status type: string taskId: description: The ID of the task associated with the phone number. example: 667a80f8-b0a9-49d0-b9ab-a7a1bcc45086 title: Taskid type: string required: - taskId - phoneNumber - status title: ProfileAssignmentPhoneNumbers type: object PublicInternetGateway: allOf: - $ref: '#/components/schemas/Record' - $ref: '#/components/schemas/Interface' - properties: public_ip: description: The publically accessible ip for this interface. example: 127.0.0.1 readOnly: true type: string record_type: description: Identifies the type of the resource. example: public_internet_gateway readOnly: true type: string title: PublicInternetGateway type: object PublicInternetGatewayCreate: allOf: - $ref: '#/components/schemas/PublicInternetGateway' - $ref: '#/components/schemas/RegionIn' - title: PublicInternetGatewayCreate type: object PublicInternetGatewayRead: allOf: - $ref: '#/components/schemas/PublicInternetGateway' - $ref: '#/components/schemas/RegionOut' PublicTextClusteringRequest: properties: bucket: description: The embedded storage bucket to compute the clusters from. The bucket must already be [embedded](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding). type: string files: description: Array of files to filter which are included. items: type: string type: array min_cluster_size: default: 25 description: Smallest number of related text chunks to qualify as a cluster. Top-level clusters should be thought of as identifying broad themes in your data. type: integer min_subcluster_size: default: 5 description: Smallest number of related text chunks to qualify as a sub-cluster. Sub-clusters should be thought of as identifying more specific topics within a broader theme. type: integer prefix: description: Prefix to filter whcih files in the buckets are included. type: string required: - bucket title: PublicTextClusteringRequest type: object PushCredential: properties: alias: description: Alias to uniquely identify a credential example: LucyCredential type: string certificate: description: Apple certificate for sending push notifications. For iOS only example: '-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----' type: string created_at: description: ISO 8601 timestamp when the room was created example: '2021-03-26T17:51:59.588408Z' format: date-time type: string id: description: Unique identifier of a push credential example: 0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7 type: string private_key: description: Apple private key for a given certificate for sending push notifications. For iOS only example: '-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----' type: string project_account_json_file: additionalProperties: true description: Google server key for sending push notifications. For Android only example: client_email: account@customer.org private_key: BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja... type: object record_type: example: push_credential readOnly: true type: string type: description: Type of mobile push credential. Either <code>ios</code> or <code>android</code> example: ios type: string updated_at: description: ISO 8601 timestamp when the room was updated. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string required: - id - certificate - private_key - project_account_json_file - alias - type - record_type - created_at - updated_at title: Successful response with details about a push credential type: object PushCredentialResponse: description: Success response with details about a push credential properties: data: $ref: '#/components/schemas/PushCredential' type: object Quality: default: high description: The quality of the fax. The `ultra` settings provides the highest quality available, but also present longer fax processing times. `ultra_light` is best suited for images, wihle `ultra_dark` is best suited for text. enum: - normal - high - very_high - ultra_light - ultra_dark example: high 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call example: 428c31b6-7af4-4bcb-b68e-5013ef9657c1 type: string connection_id: description: Call Control App ID (formerly 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 RCSAction: description: When tapped, initiates the corresponding native action on the device. properties: create_calendar_event_action: $ref: '#/components/schemas/RCSCreateCalendarEventAction' dial_action: $ref: '#/components/schemas/RCSDialAction' fallback_url: description: Fallback URL to use if a client doesn't support a suggested action. Fallback URLs open in new browser windows. Maximum 2048 characters. format: url type: string open_url_action: $ref: '#/components/schemas/RCSOpenUrlAction' postback_data: description: Payload (base64 encoded) that will be sent to the agent in the user event that results when the user taps the suggested action. Maximum 2048 characters. type: string share_location_action: $ref: '#/components/schemas/RCSShareLocationAction' text: description: Text that is shown in the suggested action. Maximum 25 characters. example: Hello world type: string view_location_action: $ref: '#/components/schemas/RCSViewLocationAction' type: object RCSAgent: properties: agent_id: description: RCS Agent ID example: TestAgent type: string agent_name: description: Human readable agent name example: Test Agent type: string created_at: description: Date and time when the resource was created example: '2024-01-01T12:00:00.000Z' format: date-time type: string enabled: description: Specifies whether the agent is enabled example: true type: boolean profile_id: description: Messaging profile ID associated with the RCS Agent example: 4001932a-b8a3-42fc-9389-021be6388909 format: uuid nullable: true type: string updated_at: description: Date and time when the resource was updated example: '2024-01-01T12:00:00.000Z' format: date-time type: string user_id: description: User ID associated with the RCS Agent example: 2ecf295b-36c6-4d43-ad05-71eb1e560518 type: string webhook_failover_url: description: Failover URL to receive RCS events example: http://example.com format: url nullable: true type: string webhook_url: description: URL to receive RCS events example: http://example.com format: url nullable: true type: string type: object RCSAgentMessage: properties: content_message: $ref: '#/components/schemas/RCSContentMessage' event: $ref: '#/components/schemas/RCSEvent' expire_time: description: Timestamp in UTC of when this message is considered expired example: '2024-10-02T15:01:23Z' format: date-time type: string ttl: description: Duration in seconds ending with 's' example: 10.5s type: string type: object RCSAgentResponse: properties: data: $ref: '#/components/schemas/RCSAgent' type: object RCSAgentUpdate: properties: profile_id: description: Messaging profile ID associated with the RCS Agent example: 4001932a-b8a3-42fc-9389-021be6388909 format: uuid nullable: true type: string webhook_failover_url: description: Failover URL to receive RCS events example: http://example.com format: url nullable: true type: string webhook_url: description: URL to receive RCS events example: http://example.com format: url nullable: true type: string type: object RCSAgentsResponse: properties: data: items: $ref: '#/components/schemas/RCSAgent' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object RCSCapabilitiesBulk: properties: data: items: $ref: '#/components/schemas/RCSCapabilitiesInternal' type: array type: object RCSCapabilitiesInternal: properties: agent_id: description: RCS agent ID example: TestAgent type: string agent_name: description: RCS agent name example: Testing agent type: string features: description: List of RCS capabilities items: type: string type: array phone_number: description: Phone number example: '+13125551234' type: string record_type: description: Identifies the type of the resource enum: - rcs.capabilities example: rcs.capabilities type: string type: object RCSCapabilitiesSingle: properties: data: $ref: '#/components/schemas/RCSCapabilitiesInternal' type: object RCSCapabilityListRequest: properties: agent_id: description: RCS Agent ID example: TestAgent type: string phone_numbers: description: List of phone numbers to check items: example: '+13125551234' type: string type: array required: - agent_id - phone_numbers type: object RCSCardContent: properties: description: description: Description of the card (at most 2000 characters) type: string media: $ref: '#/components/schemas/RCSMedia' suggestions: description: List of suggestions to include in the card. Maximum 10 suggestions. items: $ref: '#/components/schemas/RCSSuggestion' type: array title: description: Title of the card (at most 200 characters) example: Elephant type: string type: object RCSCarouselCard: description: Carousel of cards. properties: card_contents: description: The list of contents for each card in the carousel. A carousel can have a minimum of 2 cards and a maximum 10 cards. items: $ref: '#/components/schemas/RCSCardContent' type: array card_width: description: The width of the cards in the carousel. enum: - CARD_WIDTH_UNSPECIFIED - SMALL - MEDIUM example: SMALL type: string required: - card_width - card_contents type: object RCSComposeRecordingMessage: description: Initiate the recording and sending of an audio or video message. properties: phone_number: description: phone number in +E.164 format example: '+13125551234' type: string type: description: The type of the recording action. enum: - COMPOSE_RECORDING_ACTION_TYPE_UNSPECIFIED - ACTION_TYPE_AUDIO - ACTION_TYPE_VIDEO type: string required: - phone_number - type type: object RCSComposeTextMessage: description: Compose and send a text message. properties: phone_number: description: phone number in +E.164 format example: '+13125551234' type: string text: description: Draft to go into the send message text field. type: string required: - phone_number type: object RCSContentInfo: properties: file_url: description: Publicly reachable URL of the file. example: https://example.com/elephant.jpg format: url type: string force_refresh: description: If set the URL content will not be cached. type: boolean thumbnail_url: description: Publicly reachable URL of the thumbnail. Maximum size of 100 kB. format: url type: string required: - file_url type: object RCSContentMessage: properties: content_info: $ref: '#/components/schemas/RCSContentInfo' rich_card: $ref: '#/components/schemas/RCSRichCard' suggestions: description: List of suggested actions and replies items: $ref: '#/components/schemas/RCSSuggestion' type: array text: description: Text (maximum 3072 characters) example: Hello world! type: string type: object RCSCreateCalendarEventAction: description: Opens the user's default calendar app and starts the new calendar event flow with the agent-specified event data pre-filled. properties: description: description: Event description. Maximum 500 characters. type: string end_time: example: '2024-10-02T15:02:31Z' format: date-time type: string start_time: example: '2024-10-02T15:01:23Z' format: date-time type: string title: description: Event title. Maximum 100 characters. type: string type: object RCSDeeplinkResponse: properties: data: properties: url: description: The generated deeplink URL example: sms:+18445550001?service_id=my_agent_id%40rbm.goog&body=hello%20world type: string required: - url type: object required: - data type: object RCSDialAction: description: Opens the user's default dialer app with the agent-specified phone number filled in. properties: phone_number: description: Phone number in +E.164 format example: '+13125551234' type: string required: - phone_number type: object RCSEvent: description: RCS Event to send to the recipient properties: event_type: enum: - TYPE_UNSPECIFIED - IS_TYPING - READ example: IS_TYPING type: string type: object RCSFrom: properties: agent_id: description: agent ID example: Agent007 type: string agent_name: example: Test Agent type: string carrier: example: Telnyx type: string type: object RCSLatLng: properties: latitude: description: The latitude in degrees. It must be in the range [-90.0, +90.0]. example: 41.8 type: number longitude: description: The longitude in degrees. It must be in the range [-180.0, +180.0]. example: -87.6 type: number required: - latitude - longitude type: object RCSMedia: description: A media file within a rich card. properties: content_info: $ref: '#/components/schemas/RCSContentInfo' height: description: The height of the media within a rich card with a vertical layout. For a standalone card with horizontal layout, height is not customizable, and this field is ignored. enum: - HEIGHT_UNSPECIFIED - SHORT - MEDIUM - TALL example: MEDIUM type: string type: object RCSMessage: properties: agent_id: description: RCS Agent ID example: Agent007 type: string agent_message: $ref: '#/components/schemas/RCSAgentMessage' messaging_profile_id: description: A valid messaging profile ID type: string mms_fallback: $ref: '#/components/schemas/MMSFallback' sms_fallback: $ref: '#/components/schemas/SMSFallback' to: description: Phone number in +E.164 format example: '+13125551234' type: string type: description: Message type - must be set to "RCS" enum: - RCS example: RCS type: string webhook_url: description: The URL where webhooks related to this message will be sent. format: url type: string required: - agent_id - to - messaging_profile_id - agent_message type: object RCSOpenUrlAction: description: Opens the user's default web browser app to the specified URL. properties: application: description: URL open application, browser or webview. enum: - OPEN_URL_APPLICATION_UNSPECIFIED - BROWSER - WEBVIEW example: BROWSER type: string description: description: Accessbility description for webview. type: string url: example: http://example.com format: url type: string webview_view_mode: enum: - WEBVIEW_VIEW_MODE_UNSPECIFIED - FULL - HALF - TALL example: HALF type: string required: - url - application - webview_view_mode type: object RCSReply: properties: postback_data: description: Payload (base64 encoded) that will be sent to the agent in the user event that results when the user taps the suggested action. Maximum 2048 characters. type: string text: description: Text that is shown in the suggested reply (maximum 25 characters) type: string type: object RCSResponse: properties: data: properties: body: $ref: '#/components/schemas/RCSAgentMessage' direction: example: outbound type: string encoding: example: utf-8 type: string from: $ref: '#/components/schemas/RCSFrom' id: description: message ID example: 4031938e-60e4-4235-a8dd-0b1c55a23e7a type: string messaging_profile_id: example: 4001781e-626f-4a41-a914-b1b682150f94 type: string organization_id: example: 9f61d8e1-7687-4d6d-9cae-9ff682985983 type: string received_at: format: date-time type: string record_type: example: message type: string to: $ref: '#/components/schemas/RCSTo' type: example: RCS type: string type: object type: object RCSRichCard: properties: carousel_card: $ref: '#/components/schemas/RCSCarouselCard' standalone_card: $ref: '#/components/schemas/RCSStandaloneCard' type: object RCSShareLocationAction: description: Opens the RCS app's location chooser so the user can pick a location to send back to the agent. type: object RCSStandaloneCard: description: Standalone card properties: card_content: $ref: '#/components/schemas/RCSCardContent' card_orientation: description: Orientation of the card. enum: - CARD_ORIENTATION_UNSPECIFIED - HORIZONTAL - VERTICAL example: HORIZONTAL type: string thumbnail_image_alignment: description: Image preview alignment for standalone cards with horizontal layout. enum: - THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED - LEFT - RIGHT example: LEFT type: string required: - card_orientation - thumbnail_image_alignment - card_content type: object RCSSuggestion: properties: action: $ref: '#/components/schemas/RCSAction' reply: $ref: '#/components/schemas/RCSReply' type: object RCSTestNumberInviteResponse: properties: data: properties: agent_id: description: RCS agent ID example: TestAgent type: string phone_number: description: Phone number that was invited for testing example: '+13125551234' type: string record_type: description: Identifies the type of the resource enum: - rcs.test_number_invite example: rcs.test_number_invite type: string status: description: Status of the test number invitation example: PENDING type: string type: object required: - data type: object RCSTo: items: $ref: '#/components/schemas/RCSToItem' type: array RCSToItem: properties: carrier: example: Verizon Wireless type: string line_type: example: Wireless type: string phone_number: example: '+13125551234' type: string status: example: queued type: string type: object RCSViewLocationAction: description: Opens the user's default map app and selects the agent-specified location. properties: label: description: The label of the pin dropped type: string lat_long: $ref: '#/components/schemas/RCSLatLng' query: description: query string (Android only) type: string type: object ReadComment: $ref: '#/components/schemas/Comment' Record: 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 RecordType: description: Identifies record type. enum: - custom_storage_credentials type: string RecordingCompleted: example: event_type: video.room.recording.started id: 6b61621f-62e0-4aad-ab11-9fd19e272e73 occurred_at: '2018-02-02T22:25:27.521992Z' payload: codec: opus download_url: https://www.example.com duration_secs: 3660 participant_id: 5ccc7b54-4df3-4bca-a65a-35a1ecc777f0 recording_id: 1ccc7b54-4df3-4bca-a65a-35a1ecc777f0 room_id: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73 size_mb: 5.6 type: audio record_type: event properties: event_type: description: The type of event being delivered. enum: - video.room.recording.completed example: video.room.recording.completed type: string id: description: Uniquely identify the event. 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: codec: description: Codec used for the recording. example: opus type: string download_url: description: Url to download the recording. example: https://www.example.com type: string duration_secs: description: Recording duration in seconds. example: 67 type: integer participant_id: description: Participant ID associated with the recording. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string recording_id: description: Recording ID that identifies the recording. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string room_id: description: Room ID associated with the recording. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string session_id: description: Session ID associated with the recording. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string size_mb: description: Recording size in MB. example: 10.5 format: float type: number type: description: Type of the recording. enum: - audio - video example: audio type: string type: object record_type: description: An identifier for the type of the resource. enum: - event example: event type: string title: Recording Completed type: object RecordingCompletedEvent: properties: data: $ref: '#/components/schemas/RecordingCompleted' title: Recording Completed Event type: object RecordingResponse: properties: data: $ref: '#/components/schemas/RecordingResponseData' title: RecordingResponse type: object RecordingResponseData: properties: call_control_id: description: Unique identifier and token for controlling the call. example: v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw type: string call_leg_id: description: ID unique to the call leg (used to correlate webhook events). example: 84a97d76-e40f-11ed-9074-02420a0daa69 type: string call_session_id: description: ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 84a97d76-e40f-11ed-9074-02420a0daa69 type: string channels: description: When `dual`, the final audio file has the first leg on channel A, and the rest on channel B. enum: - single - dual example: dual type: string conference_id: description: Uniquely identifies the conference. example: 84a97d76-e40f-11ed-9074-02420a0daa69 type: string created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2018-02-02T22:25:27.521Z' type: string download_urls: description: 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 `completed` recordings are currently supported. enum: - completed example: completed 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: RecordingResponseData type: object RecordingSource: description: Defines how the recording was created. enum: - StartCallRecordingAPI - StartConferenceRecordingAPI - OutboundAPI - DialVerb - Conference - RecordVerb - Trunking type: string RecordingStarted: example: event_type: video.room.recording.started id: 6b61621f-62e0-4aad-ab11-9fd19e272e73 occurred_at: '2018-02-02T22:25:27.521992Z' payload: participant_id: 5ccc7b54-4df3-4bca-a65a-35a1ecc777f0 recording_id: 1ccc7b54-4df3-4bca-a65a-35a1ecc777f0 room_id: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73 type: audio record_type: event properties: event_type: description: The type of event being delivered. enum: - video.room.recording.started example: video.room.recording.started type: string id: description: Uniquely identify the event. 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: participant_id: description: Participant ID associated with the recording. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string recording_id: description: Recording ID associated with the recording. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string room_id: description: Room ID associated with the recording. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string session_id: description: Session ID associated with the recording. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string type: description: Type of the recording. enum: - audio - video example: audio type: string type: object record_type: description: An identifier for the type of the resource. enum: - event example: event type: string title: Recording Started type: object RecordingStartedEvent: properties: data: $ref: '#/components/schemas/RecordingStarted' title: Recording Started Event type: object RecordingStatusCallbackEvent: description: 'The changes to the recording''s state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.' example: in-progress completed absent type: string RecordingTrack: description: The audio track to record for the call. The default is `both`. enum: - inbound - outbound - both example: inbound type: string RecordingTranscription: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2018-02-02T22:25:27.521Z' type: string duration_millis: description: The duration of the recording transcription in milliseconds. example: 60000 format: int32 type: integer id: description: Uniquely identifies the recording transcription. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: string record_type: enum: - recording_transcription example: recording_transcription type: string recording_id: description: Uniquely identifies the recording associated with this transcription. example: 3fa85f64-5717-4562-b3fc-2c963f66afa6 type: string status: description: The status of the recording transcription. Only `completed` has transcription text available. enum: - in-progress - completed example: completed type: string transcription_text: description: The recording's transcribed text. example: Good morning, how may I help you? 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: RecordingTranscriptionsResponseData type: object RecursiveCluster: properties: cluster_header: type: string cluster_id: type: string cluster_summary: type: string nodes: items: $ref: '#/components/schemas/ClusterNode' type: array subclusters: items: $ref: '#/components/schemas/RecursiveCluster' type: array total_number_of_nodes: type: integer required: - cluster_id - cluster_summary - total_number_of_nodes title: RecursiveCluster 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 sip_headers: description: SIP headers to be added to the request. Currently only User-to-User header is supported. example: - name: User-to-User value: value items: $ref: '#/components/schemas/SipHeader' type: array required: - sip_address title: Refer request type: object RefreshRoomClientTokenRequest: properties: refresh_token: example: eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ 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 Region: description: Region where the bucket is located. example: us-east-1 type: string RegionIn: properties: region_code: description: The region the interface should be deployed to. example: ashburn-va type: string 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 type: object RegionOut: properties: region: properties: code: description: Region code of the interface. example: ashburn-va type: string name: description: Region name of the interface. example: Ashburn type: string record_type: description: Identifies the type of the resource. example: region readOnly: true type: string type: object region_code: description: The region interface is deployed to. example: ashburn-va type: string type: object RegulatoryRequirement: properties: field_type: type: string record_type: type: string requirement_id: format: uuid type: string type: object RegulatoryRequirements: properties: action: example: ordering readOnly: true type: string country_code: example: DE readOnly: true type: string phone_number_type: example: local readOnly: true type: string regulatory_requirements: items: properties: acceptance_criteria: properties: acceptable_characters: example: Characters that can be included in field value type: string acceptable_values: items: type: string type: array case_sensitive: example: Whether field value is case sensitive type: string locality_limit: example: Identical locality as the numbers desired type: string max_length: example: '10' type: string min_length: example: '5' type: string regex: example: regex field value must match type: string time_limit: example: Less than 5 months old type: string type: object description: example: Address matching the DID area code (street, building number, postal code, city and country) readOnly: true type: string example: example: 600 Congress Avenue, 14th Floor, Austin, TX 78701 readOnly: true type: string field_type: example: address_id type: string id: example: 12ade33a-21c0-473b-b055-b3c836e1c292 format: uuid readOnly: true type: string name: example: Address matching the DID area code type: string type: object type: array type: object RegulatoryRequirementsPhoneNumbers: properties: phone_number: example: '+41215471644' readOnly: true type: string phone_number_type: example: local readOnly: true type: string record_type: example: phone_number_regulatory_requirements readOnly: true type: string region_information: items: properties: region_name: example: CH type: string region_type: example: country_code type: string type: object type: array regulatory_requirements: items: properties: acceptance_criteria: properties: field_type: example: address type: string field_value: example: 45f45a04-b4be-4592-95b1-9306b9db2b21 type: string locality_limit: example: Identical locality as the numbers desired type: string type: object description: example: Address matching the DID area code (street, building number, postal code, city and country) readOnly: true type: string example: example: 600 Congress Avenue, 14th Floor, Austin, TX 78701 readOnly: true type: string field_type: example: address_id type: string id: example: 12ade33a-21c0-473b-b055-b3c836e1c292 format: uuid readOnly: true type: string label: example: Address matching the DID area code type: string record_type: example: regulatory_requirement readOnly: true type: string type: object type: array type: object 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string required: - cause title: Reject Request type: object Release: properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2018-02-02T22:25:27.521Z' type: string error_message: description: A message set if there is an error with the upload process. type: string status: default: pending_upload description: Represents the status of the release on Microsoft Teams. enum: - pending_upload - pending - in_progress - complete - failed - expired - unknown example: pending type: string telephone_numbers: items: $ref: '#/components/schemas/TnReleaseEntry' type: array tenant_id: example: ea175aba-f47c-4702-9400-efaa42688048 format: uuid type: string ticket_id: $ref: '#/components/schemas/UUID' title: Phone Number Release type: object 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 RequirementGroup: properties: action: type: string country_code: type: string created_at: format: date-time type: string customer_reference: type: string id: type: string phone_number_type: type: string record_type: example: requirement_group type: string regulatory_requirements: items: $ref: '#/components/schemas/UserRequirement' type: array status: enum: - approved - unapproved - pending-approval - declined type: string updated_at: format: date-time type: string 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: date-time 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: date-time readOnly: true type: string id: example: 12ade33a-21c0-473b-b055-b3c836e1c292 format: uuid readOnly: true type: string phone_number: example: '+19705555098' 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: date-time readOnly: true type: string type: object ResourceMetadata: properties: authorization_servers: description: List of authorization server URLs items: format: uri type: string type: array resource: description: Protected resource URL format: uri type: string type: object ResourceNotFoundError: properties: errors: items: properties: code: description: Error code identifying the error type. type: string detail: description: A human-readable explanation of the error. type: string meta: properties: url: description: A URL to the detailed documentation for the error. format: uri type: string type: object title: description: A short, human-readable summary of the problem. type: string type: object type: array type: object ResumeConferenceRecordingRequest: properties: command_id: description: Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string recording_id: description: Use this field to resume specific recording. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string title: Pause Recording Request type: object 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string recording_id: description: Uniquely identifies the resource. example: 6e00ab49-9487-4364-8ad6-23965965afb2 format: uuid type: string title: Resume Recording Request type: object Retrieval: properties: retrieval: $ref: '#/components/schemas/inference-embedding_BucketIds' type: enum: - retrieval type: string required: - type - retrieval title: Retrieval type: object RetrievalTool: properties: retrieval: $ref: '#/components/schemas/inference-embedding_BucketIds' type: enum: - retrieval type: string required: - type - retrieval title: RetrievalTool 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' enable_recording: true 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' webhook_event_failover_url: https://failover.example.com webhook_event_url: https://www.example.com webhook_timeout_secs: 25 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: date-time type: string enable_recording: default: false description: Enable or disable recording for that room. example: true type: boolean id: description: A unique identifier for 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: date-time type: string webhook_event_failover_url: default: '' description: The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. example: https://failover.example.com format: uri nullable: true type: string webhook_event_url: description: The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'. example: https://example.com format: uri 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 type: object RoomComposition: example: completed_at: '2022-02-25T05:39:56.377426Z' download_url: null duration_secs: 84 ended_at: '2022-02-24T23:22:24.577677Z' format: mp4 id: 7103dc53-ee59-4b54-a58b-c77d99ceb037 record_type: composition resolution: 1280x720 room_id: f981dbb3-228a-44e9-ac54-e87f0e2658b0 session_id: 8f728d7b-00e2-4c59-8c27-f564b828df87 size_mb: 6 started_at: '2022-02-24T23:21:00.077209Z' status: enqueued user_id: 12a04ec9-0f91-4a91-9f3a-a19d9931182e video_layout: first: height: 720 video_sources: - '*' width: 1280 x_pos: 0 y_pos: 0 z_pos: 0 webhook_event_url: https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02 properties: completed_at: description: ISO 8601 timestamp when the room composition has completed. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string created_at: description: ISO 8601 timestamp when the room composition was created. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string download_url: description: Url to download the composition. example: https://www.example.com type: string duration_secs: description: Shows the room composition duration in seconds. example: 67 type: integer ended_at: description: ISO 8601 timestamp when the room composition has ended. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string format: description: Shows format of the room composition. enum: - mp4 example: mp4 type: string id: description: A unique identifier for the room composition. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string record_type: example: room_composition readOnly: true type: string room_id: description: Identify the room associated with the room composition. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0 format: uuid type: string session_id: description: Identify the room session associated with the room composition. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0 format: uuid type: string size_mb: description: Shows the room composition size in MB. example: 10.5 format: float type: number started_at: description: ISO 8601 timestamp when the room composition has stated. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string status: description: Shows the room composition status. enum: - completed - enqueued - processing example: completed type: string updated_at: description: ISO 8601 timestamp when the room composition was updated. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string user_id: description: Identify the user associated with the room composition. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0 format: uuid type: string video_layout: additionalProperties: $ref: '#/components/schemas/VideoRegion' description: Describes the video layout of the room composition in terms of regions. Limited to 2 regions. type: object webhook_event_failover_url: default: '' description: The failover URL where webhooks related to this room composition will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'. example: https://failover.example.com format: uri nullable: true type: string webhook_event_url: description: The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'. example: https://example.com format: uri 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 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: A unique identifier for 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: date-time type: string left_at: description: ISO 8601 timestamp when the participant left the session. example: '2021-03-26T17:51:59.588408Z' format: date-time 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: date-time type: string type: object RoomRecording: example: codec: opus completed_at: '2021-04-16T10:25:55.962200Z' created_at: '2021-04-16T09:46:20.954863Z' download_url: https://www.example.com duration_secs: 3660 ended_at: '2021-04-16T10:24:55.962200Z' id: 6b61621f-62e0-4aad-ab11-9fd19e272e73 participant_id: 9b61621f-5fe4-4aad-ab11-9fd19e272e73 record_type: room_session room_id: 7b61621f-5fe4-4aad-ab11-9fd19e272e73 session_id: 8b61621f-5fe4-4aad-ab11-9fd19e272e73 size_mb: 5.6 started_at: '2021-04-16T09:24:55.962200Z' status: completed type: audio updated_at: '2021-04-16T10:24:55.962200Z' properties: codec: description: Shows the codec used for the room recording. example: opus type: string completed_at: description: ISO 8601 timestamp when the room recording has completed. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string created_at: description: ISO 8601 timestamp when the room recording was created. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string download_url: description: Url to download the recording. example: https://www.example.com type: string duration_secs: description: Shows the room recording duration in seconds. example: 67 type: integer ended_at: description: ISO 8601 timestamp when the room recording has ended. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string id: description: A unique identifier for the room recording. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string participant_id: description: Identify the room participant associated with the room recording. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0 format: uuid type: string record_type: example: room_recording readOnly: true type: string room_id: description: Identify the room associated with the room recording. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0 format: uuid type: string session_id: description: Identify the room session associated with the room recording. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777b0 format: uuid type: string size_mb: description: Shows the room recording size in MB. example: 10.5 format: float type: number started_at: description: ISO 8601 timestamp when the room recording has stated. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string status: description: Shows the room recording status. enum: - completed - processing example: completed type: string type: description: Shows the room recording type. enum: - audio - video example: audio type: string updated_at: description: ISO 8601 timestamp when the room recording was updated. example: '2021-03-26T17:51:59.588408Z' format: date-time 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: date-time type: string ended_at: description: ISO 8601 timestamp when the room session has ended. example: '2021-03-26T17:51:59.588408Z' format: date-time type: string id: description: A unique identifier for 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: date-time type: string type: object S3ConfigurationData: properties: aws_access_key_id: $ref: '#/components/schemas/AwsAccessKeyId' aws_secret_access_key: $ref: '#/components/schemas/AwsSecretAccessKey' bucket: $ref: '#/components/schemas/Bucket' region: $ref: '#/components/schemas/Region' title: AWS S3 Storage Configuration Data type: object SIMCard: properties: actions_in_progress: default: false description: Indicate whether the SIM card has any pending (in-progress) actions. example: true readOnly: true type: boolean authorized_imeis: description: List of IMEIs authorized to use a given SIM card. example: - '106516771852751' - '534051870479563' - '508821468377961' items: type: string type: array 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 current_billing_period_consumed_data: description: The SIM card consumption so far in the current billing cycle. properties: amount: example: '2049.0' type: string unit: default: MB example: MB type: string readOnly: true type: object current_device_location: description: Current physical location data of a given SIM card. Accuracy is given in meters. properties: accuracy: example: 1250 type: integer accuracy_unit: default: m example: m type: string latitude: example: '41.143' type: string longitude: example: '-8.605' type: string readOnly: true type: object current_imei: description: IMEI of the device where a given SIM card is currently being used. example: '457032284023794' readOnly: true type: string current_mcc: description: 'Mobile Country Code of the current network to which the SIM card is connected. 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: '410' readOnly: true type: string current_mnc: description: "Mobile Network Code of the current network to which the SIM\ \ card is connected. It's a two to three decimal digits that identify\ \ a network.<br/><br/>\n 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: '260' readOnly: true type: string data_limit: description: The SIM card individual data limit configuration. properties: amount: example: '2048.1' type: string unit: enum: - MB - GB example: MB type: string type: object 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 network operators 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: 081932214823362973 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 live_data_session: description: Indicates whether the device is actively connected to a network and able to run data. enum: - connected - disconnected - unknown example: connected 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 pin_puk_codes: description: PIN and PUK codes for the SIM card. Only available when include_pin_puk_codes=true is set in the request. properties: pin1: description: The primary Personal Identification Number (PIN) for the SIM card. This is a 4-digit code used to protect the SIM card from unauthorized use. example: '1234' readOnly: true type: string pin2: description: The secondary Personal Identification Number (PIN2) for the SIM card. This is a 4-digit code used for additional security features. example: '5678' readOnly: true type: string puk1: description: The primary Personal Unblocking Key (PUK1) for the SIM card. This is an 8-digit code used to unlock the SIM card if PIN1 is entered incorrectly multiple times. example: '12345678' readOnly: true type: string puk2: description: The secondary Personal Unblocking Key (PUK2) for the SIM card. This is an 8-digit code used to unlock the SIM card if PIN2 is entered incorrectly multiple times. example: '87654321' readOnly: true type: string readOnly: true type: object 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: $ref: '#/components/schemas/SIMCardStatus' tags: description: Searchable tags associated with the SIM card example: - personal - customers - active-customers items: type: string type: array type: description: The type of SIM card enum: - physical - esim example: physical 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: SIMCard type: object SIMCardAction: description: This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card. properties: action_type: description: "The operation type. It can be one of the following: <br/>\n\ <ul>\n <li><code>enable</code> - move the SIM card to the <code>enabled</code>\ \ status</li>\n <li><code>enable_standby_sim_card</code> - move a SIM\ \ card previously on the <code>standby</code> status to the <code>enabled</code>\ \ status after it consumes data.</li>\n <li><code>disable</code> - move\ \ the SIM card to the <code>disabled</code> status</li>\n <li><code>set_standby</code>\ \ - move the SIM card to the <code>standby</code> status</li>\n </ul>" enum: - enable - enable_standby_sim_card - disable - set_standby example: enable readOnly: true type: string created_at: $ref: '#/components/schemas/wireless_CreatedAt' id: $ref: '#/components/schemas/wireless_Id' record_type: example: sim_card_action readOnly: true type: string settings: additionalProperties: true description: A JSON object representation of the action params. example: {} nullable: true readOnly: true type: object sim_card_id: description: The related SIM card identifier. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid readOnly: true type: string status: properties: reason: description: It describes why the SIM card action is in the current status. This will be <code>null</code> for self-explanatory statuses, such as <code>in-progress</code> and <code>completed</code> but will include further information on statuses like <code>interrupted</code> and <code>failed</code>. example: The data limit was exceeded. readOnly: true type: string value: description: The current status of the SIM card action. enum: - in-progress - completed - failed - interrupted example: completed readOnly: true type: string type: object updated_at: $ref: '#/components/schemas/wireless_UpdatedAt' title: SIMCardAction type: object SIMCardActionsSummary: properties: count: type: integer status: enum: - in-progress - completed - failed - interrupted example: in-progress type: string type: object SIMCardActivationCode: properties: activation_code: description: Contents of the eSIM activation QR code. example: LPA:1$.... readOnly: true type: string record_type: example: sim_card_activation_code readOnly: true type: string title: SIMCardActivationCode type: object SIMCardDeviceDetails: properties: brand_name: description: Brand of the device where the SIM card is being used in. example: Apple readOnly: true type: string device_type: description: Type of the device where the SIM card is being used in. example: Tablet readOnly: true type: string imei: description: IMEI of the device where the SIM card is being used in. example: '457032284023794' readOnly: true type: string model_name: description: Brand of the device where the SIM card is being used in. example: iPad Pro 11 2020 Cellular readOnly: true type: string operating_system: description: Operating system of the device where the SIM card is being used in. example: iOS 12 readOnly: true type: string record_type: example: device_details readOnly: true type: string title: SIMCardDeviceDetails 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. properties: amount: example: '2048.1' type: string unit: example: MB type: string type: object 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 wireless_blocklist_id: default: null description: The identification of the related Wireless Blocklist resource. example: a13bc415-7966-43bf-90d4-63cc76275289 format: uuid 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 - set_wireless_blocklist - remove_wireless_blocklist 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. properties: amount: example: '2048.1' type: string unit: example: MB type: string type: object 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. properties: amount: example: '2048.1' type: string unit: example: MB type: string type: object name: description: A user friendly name for the SIM card group. example: My Test Group type: string title: SIMCardGroupPatch 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 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: TX country_code: US extended_address: 14th Floor id: '1293384261075731499' locality: Austin postal_code: '78701' street_address: 600 Congress Avenue properties: administrative_area: description: State or province where the address is located. example: TX type: string business_name: description: The name of the business where the address is located. example: Telnyx LLC 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: 14th Floor type: string first_name: description: The first name of the shipping recipient. example: John type: string id: description: Uniquely identifies the address for the order. example: '1293384261075731499' type: string last_name: description: The last name of the shipping recipient. example: Smith type: string locality: description: The name of the city where the address is located. example: Austin type: string postal_code: description: Postal code for the address. example: '78701' type: string street_address: description: The name of the street where the address is located. example: 600 Congress Avenue 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> <li><code>canceled</code> - the order was canceled.</li> </ul> enum: - pending - processing - ready_to_ship - shipped - delivered - canceled example: pending type: string tracking_url: description: The URL used to get tracking information about the order. example: http://www.example.com/ format: uri 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 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 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 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 region_code: example: dc2 readOnly: true type: string sim_card_id: example: 6b14e151-8493-4fa1-8664-1cc4e6d14158 format: uuid type: string 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 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: 0123456789 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 SIMCardStatus: properties: reason: description: It describes why the SIM card is in the current status. example: The SIM card is active, ready to connect to networks and consume data. readOnly: true type: string value: description: "The current status of the SIM card. It will be one of the\ \ following: <br/>\n<ul>\n <li><code>registering</code> - the card is\ \ being registered</li>\n <li><code>enabling</code> - the card is being\ \ enabled</li>\n <li><code>enabled</code> - the card is enabled and ready\ \ for use</li>\n <li><code>disabling</code> - the card is being disabled</li>\n\ \ <li><code>disabled</code> - the card has been disabled and cannot be\ \ used</li>\n <li><code>data_limit_exceeded</code> - the card has exceeded\ \ its data consumption limit</li>\n <li><code>setting_standby</code> -\ \ the process to set the card in stand by is in progress</li>\n <li><code>standby</code>\ \ - the card is in stand by</li>\n</ul>\nTransitioning between the enabled\ \ and disabled states may take a period of time.\n" enum: - registering - enabling - enabled - disabling - disabled - data_limit_exceeded - setting_standby - standby example: enabled readOnly: true type: string type: object SIPReferTool: properties: refer: $ref: '#/components/schemas/SIPReferToolParams' type: enum: - refer type: string required: - type - refer title: SIPReferTool type: object SIPReferToolParams: properties: custom_headers: description: Custom headers to be added to the SIP REFER. items: properties: name: type: string value: description: The value of the header. Note that we support mustache templating for the value. For example you can use `{{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of the integration secret. type: string type: object type: array sip_headers: description: SIP headers to be added to the SIP REFER. Currently only User-to-User and Diversion headers are supported. items: properties: name: enum: - User-to-User - Diversion type: string value: description: The value of the header. Note that we support mustache templating for the value. For example you can use `{{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of the integration secret. type: string type: object type: array targets: description: The different possible targets of the SIP refer. The assistant will be able to choose one of the targets to refer the call to. items: properties: name: description: The name of the target. example: Support type: string sip_address: description: The SIP URI to which the call will be referred. 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: - name - sip_address type: object type: array required: - targets title: SIPReferToolParams type: object SMSFallback: properties: from: description: Phone number in +E.164 format example: '+13125551234' type: string text: description: Text (maximum 3072 characters) example: Hello world! type: string type: object SSLCertificate: properties: created_at: description: Time when SSL certificate was uploaded example: - '2020-01-01T00:00:00Z' format: date-time type: string id: description: Unique identifier for the SSL certificate type: string issued_by: properties: common_name: description: The common name of the entity the certificate was issued by type: string organization: description: The organization the certificate was issued by type: string organization_unit: description: The organizational unit the certificate was issued by type: string type: object issued_to: properties: common_name: description: The common name of the entity the certificate was issued to type: string organization: description: The organization the certificate was issued to type: string organization_unit: description: The organizational unit the certificate was issued to type: string type: object valid_from: description: The time the certificate is valid from example: - '2020-01-01T00:00:00Z' format: date-time type: string valid_to: description: The time the certificate is valid to example: - '2020-01-01T00:00:00Z' format: date-time type: string type: object ScheduledEventResponse: anyOf: - $ref: '#/components/schemas/ScheduledPhoneCallEventResponse' - $ref: '#/components/schemas/ScheduledSmsEventResponse' description: Union type for different scheduled event response types title: ScheduledEventResponse ScheduledPhoneCallEventResponse: properties: assistant_id: title: Assistant Id type: string conversation_id: title: Conversation Id type: string conversation_metadata: additionalProperties: anyOf: - type: string - type: integer - type: boolean title: Conversation Metadata type: object created_at: format: date-time title: Created At type: string errors: items: type: string title: Errors type: array retry_attempts: title: Retry Attempts type: integer retry_count: default: 0 title: Retry Count type: integer scheduled_at_fixed_datetime: format: date-time title: Scheduled At Fixed Datetime type: string scheduled_event_id: title: Scheduled Event Id type: string status: allOf: - $ref: '#/components/schemas/EventStatus' default: pending telnyx_agent_target: title: Telnyx Agent Target type: string telnyx_conversation_channel: $ref: '#/components/schemas/ConversationChannelType' telnyx_end_user_target: title: Telnyx End User Target type: string required: - telnyx_conversation_channel - telnyx_end_user_target - telnyx_agent_target - scheduled_at_fixed_datetime - assistant_id title: ScheduledPhoneCallEventResponse type: object ScheduledSmsEventResponse: properties: assistant_id: title: Assistant Id type: string conversation_id: title: Conversation Id type: string conversation_metadata: additionalProperties: anyOf: - type: string - type: integer - type: boolean title: Conversation Metadata type: object created_at: format: date-time title: Created At type: string errors: items: type: string title: Errors type: array retry_count: default: 0 title: Retry Count type: integer scheduled_at_fixed_datetime: format: date-time title: Scheduled At Fixed Datetime type: string scheduled_event_id: title: Scheduled Event Id type: string status: allOf: - $ref: '#/components/schemas/EventStatus' default: pending telnyx_agent_target: title: Telnyx Agent Target type: string telnyx_conversation_channel: $ref: '#/components/schemas/ConversationChannelType' telnyx_end_user_target: title: Telnyx End User Target type: string text: title: Text type: string required: - telnyx_conversation_channel - telnyx_end_user_target - telnyx_agent_target - scheduled_at_fixed_datetime - assistant_id - text title: ScheduledSmsEventResponse type: object SearchedSIMCardGroup: 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. properties: amount: example: '2048.1' type: string unit: example: MB type: string type: object 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 sim_card_count: default: 0 description: The number of SIM cards associated with the group. example: 10 type: integer 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 wireless_blocklist_id: default: null description: The identification of the related Wireless Blocklist resource. example: 5aa584f6-14b1-41b2-8e01-1c04d1ee77c1 format: uuid type: string title: SIMCardGroup 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 any command with the same `command_id` for the same `call_control_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: $ref: '#/components/schemas/ConnectionId' contents: description: The file you want to upload. The maximum allowed size is 20 MB. contents and media_name/media_url can't be submitted together. format: binary type: string from: $ref: '#/components/schemas/From' monochrome: $ref: '#/components/schemas/Monochrome' quality: $ref: '#/components/schemas/Quality' store_media: $ref: '#/components/schemas/StoreMedia' store_preview: $ref: '#/components/schemas/StorePreview' t38_enabled: $ref: '#/components/schemas/T38Enabled' to: $ref: '#/components/schemas/To' required: - connection_id - contents - from - to title: Send fax multipart request type: object SendFaxRequest: 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 connection_id: description: The connection ID to send the fax with. example: '234423' type: string from: $ref: '#/components/schemas/From' 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: $ref: '#/components/schemas/MediaName' media_url: $ref: '#/components/schemas/MediaUrl' monochrome: default: false description: The flag to enable monochrome, true black and white fax results. type: boolean preview_format: default: tiff description: The format for the preview file in case the `store_preview` is `true`. enum: - pdf - tiff type: string quality: $ref: '#/components/schemas/Quality' 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 store_preview: default: false description: Should fax preview be stored on temporary URL. type: boolean t38_enabled: default: true description: The flag to disable the T.38 protocol. type: boolean to: $ref: '#/components/schemas/To' webhook_url: description: Use this field to override the URL to which Telnyx will send subsequent webhooks for this fax. example: https://www.example.com/server-b/ type: string required: - connection_id - from - to title: Send fax request type: object SendRecordingUrl: default: true description: Whether to send RecordingUrl in webhooks. example: false type: boolean SendSIPInfoRequest: example: body: '{"key": "value", "numValue": 100}' client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 content_type: application/json properties: body: description: Content of the SIP INFO example: '{"key": "value", "numValue": 100}' 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string content_type: description: Content type of the INFO body. Must be MIME type compliant. There is a 1,400 bytes limit example: application/json type: string required: - content_type - body title: Send SIP Info Request type: object ServiceDetail: properties: cost: description: Cost per unit as decimal string example: '1.50' type: string cost_type: description: Type of cost (MRC or OTC) example: MRC type: string name: description: Service name example: Local DIDs type: string required: - cost_type - name - cost type: object ServicePlan: default: global description: Indicates the coverage of the termination regions. enum: - global example: global type: string SessionEnded: example: event_type: video.room.session.ended id: 6b61621f-62e0-4aad-ab11-9fd19e272e73 occurred_at: '2018-02-02T22:25:27.521992Z' payload: duration_secs: 235 ended_reason: stale room_id: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73 record_type: event properties: event_type: description: The type of event being delivered. enum: - video.room.session.ended example: video.room.session.ended type: string id: description: Uniquely identify the event. 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: duration_secs: description: The duration in seconds of the session example: 245 type: integer ended_reason: description: The reason why the session ended example: stale type: string room_id: description: Room ID that identifies the room where the session ended. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string session_id: description: Session ID that identifies the session that ended. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string type: object record_type: description: An identifier for the type of the resource. enum: - event example: event type: string title: Session Ended type: object SessionEndedEvent: properties: data: $ref: '#/components/schemas/SessionEnded' title: Session Ended Event type: object SessionStarted: example: event_type: video.room.session.started id: 6b61621f-62e0-4aad-ab11-9fd19e272e73 occurred_at: '2018-02-02T22:25:27.521992Z' payload: room_id: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 session_id: 7b61621f-62e0-4aad-ab11-9fd19e272e73 record_type: event properties: event_type: description: The type of event being delivered. enum: - video.room.session.started example: video.room.session.started type: string id: description: Uniquely identify the event. 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: room_id: description: Room ID that identifies the room where the session started. example: 0ccc7b54-4df3-4bca-a65a-35a1ecc777f0 format: uuid type: string session_id: description: Session ID that identifies the session that started. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string type: object record_type: description: An identifier for the type of the resource. enum: - event example: event type: string title: Session Started type: object SessionStartedEvent: properties: data: $ref: '#/components/schemas/SessionStarted' title: Session Started Event type: object SettingsDataErrorMessage: properties: message: title: Message type: string required: - message title: SettingsDataErrorMessage type: object SharedCampaign: description: Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including **usecase**, **vertical**, **brandId** and **cspId**. properties: brandId: description: Alphanumeric identifier of the brand associated with this campaign. title: Brandid type: string campaignId: description: Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. title: Campaignid type: string createDate: description: Unix timestamp when campaign was created. title: Createdate type: string status: description: 'Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ' title: Status type: string usecase: description: Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. title: Usecase type: string required: - brandId - campaignId - usecase title: SharedCampaign type: object SharedCampaignRecordSet: properties: page: title: Page type: integer records: items: $ref: '#/components/schemas/SharedCampaign' title: Records type: array totalRecords: title: Totalrecords type: integer title: SharedCampaignRecordSet type: object 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 SimCardDataUsageNotification: description: The SIM card individual data usage notification information. example: created_at: '2018-02-02T22:25:27.521Z' id: 79228acc-3f08-4e70-ac68-cb5aae8b537a sim_card_id: b34c1683-cd85-4493-b9a5-315eb4bc5e19 threshold: amount: '2048.0' unit: MB 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: 79228acc-3f08-4e70-ac68-cb5aae8b537a format: uuid readOnly: true type: string record_type: example: sim_card_data_usage_notification readOnly: true type: string sim_card_id: description: The identification UUID of the related SIM card resource. example: b34c1683-cd85-4493-b9a5-315eb4bc5e19 format: uuid type: string threshold: description: Data usage threshold that will trigger the notification. properties: amount: example: '2048.1' type: string unit: enum: - MB - GB example: MB type: string type: object 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 SimCardOrderCreate: properties: address_id: description: Uniquely identifies the address for the order. example: '1293384261075731499' 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 SimCardUsageDetailRecord: properties: closed_at: description: Event close time example: '2020-07-01T00:00:00Z' format: date-time type: string created_at: description: Event 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 data_cost: description: Data cost example: '0.0292830' type: number data_rate: description: Currency amount per billing unit used to calculate the Telnyx billing cost example: '0.06000' type: string data_unit: description: Unit of wireless link consumption example: MB type: string downlink_data: description: Number of megabytes downloaded example: '0.1240' type: number id: description: Unique identifier for this SIM Card Usage example: 3ca7bd3d-7d82-4e07-9df4-009123068320 format: uuid type: string imsi: description: International Mobile Subscriber Identity example: '311210393720093' type: string ip_address: description: Ip address that generated the event example: 100.64.1.2 type: string mcc: description: Mobile country code example: '204' type: string mnc: description: Mobile network code example: '69' type: string phone_number: description: Telephone number associated to SIM card example: '+15188490209' type: string record_type: default: sim_card_usage example: sim_card_usage type: string sim_card_id: description: Unique identifier for SIM card example: 7aa66686-b39f-456d-8edc-5b6cffb1432a type: string sim_card_tags: description: User-provided tags example: mytag type: string sim_group_id: description: Unique identifier for SIM group example: 6c07e2e9-cbc0-49ba-ac0d-c59b59646bb1 type: string sim_group_name: description: Sim group name for sim card example: SIMBillingInfo test - otheraccount type: string uplink_data: description: Number of megabytes uploaded example: '0.7653' type: number required: - record_type type: object SimpleLine: properties: alias: description: Service alias example: port_out type: string amount: description: Total amount as decimal string example: '15.75' type: string name: description: Service name example: Port Out type: string quantity: description: Number of items example: 100 type: integer type: enum: - simple example: simple type: string required: - type - name - alias - quantity - amount type: object SimpleSIMCard: properties: actions_in_progress: default: false description: Indicate whether the SIM card has any pending (in-progress) actions. example: true readOnly: true type: boolean 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 current_billing_period_consumed_data: description: The SIM card consumption so far in the current billing cycle. properties: amount: example: '2049.0' type: string unit: default: MB example: MB type: string readOnly: true type: object data_limit: description: The SIM card individual data limit configuration. properties: amount: example: '2048.0' type: string unit: enum: - MB - GB example: MB type: string readOnly: true type: object 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 network operators 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: 081932214823362973 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: $ref: '#/components/schemas/SIMCardStatus' tags: description: Searchable tags associated with the SIM card example: - personal - customers - active-customers items: type: string type: array type: description: The type of SIM card enum: - physical - esim example: physical 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: 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 SingleManagedAccountGlobalOutboundChannels: example: channel_limit: 30 email: allocate_demo@customer.com id: 096abcde-1122-3344-ab77-ff0123456789 manager_account_id: beeabcde-1122-3344-ab77-ff0123456789 record_type: managed_account_global_outbound_settings properties: channel_limit: description: Integer value that indicates the number of allocatable global outbound channels that are allocated to the managed account. If the value is 0 then the account will have no usable channels and will not be able to perform outbound calling. example: 30 type: integer email: description: The email of the managed account. example: customer@example.org type: string id: description: The user ID of the managed account. example: 096abcde-1122-3344-ab77-ff0123456789 type: string manager_account_id: description: The user ID of the manager of the account. example: beeabcde-1122-3344-ab77-ff0123456789 type: string record_type: description: The name of the type of data in the response. example: managed_account_global_outbound_settings type: string title: Global Outbound Channels Details for a Managed Account type: object SipHeader: example: name: User-to-User value: value properties: name: description: The name of the header to add. enum: - User-to-User example: User-to-User type: string value: description: The value of the header. example: value type: string required: - name - value title: SIP Header type: object SiprecConnector: example: app_subdomain: my-app host: siprec.telnyx.com name: my-siprec-connector port: 5060 properties: app_subdomain: description: Subdomain to route the call when using Telnyx SRS (optional for non-Telnyx SRS). example: my-app-domain type: string host: description: Hostname/IPv4 address of the SIPREC SRS. example: siprec.telnyx.com type: string name: description: Name for the SIPREC connector resource. example: my-siprec-connector type: string port: description: Port for the SIPREC SRS. example: 5060 type: integer required: - host - port - name title: SIPREC connector configuration type: object SiprecConnectorResponse: properties: data: properties: app_subdomain: description: Subdomain to route calls when using Telnyx SRS (optional). example: my-app-domain type: string created_at: description: ISO 8601 formatted date/time of creation. example: '2024-01-23T18:10:02.574Z' type: string host: description: Hostname/IPv4 address of the SIPREC SRS. example: siprec.telnyx.com type: string name: description: Name for the SIPREC connector resource. example: siprec-connector type: string port: description: Port for the SIPREC SRS. example: 5060 type: integer record_type: example: siprec_connector type: string updated_at: description: ISO 8601 formatted date/time of last update. example: '2024-01-23T18:10:02.574Z' type: string title: SIPREC Connector type: object required: - data title: SIPREC Connector Response type: object SlimPhoneNumberDetailed: 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' country_iso_alpha2: US created_at: '2019-10-23T18:10:00.000Z' customer_reference: customer-reference emergency_address_id: '1315261609962112019' emergency_enabled: true emergency_status: active external_pin: '1234' hd_voice_enabled: true id: '1293384261075731499' inbound_call_screening: disabled phone_number: '+19705555098' phone_number_type: local purchased_at: '2019-10-23T18:10:00.000Z' record_type: phone_number status: active t38_fax_gateway_enabled: true 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 country_iso_alpha2: description: The ISO 3166-1 alpha-2 country code of the phone number. example: US 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. readOnly: true type: string emergency_enabled: description: Indicates whether emergency services are enabled for this number. readOnly: true type: boolean emergency_status: description: Indicates the status of the provisioning of emergency services for the phone number. This field contains information about activity that may be ongoing for a number where it either is being provisioned or deprovisioned but is not yet enabled/disabled. enum: - active - deprovisioning - disabled - provisioning - provisioning-failed 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, 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/numbers_IntId' inbound_call_screening: default: disabled description: The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it. enum: - disabled - reject_calls - flag_calls 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. Note: For numbers purchased prior to July 2023 or when fetching a number''s details immediately after a purchase completes, the legacy values `tollfree`, `shortcode` or `longcode` may be returned instead.' enum: - local - toll_free - mobile - national - shared_cost - landline - tollfree - shortcode - longcode 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_slim 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 - requirement-info-pending - requirement-info-under-review - requirement-info-exception - provision-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 type: object SoundModifications: description: Use this field to modify sound effects, for example adjust the pitch. example: octaves: 0.1 pitch: '0.8' semitone: -2 track: both properties: octaves: description: Adjust the pitch in octaves, values should be between -1 and 1, default 0 example: -0.5 format: double type: number pitch: description: Set the pitch directly, value should be > 0, default 1 (lower = lower tone) example: 0.8 format: double type: number semitone: description: Adjust the pitch in semitones, values should be between -14 and 14, default 0 example: -10 format: double type: number track: default: outbound description: The track to which the sound modifications will be applied. Accepted values are `inbound` or `outbound` example: inbound type: string title: Sound modifications type: object SourceResponse: properties: parameter: description: a string indicating which URI query parameter caused the error example: metrics type: string pointer: description: A JSON Pointer [RFC6901] to the associated entity in the request document example: /title type: string 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string language: description: The language you want spoken. This parameter is ignored when a `Polly.*` voice is specified. 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 3,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: 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: "Specifies the voice used in speech synthesis.\n\n- Define\ \ voices using the format `<Provider>.<Model>.<VoiceId>`. Specifying only\ \ the provider will give default values for voice_id and model_id.\n\n\ \ **Supported Providers:**\n- **AWS:** Use `AWS.Polly.<VoiceId>` (e.g.,\ \ `AWS.Polly.Joanna`). For neural voices, which provide more realistic,\ \ human-like speech, append `-Neural` to the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`).\ \ Check the [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)\ \ for compatibility.\n- **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,\ \ Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural, Azure.en-US-Ava:DragonHDLatestNeural.\ \ For a complete list of voices, go to [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)\n\ - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g., `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`).\ \ The `ModelId` part is optional. To use ElevenLabs, you must provide\ \ your ElevenLabs API key as an integration identifier secret in `\"voice_settings\"\ : {\"api_key_ref\": \"<secret_identifier>\"}`. See [integration secrets\ \ documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)\ \ for details. Check [available voices](https://elevenlabs.io/docs/api-reference/get-voices).\n\ \ - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`\n\nFor service_level\ \ basic, you may define the gender of the speaker (male or female)." example: Telnyx.KokoroTTS.af type: string voice_settings: description: The settings associated with the voice selected oneOf: - $ref: '#/components/schemas/ElevenLabsVoiceSettings' - $ref: '#/components/schemas/TelnyxVoiceSettings' - $ref: '#/components/schemas/AWSVoiceSettings' required: - payload - voice title: Speak Request type: object StartConferenceRecordingRequest: example: command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 format: wav play_beep: true properties: command_id: description: Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `conference_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string custom_file_name: description: The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix. example: my_recording_file_name maxLength: 40 minLength: 1 type: string format: description: The audio file format used when storing the conference recording. Can be either `mp3` or `wav`. enum: - wav - mp3 example: mp3 type: string play_beep: description: If enabled, a beep sound will be played at the start of a recording. example: true type: boolean trim: description: When set to `trim-silence`, silence will be removed from the beginning and end of the recording. enum: - trim-silence example: trim-silence type: string required: - format title: Start Conference Recording Request type: object StartForkingRequest: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 rx: udp:192.0.2.1:9000 tx: udp: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 any command with the same `command_id` for the same `call_control_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: udp:192.0.2.1:9000 type: string stream_type: default: decrypted description: Optionally specify a media type to stream. If `decrypted` selected, Telnyx will decrypt incoming SIP media before forking to the target. `rx` and `tx` are required fields if `decrypted` selected. enum: - decrypted example: decrypted type: string tx: description: The network target, <udp:ip_address:port>, where the call's outgoing RTP media packets should be forwarded. example: udp: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 timeout_secs: 0 transcription: true transcription_engine: B transcription_language: en-US 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string custom_file_name: description: The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix. example: my_recording_file_name maxLength: 40 minLength: 1 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. The minimum value is 0. The maximum value is 14400. The default value 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 recording_track: default: both description: The audio track to be recorded. Can be either `both`, `inbound` or `outbound`. If only single track is specified (`inbound`, `outbound`), `channels` configuration is ignored and it will be recorded as mono (single channel). enum: - both - inbound - outbound example: outbound type: string timeout_secs: default: 0 description: The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite) example: 100 format: int32 type: integer transcription: default: false description: Enable post recording transcription. The default value is false. example: true type: boolean transcription_engine: default: A description: Engine to use for speech recognition. `A` - `Google` example: A type: string transcription_language: $ref: '#/components/schemas/GoogleTranscriptionLanguageLong' transcription_max_speaker_count: default: 6 description: Defines maximum number of speakers in the conversation. Applies to `google` engine only. example: 4 format: int32 type: integer transcription_min_speaker_count: default: 2 description: Defines minimum number of speakers in the conversation. Applies to `google` engine only. example: 4 format: int32 type: integer transcription_profanity_filter: default: false description: Enables profanity_filter. Applies to `google` engine only. example: true type: boolean transcription_speaker_diarization: default: false description: Enables speaker diarization. Applies to `google` engine only. example: true type: boolean trim: description: When set to `trim-silence`, silence will be removed from the beginning and end of the recording. enum: - trim-silence example: trim-silence type: string required: - format - channels title: Start Recording Request type: object StartSiprecRequest: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 connector_name: my-siprec-connector siprec_track: both_tracks 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 connector_name: description: Name of configured SIPREC connector to be used. example: my-siprec-connector type: string include_metadata_custom_headers: description: "When set, custom parameters will be added as metadata (recording.session.ExtensionParameters).\ \ Otherwise, they\u2019ll be added to sip headers." enum: - true - false example: true type: boolean secure: description: Controls whether to encrypt media sent to your SRS using SRTP and TLS. When set you need to configure SRS port in your connector to 5061. enum: - true - false example: true type: boolean session_timeout_secs: default: 1800 description: Sets `Session-Expires` header to the INVITE. A reinvite is sent every half the value set. Usefull for session keep alive. Minimum value is 90, set to 0 to disable. example: 900 type: integer sip_transport: default: udp description: Specifies SIP transport protocol. enum: - udp - tcp - tls example: tcp type: string siprec_track: default: both_tracks description: Specifies which track should be sent on siprec session. enum: - inbound_track - outbound_track - both_tracks example: outbound_track type: string title: Start Siprec Request type: object StartStreamingRequest: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 dialogflow_config: analyze_sentiment: false partial_automated_agent_reply: false enable_dialogflow: false stream_track: both_tracks stream_url: wss://www.example.com/websocket 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string dialogflow_config: $ref: '#/components/schemas/DialogflowConfig' enable_dialogflow: default: false description: Enables Dialogflow for the current call. The default value is false. example: true type: boolean stream_bidirectional_codec: $ref: '#/components/schemas/StreamBidirectionalCodec' stream_bidirectional_mode: $ref: '#/components/schemas/StreamBidirectionalMode' stream_bidirectional_target_legs: $ref: '#/components/schemas/StreamBidirectionalTargetLegs' stream_codec: $ref: '#/components/schemas/StreamCodec' stream_track: default: inbound_track description: Specifies which track should be streamed. enum: - inbound_track - outbound_track - both_tracks example: both_tracks type: string stream_url: description: The destination WebSocket address where the stream is going to be delivered. example: wss://www.example.com/websocket type: string title: Start Streaming Request type: object StockExchange: description: (Required for public company) stock exchange. enum: - NONE - NASDAQ - NYSE - AMEX - AMX - ASX - B3 - BME - BSE - FRA - ICEX - JPX - JSE - KRX - LON - NSE - OMX - SEHK - SSE - STO - SWX - SZSE - TSX - TWSE - VSE example: NASDAQ title: StockExchange type: string 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string stream_type: default: raw description: Optionally specify a `stream_type`. This should match the `stream_type` that was used in `fork_start` command to properly stop the fork. enum: - raw - decrypted example: decrypted 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 any command with the same `command_id` for the same `call_control_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 recording_id: 6e00ab49-9487-4364-8ad6-23965965afb2 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string recording_id: description: Uniquely identifies the resource. example: 6e00ab49-9487-4364-8ad6-23965965afb2 format: uuid type: string title: Stop Recording Request type: object StopSiprecRequest: 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string title: Stop Siprec Request type: object StopStreamingRequest: example: client_state: aGF2ZSBhIG5pY2UgZGF5ID1d command_id: 891510ac-f3e4-11e8-af5b-de00688a4901 stream_id: 1edb94f9-7ef0-4150-b502-e0ebadfd9491 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string stream_id: description: Identifies the stream. If the `stream_id` is not provided the command stops all streams associated with a given `call_control_id`. example: 1edb94f9-7ef0-4150-b502-e0ebadfd9491 format: uuid type: string title: Stop Streaming Request type: object StoreMedia: 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 StorePreview: default: false description: Should fax preview be stored on temporary URL. type: boolean StreamBidirectionalCodec: default: PCMU description: Indicates codec for bidirectional streaming RTP payloads. Used only with stream_bidirectional_mode=rtp. Case sensitive. enum: - PCMU - PCMA - G722 - OPUS - AMR-WB - L16 example: G722 title: Bidirectional Stream Codec type: string StreamBidirectionalMode: default: mp3 description: Configures method of bidirectional streaming (mp3, rtp). enum: - mp3 - rtp example: rtp title: Bidirectional Stream Mode type: string StreamBidirectionalSamplingRate: default: 8000 description: Audio sampling rate. enum: - 8000 - 16000 - 48000 example: 16000 title: Bidirectional Stream Sampling Rate type: integer StreamBidirectionalTargetLegs: default: opposite description: Specifies which call legs should receive the bidirectional stream audio. enum: - both - self - opposite example: both title: Bidirectional Stream Target Legs type: string StreamCodec: default: default description: Specifies the codec to be used for the streamed audio. When set to 'default' or when transcoding is not possible, the codec from the call will be used. enum: - PCMU - PCMA - G722 - OPUS - AMR-WB - L16 - default example: PCMA title: Stream Codec type: string StreamName: description: The user specified name of Stream. example: My stream type: string StreamStatus: default: stopped description: The status of the Stream you wish to update. enum: - stopped example: stopped type: string StreamTrack: default: inbound_track description: Tracks to be included in the stream enum: - inbound_track - outbound_track - both_tracks example: both_tracks type: string 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: date-time 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 is_block_sub_number_order: description: True if the sub number order is a block sub number order example: false readOnly: true type: boolean 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 - landline 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 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: date-time readOnly: true type: string user_id: example: d70873cd-7c98-401a-81b6-b1ae08246995 format: uuid type: string type: object SubNumberOrderPhoneNumber: properties: bundle_id: format: uuid type: string country_code: type: string id: format: uuid type: string phone_number: type: string phone_number_type: type: string record_type: type: string regulatory_requirements: items: properties: field_type: type: string field_value: type: string requirement_id: format: uuid type: string status: type: string type: object type: array requirements_met: type: boolean requirements_status: type: string status: type: string type: object 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 type: object SubNumberOrderRegulatoryRequirementWithValue: properties: field_type: enum: - textual - datetime - address - document example: address readOnly: true type: string 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 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 type: object SubNumberOrderRequirementGroupResponse: example: data: country_code: AT created_at: '2018-01-01T00:00:00.000000Z' customer_reference: missing id: f826ed66-b27c-4340-9dc0-57dc3459f1bd is_block_sub_number_order: false order_request_id: a11d58fe-88a4-494a-b752-8dea411993c6 phone_number_type: toll_free phone_numbers: - bundle_id: null country_code: AT id: 613d517a-0432-4bae-a785-c11033bd0985 phone_number: '+43800300238' phone_number_type: toll_free record_type: number_order_phone_number regulatory_requirements: - field_type: textual field_value: '4804570924' requirement_id: 2708e569-696a-4fc7-9305-5fdb3eb9c7dd status: pending-approval requirements_met: false requirements_status: requirement-info-under-review status: pending phone_numbers_count: 1 record_type: sub_number_order regulatory_requirements: - field_type: textual record_type: phone_number_regulatory_requirement requirement_id: 2708e569-696a-4fc7-9305-5fdb3eb9c7dd requirements_met: false status: pending updated_at: '2018-01-01T00:00:00.000000Z' properties: data: properties: country_code: type: string created_at: format: date-time type: string customer_reference: type: string id: format: uuid type: string is_block_sub_number_order: type: boolean order_request_id: format: uuid type: string phone_number_type: type: string phone_numbers: items: $ref: '#/components/schemas/SubNumberOrderPhoneNumber' type: array phone_numbers_count: type: integer record_type: type: string regulatory_requirements: items: $ref: '#/components/schemas/RegulatoryRequirement' type: array requirements_met: type: boolean status: type: string updated_at: format: date-time type: string type: object type: object SubNumberOrdersReport: example: created_at: '2025-06-11T13:21:40.967339+00:00' filters: country_code: US created_at_gt: '2023-04-05T10:22:08.230549Z' created_at_lt: '2025-06-05T10:22:08.230549Z' customer_reference: STRING order_request_id: 991b8ff5-4daf-4826-9a22-e3991b444a9c status: success id: cada7e84-122b-4b47-bc66-58c7c3becd40 order_type: sub_number_order status: pending updated_at: '2025-06-11T13:21:45.753260+00:00' user_id: 0d7ef697-df19-413a-b724-56b0539f5397 properties: created_at: description: ISO 8601 formatted date indicating when the resource was created. example: '2025-06-11T13:21:40.967339+00:00' format: date-time readOnly: true type: string filters: description: The filters that were applied to generate this report properties: country_code: example: US type: string created_at_gt: example: '2023-04-05T10:22:08.230549Z' format: date-time type: string created_at_lt: example: '2025-06-05T10:22:08.230549Z' format: date-time type: string customer_reference: example: STRING type: string order_request_id: example: 991b8ff5-4daf-4826-9a22-e3991b444a9c format: uuid type: string status: example: success type: string type: object id: description: Identifies the resource. example: cada7e84-122b-4b47-bc66-58c7c3becd40 format: uuid readOnly: true type: string order_type: description: The type of order report. example: sub_number_order readOnly: true type: string status: default: pending description: Indicates the completion level of the sub number orders report. The report must have a status of 'success' before it can be downloaded. enum: - pending - success - failed - expired example: pending type: string updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2025-06-11T13:21:45.753260+00:00' format: date-time readOnly: true type: string user_id: description: The ID of the user who created the report. example: 0d7ef697-df19-413a-b724-56b0539f5397 format: uuid readOnly: true type: string type: object Summary: example: adjustments: - amount: '-10.00' description: Credit for service outage event_date: '2025-05-15' lines: - alias: local existing_this_month: mrc: '20.00' quantity: 8 name: Local DIDs new_this_month: mrc: '25.50' otc: '5.00' quantity: 10 type: comparative - alias: port_out amount: '15.75' name: Port Out quantity: 100 type: simple properties: adjustments: description: List of billing adjustments items: $ref: '#/components/schemas/AdjustmentLine' type: array lines: description: List of charge summary lines items: $ref: '#/components/schemas/SummaryLine' type: array required: - lines - adjustments type: object SummaryAndTotal: properties: currency: description: Currency code example: USD type: string end_date: description: End date of the summary period example: '2025-06-01' format: date type: string start_date: description: Start date of the summary period example: '2025-05-01' format: date type: string summary: $ref: '#/components/schemas/Summary' total: $ref: '#/components/schemas/TotalSummary' user_email: description: User email address example: user@example.com format: email type: string user_id: description: User identifier example: 0db0b4aa-a83d-4d4f-ad9b-3ba7c1ac2ce8 type: string required: - user_id - start_date - end_date - user_email - currency - summary - total type: object SummaryLine: discriminator: propertyName: type oneOf: - $ref: '#/components/schemas/ComparativeLine' - $ref: '#/components/schemas/SimpleLine' SummaryRequest: properties: bucket: description: The name of the bucket that contains the file to be summarized. type: string filename: description: The name of the file to be summarized. type: string system_prompt: description: A system prompt to guide the summary generation. type: string required: - bucket - filename title: SummaryRequest type: object SummaryResponse: properties: summary: title: Summary type: string required: - summary title: SummaryResponse type: object SummaryResponseData: properties: data: $ref: '#/components/schemas/SummaryResponse' required: - data title: SummaryResponseData type: object SupportedEmbeddingLoaders: description: Supported types of custom document loaders for embeddings. enum: - default - intercom title: SupportedEmbeddingLoaders type: string SupportedEmbeddingModels: description: Supported models to vectorize and embed documents. enum: - thenlper/gte-large - intfloat/multilingual-e5-large title: SupportedEmbeddingModels type: string SwitchSupervisorRoleRequest: example: role: barge properties: role: description: The supervisor role to switch to. 'barge' allows speaking to both parties, 'whisper' allows speaking to caller only, 'monitor' allows listening only. enum: - barge - whisper - monitor example: barge type: string required: - role title: Switch Supervisor Role Request type: object T38Enabled: default: true description: The flag to disable the T.38 protocol. type: boolean TFPhoneNumber: description: A phone number properties: phoneNumber: title: Phonenumber type: string required: - phoneNumber title: PhoneNumber type: object TFVerificationRequest: description: The body of a tollfree verification request properties: additionalInformation: description: Any additional information maxLength: 500 title: Additionalinformation type: string businessAddr1: description: Line 1 of the business address example: 600 Congress Avenue maxLength: 500 title: Businessaddr1 type: string businessAddr2: description: Line 2 of the business address example: 14th Floor maxLength: 500 title: Businessaddr2 type: string businessCity: description: The city of the business address; the first letter should be capitalized example: Austin maxLength: 500 title: Businesscity type: string businessContactEmail: description: The email address of the business contact example: email@example.com maxLength: 500 title: Businesscontactemail type: string businessContactFirstName: description: First name of the business contact; there are no specific requirements on formatting example: John maxLength: 500 title: Businesscontactfirstname type: string businessContactLastName: description: Last name of the business contact; there are no specific requirements on formatting example: Doe maxLength: 500 title: Businesscontactlastname type: string businessContactPhone: description: The phone number of the business contact in E.164 format example: '+18005550100' maxLength: 500 title: Businesscontactphone type: string businessName: description: Name of the business; there are no specific formatting requirements example: Telnyx LLC maxLength: 500 title: Businessname type: string businessState: description: The full name of the state (not the 2 letter code) of the business address; the first letter should be capitalized example: Texas maxLength: 500 title: Businessstate type: string businessZip: description: The ZIP code of the business address example: '78701' maxLength: 500 title: Businesszip type: string corporateWebsite: description: A URL, including the scheme, pointing to the corporate website example: http://example.com maxLength: 500 title: Corporatewebsite type: string isvReseller: description: ISV name maxLength: 500 title: Isvreseller type: string messageVolume: allOf: - $ref: '#/components/schemas/Volume' description: Estimated monthly volume of messages from the given phone numbers example: 100,000 optInWorkflow: description: Human-readable description of how end users will opt into receiving messages from the given phone numbers example: User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset maxLength: 500 title: Optinworkflow type: string optInWorkflowImageURLs: description: Images showing the opt-in workflow example: - url: https://telnyx.com/sign-up - url: https://telnyx.com/company/data-privacy items: $ref: '#/components/schemas/Url' minItems: 1 title: Optinworkflowimageurls type: array phoneNumbers: description: The phone numbers to request the verification of example: - phoneNumber: '+18773554398' - phoneNumber: '+18773554399' items: $ref: '#/components/schemas/TFPhoneNumber' minItems: 1 title: Phonenumbers type: array productionMessageContent: description: An example of a message that will be sent from the given phone numbers example: Your Telnyx OTP is XXXX maxLength: 1000 title: Productionmessagecontent type: string useCase: allOf: - $ref: '#/components/schemas/UseCaseCategories' description: Machine-readable use-case for the phone numbers example: 2FA useCaseSummary: description: Human-readable summary of the desired use-case example: This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal maxLength: 500 title: Usecasesummary type: string webhookUrl: description: URL that should receive webhooks relating to this verification request example: http://example-webhook.com maxLength: 500 title: Webhookurl type: string required: - businessName - corporateWebsite - businessAddr1 - businessCity - businessState - businessZip - businessContactFirstName - businessContactLastName - businessContactEmail - businessContactPhone - messageVolume - phoneNumbers - useCase - useCaseSummary - productionMessageContent - optInWorkflow - optInWorkflowImageURLs - additionalInformation - isvReseller title: VerificationRequest type: object TFVerificationStatus: description: Tollfree verification status enum: - Verified - Rejected - Waiting For Vendor - Waiting For Customer - Waiting For Telnyx - In Progress title: VerificationStatus type: string TaskStatus: enum: - pending - starting - running - completed - failed title: TaskStatus type: string TaskStatusResponse: properties: data: properties: created_at: title: Created At type: string finished_at: title: Finished At type: string status: $ref: '#/components/schemas/BackgroundTaskStatus' task_id: format: uuid title: Task ID type: string task_name: title: Task Name type: string type: object required: - data title: TaskStatusResponse type: object 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 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. 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. A single tag can hold at maximum 1000 credentials. example: some_tag type: string title: TelephonyCredentialUpdateRequest type: object TelephonySettings: properties: default_texml_app_id: description: Default Texml App used for voice calls with your assistant. This will be created automatically on assistant creation. type: string supports_unauthenticated_web_calls: description: When enabled, allows users to interact with your AI assistant directly from your website without requiring authentication. This is required for FE widgets that work with assistants that have telephony enabled. type: boolean title: TelephonySettings type: object TelnyxBrand: description: Telnyx-specific extensions to The Campaign Registry's `Brand` type properties: altBusinessId: description: Alternate business identifier such as DUNS, LEI, or GIIN maxLength: 50 title: Altbusinessid type: string altBusinessIdType: $ref: '#/components/schemas/AltBusinessIdType' brandId: description: Unique identifier assigned to the brand. example: 4b20017f-8da9-a992-a6c0-683072fb7729 title: Brandid type: string brandRelationship: allOf: - $ref: '#/components/schemas/BrandRelationship' description: Brand relationship to the CSP businessContactEmail: description: 'Business contact email. Required if `entityType` is `PUBLIC_PROFIT`.' example: name@example.com title: BusinessContactEmail type: string city: description: City name example: New York maxLength: 100 title: City type: string companyName: description: (Required for Non-profit/private/public) Legal company name. example: ABC Inc. maxLength: 100 title: Companyname type: string country: description: 'ISO2 2 characters country code. Example: US - United States' example: US maxLength: 2 title: Country type: string createdAt: description: Date and time that the brand was created at. example: '2021-03-08T17:57:48.801186' type: string cspId: description: Unique identifier assigned to the csp by the registry. title: Cspid type: string displayName: description: Display or marketing name of the brand. example: ABC Mobile maxLength: 100 title: Displayname type: string ein: description: (Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S. example: '111111111' maxLength: 20 title: Ein type: string email: description: Valid email address of brand support contact. maxLength: 100 title: Email type: string entityType: allOf: - $ref: '#/components/schemas/EntityType' description: Entity type behind the brand. This is the form of business establishment. failureReasons: description: Failure reasons for brand title: failureReasons type: string firstName: description: First name of business contact. example: John maxLength: 100 title: Firstname type: string identityStatus: $ref: '#/components/schemas/BrandIdentityStatus' ipAddress: description: IP address of the browser requesting to create brand identity. maxLength: 50 title: Ipaddress type: string isReseller: default: false description: Indicates whether this brand is known to be a reseller title: Isreseller type: boolean lastName: description: Last name of business contact. example: Smith maxLength: 100 title: Lastname type: string mobilePhone: description: Valid mobile phone number in e.164 international format. example: '+12024567890' maxLength: 20 title: Mobilephone type: string mock: default: false description: Mock brand for testing purposes title: Mock type: boolean optionalAttributes: $ref: '#/components/schemas/BrandOptionalAttributes' phone: description: Valid phone number in e.164 international format. example: '+12024567890' maxLength: 20 title: Phone type: string postalCode: description: Postal codes. Use 5 digit zipcode for United States example: '10001' maxLength: 10 title: Postalcode type: string referenceId: description: Unique identifier Telnyx assigned to the brand - the brandId title: Referenceid type: string state: description: State. Must be 2 letters code for United States. example: NY maxLength: 20 title: State type: string status: description: Status of the brand enum: - OK - REGISTRATION_PENDING - REGISTRATION_FAILED title: status type: string stockExchange: allOf: - $ref: '#/components/schemas/StockExchange' description: (Required for public company) stock exchange. example: NASDAQ stockSymbol: description: (Required for public company) stock symbol. example: ABC maxLength: 10 title: Stocksymbol type: string street: description: Street number and name. example: '123' maxLength: 100 title: Street type: string tcrBrandId: description: Unique identifier assigned to the brand by the registry. example: BBRAND1 title: TcrBrandid type: string universalEin: description: Universal EIN of Brand, Read Only. title: Universalein type: string updatedAt: description: Date and time that the brand was last updated at. example: '2021-03-08T17:57:48.801186' type: string vertical: description: Vertical or industry segment of the brand. maxLength: 50 title: Vertical type: string webhookFailoverURL: description: Failover webhook to which brand status updates are sent. title: WebhookFailoverURL type: string webhookURL: description: Webhook to which brand status updates are sent. example: https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93 title: WebhookURL type: string website: description: Brand website URL. example: http://www.abcmobile.com maxLength: 100 title: Website type: string required: - entityType - displayName - country - email - brandRelationship - vertical title: TelnyxBrand type: object TelnyxBrandWithCampaignsCount: allOf: - $ref: '#/components/schemas/TelnyxBrand' - properties: assignedCampaignsCount: description: Number of campaigns associated with the brand example: 3 title: AssignedCampaignsCount type: number title: TelnyxBrandWithCampaignsCount type: object TelnyxCampaignWithAssignedCount_CSP: properties: ageGated: description: Age gated content in campaign. title: Agegated type: boolean assignedPhoneNumbersCount: description: Number of phone numbers associated with the campaign example: 3 title: AssignedPhoneNumbersCount type: number autoRenewal: description: Campaign subscription auto-renewal status. title: Autorenewal type: boolean billedDate: description: Campaign recent billed date. title: Billeddate type: string brandDisplayName: description: Display or marketing name of the brand. example: ABC Mobile title: Branddisplayname type: string brandId: description: Unique identifier assigned to the brand. example: d2ca9d69-641b-4131-83fa-5d0744f4c8a9 title: Brandid type: string campaignId: description: Unique identifier for a campaign. example: 823d6b1a-6ed6-41a3-9c50-c8ff41b682ba title: Campaignid type: string campaignStatus: description: Campaign status enum: - TCR_PENDING - TCR_SUSPENDED - TCR_EXPIRED - TCR_ACCEPTED - TCR_FAILED - TELNYX_ACCEPTED - TELNYX_FAILED - MNO_PENDING - MNO_ACCEPTED - MNO_REJECTED - MNO_PROVISIONED - MNO_PROVISIONING_FAILED example: TCR_ACCEPTED title: campaignStatus type: string createDate: description: Unix timestamp when campaign was created. title: Createdate type: string cspId: description: Alphanumeric identifier of the CSP associated with this campaign. title: Cspid type: string description: description: Summary description of this campaign. title: Description type: string directLending: title: Directlending type: boolean embeddedLink: description: Does message generated by the campaign include URL link in SMS? title: Embeddedlink type: boolean embeddedLinkSample: description: Sample of an embedded link that will be sent to subscribers. title: EmbeddedLinkSample type: string embeddedPhone: description: Does message generated by the campaign include phone number in SMS? title: Embeddedphone type: boolean failureReasons: description: Failure reasons if campaign submission failed title: failureReasons type: string helpKeywords: description: Subscriber help keywords. Multiple keywords are comma separated without space. title: Helpkeywords type: string helpMessage: description: Help message of the campaign. title: Helpmessage type: string isTMobileNumberPoolingEnabled: description: Indicates whether the campaign has a T-Mobile number pool ID associated with it. title: isTMobileNumberPoolingEnabled type: boolean isTMobileRegistered: description: Indicates whether the campaign is registered with T-Mobile. title: IsTMobileRegistered type: boolean isTMobileSuspended: description: Indicates whether the campaign is suspended with T-Mobile. title: isTMobileSuspended type: boolean messageFlow: description: Message flow description. title: Messageflow type: string mock: description: Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP. title: Mock type: boolean nextRenewalOrExpirationDate: description: When the campaign would be due for its next renew/bill date. title: Nextrenewalorexpirationdate type: string numberPool: description: Does campaign utilize pool of phone numbers? title: Numberpool type: boolean optinKeywords: description: Subscriber opt-in keywords. Multiple keywords are comma separated without space. title: Optinkeywords type: string optinMessage: description: Subscriber opt-in message. title: Optinmessage type: string optoutKeywords: description: Subscriber opt-out keywords. Multiple keywords are comma separated without space. title: Optoutkeywords type: string optoutMessage: description: Subscriber opt-out message. title: Optoutmessage type: string privacyPolicyLink: description: Link to the campaign's privacy policy. title: PrivacyPolicyLink type: string referenceId: description: Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. title: Referenceid type: string resellerId: description: Alphanumeric identifier of the reseller that you want to associate with this campaign. title: Resellerid type: string sample1: description: Message sample. Some campaign tiers require 1 or more message samples. title: Sample1 type: string sample2: description: Message sample. Some campaign tiers require 2 or more message samples. title: Sample2 type: string sample3: description: Message sample. Some campaign tiers require 3 or more message samples. title: Sample3 type: string sample4: description: Message sample. Some campaign tiers require 4 or more message samples. title: Sample4 type: string sample5: description: Message sample. Some campaign tiers require 5 or more message samples. title: Sample5 type: string status: description: 'Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ' title: Status type: string subUsecases: description: Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases items: type: string title: Subusecases type: array uniqueItems: true submissionStatus: description: Campaign submission status enum: - CREATED - FAILED - PENDING title: submissionStatus type: string subscriberHelp: description: Does campaign responds to help keyword(s)? title: Subscriberhelp type: boolean subscriberOptin: description: Does campaign require subscriber to opt-in before SMS is sent to subscriber? title: Subscriberoptin type: boolean subscriberOptout: description: Does campaign support subscriber opt-out keyword(s)? title: Subscriberoptout type: boolean tcrBrandId: description: Unique identifier assigned to the brand by the registry. example: BBRAND1 title: TcrBrandid type: string tcrCampaignId: description: Unique identifier assigned to the campaign by the registry. example: CCAMP1 title: TcrCampaignid type: string termsAndConditions: description: Is terms & conditions accepted? title: Termsandconditions type: boolean termsAndConditionsLink: description: Link to the campaign's terms and conditions. title: TermsAndConditionsLink type: string usecase: description: Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. title: Usecase type: string vertical: deprecated: true description: 'Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use `/registry/enum/vertical` operation to retrieve verticals available for given brand, vertical combination. This field is deprecated.' title: Vertical type: string webhookFailoverURL: description: Failover webhook to which campaign status updates are sent. example: https://example.com/failover-webhook title: WebhookFailoverURL type: string webhookURL: description: Webhook to which campaign status updates are sent. example: https://example.com/webhook title: WebhookURL type: string title: TelnyxCampaignWithAssignedCount_CSP type: object TelnyxCampaign_CSP: description: Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including **usecase**, **vertical**, **brandId** and **cspId**. properties: ageGated: description: Age gated content in campaign. title: Agegated type: boolean autoRenewal: description: Campaign subscription auto-renewal status. title: Autorenewal type: boolean billedDate: description: Campaign recent billed date. title: Billeddate type: string brandDisplayName: description: Display or marketing name of the brand. example: ABC Mobile title: Branddisplayname type: string brandId: description: Unique identifier assigned to the brand. example: d2ca9d69-641b-4131-83fa-5d0744f4c8a9 title: Brandid type: string campaignId: description: Unique identifier for a campaign. example: 823d6b1a-6ed6-41a3-9c50-c8ff41b682ba title: Campaignid type: string campaignStatus: description: Campaign status enum: - TCR_PENDING - TCR_SUSPENDED - TCR_EXPIRED - TCR_ACCEPTED - TCR_FAILED - TELNYX_ACCEPTED - TELNYX_FAILED - MNO_PENDING - MNO_ACCEPTED - MNO_REJECTED - MNO_PROVISIONED - MNO_PROVISIONING_FAILED example: TCR_ACCEPTED title: campaignStatus type: string createDate: description: Unix timestamp when campaign was created. title: Createdate type: string cspId: description: Alphanumeric identifier of the CSP associated with this campaign. title: Cspid type: string description: description: Summary description of this campaign. title: Description type: string directLending: title: Directlending type: boolean embeddedLink: description: Does message generated by the campaign include URL link in SMS? title: Embeddedlink type: boolean embeddedLinkSample: description: Sample of an embedded link that will be sent to subscribers. title: EmbeddedLinkSample type: string embeddedPhone: description: Does message generated by the campaign include phone number in SMS? title: Embeddedphone type: boolean failureReasons: description: Failure reasons if campaign submission failed title: failureReasons type: string helpKeywords: description: Subscriber help keywords. Multiple keywords are comma separated without space. title: Helpkeywords type: string helpMessage: description: Help message of the campaign. title: Helpmessage type: string isTMobileNumberPoolingEnabled: description: Indicates whether the campaign has a T-Mobile number pool ID associated with it. title: isTMobileNumberPoolingEnabled type: boolean isTMobileRegistered: description: Indicates whether the campaign is registered with T-Mobile. title: IsTMobileRegistered type: boolean isTMobileSuspended: description: Indicates whether the campaign is suspended with T-Mobile. title: isTMobileSuspended type: boolean messageFlow: description: Message flow description. title: Messageflow type: string mock: description: Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP. title: Mock type: boolean nextRenewalOrExpirationDate: description: When the campaign would be due for its next renew/bill date. title: Nextrenewalorexpirationdate type: string numberPool: description: Does campaign utilize pool of phone numbers? title: Numberpool type: boolean optinKeywords: description: Subscriber opt-in keywords. Multiple keywords are comma separated without space. title: Optinkeywords type: string optinMessage: description: Subscriber opt-in message. title: Optinmessage type: string optoutKeywords: description: Subscriber opt-out keywords. Multiple keywords are comma separated without space. title: Optoutkeywords type: string optoutMessage: description: Subscriber opt-out message. title: Optoutmessage type: string privacyPolicyLink: description: Link to the campaign's privacy policy. title: PrivacyPolicyLink type: string referenceId: description: Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. title: Referenceid type: string resellerId: description: Alphanumeric identifier of the reseller that you want to associate with this campaign. title: Resellerid type: string sample1: description: Message sample. Some campaign tiers require 1 or more message samples. title: Sample1 type: string sample2: description: Message sample. Some campaign tiers require 2 or more message samples. title: Sample2 type: string sample3: description: Message sample. Some campaign tiers require 3 or more message samples. title: Sample3 type: string sample4: description: Message sample. Some campaign tiers require 4 or more message samples. title: Sample4 type: string sample5: description: Message sample. Some campaign tiers require 5 or more message samples. title: Sample5 type: string status: description: 'Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ' title: Status type: string subUsecases: description: Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases items: type: string title: Subusecases type: array uniqueItems: true submissionStatus: description: Campaign submission status enum: - CREATED - FAILED - PENDING title: submissionStatus type: string subscriberHelp: description: Does campaign responds to help keyword(s)? title: Subscriberhelp type: boolean subscriberOptin: description: Does campaign require subscriber to opt-in before SMS is sent to subscriber? title: Subscriberoptin type: boolean subscriberOptout: description: Does campaign support subscriber opt-out keyword(s)? title: Subscriberoptout type: boolean tcrBrandId: description: Unique identifier assigned to the brand by the registry. example: BBRAND1 title: TcrBrandid type: string tcrCampaignId: description: Unique identifier assigned to the campaign by the registry. example: CCAMP1 title: TcrCampaignid type: string termsAndConditions: description: Is terms & conditions accepted? title: Termsandconditions type: boolean termsAndConditionsLink: description: Link to the campaign's terms and conditions. title: TermsAndConditionsLink type: string usecase: description: Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. title: Usecase type: string vertical: deprecated: true description: 'Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use `/registry/enum/vertical` operation to retrieve verticals available for given brand, vertical combination. This field is deprecated.' title: Vertical type: string webhookFailoverURL: description: Failover webhook to which campaign status updates are sent. example: https://example.com/failover-webhook title: WebhookFailoverURL type: string webhookURL: description: Webhook to which campaign status updates are sent. example: https://example.com/webhook title: WebhookURL type: string required: - brandId - campaignId - cspId - description - mock - subUsecases - termsAndConditions - usecase title: TelnyxCampaign_CSP type: object TelnyxConversationChannel: enum: - phone_call - web_call - sms_chat - web_chat title: TelnyxConversationChannel type: string TelnyxDownstreamCampaign: description: Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. properties: ageGated: description: Age gated content in campaign. title: AgeGated type: boolean assignedPhoneNumbersCount: description: Number of phone numbers associated with the campaign example: 3 title: AssignedPhoneNumbersCount type: number brandDisplayName: description: Display or marketing name of the brand. example: ABC Mobile title: Branddisplayname type: string campaignStatus: description: Campaign status enum: - TCR_PENDING - TCR_SUSPENDED - TCR_EXPIRED - TCR_ACCEPTED - TCR_FAILED - TELNYX_ACCEPTED - TELNYX_FAILED - MNO_PENDING - MNO_ACCEPTED - MNO_REJECTED - MNO_PROVISIONED - MNO_PROVISIONING_FAILED example: TCR_ACCEPTED title: campaignStatus type: string createdAt: description: Date and time that the brand was created at. example: '2021-03-08T17:57:48.801186' type: string description: description: Summary description of this campaign. title: Description type: string directLending: description: Direct lending or loan arrangement. title: Directlending type: boolean embeddedLink: description: Does message generated by the campaign include URL link in SMS? title: Embeddedlink type: boolean embeddedLinkSample: description: Sample of an embedded link that will be sent to subscribers. title: EmbeddedLinkSample type: string embeddedPhone: description: Does message generated by the campaign include phone number in SMS? title: Embeddedphone type: boolean failureReasons: description: Failure reasons if campaign submission failed title: failureReasons type: string helpKeywords: description: Subscriber help keywords. Multiple keywords are comma separated without space. title: Helpkeywords type: string helpMessage: description: Help message of the campaign. title: Helpmessage type: string isNumberPoolingEnabled: description: Indicates whether the campaign has a T-Mobile number pool ID associated with it. title: isNumberPoolingEnabled type: boolean messageFlow: description: Message flow description. title: Messageflow type: string numberPool: description: Does campaign utilize pool of phone numbers? title: Numberpool type: boolean optinKeywords: description: Subscriber opt-in keywords. Multiple keywords are comma separated without space. title: Optinkeywords type: string optinMessage: description: Subscriber opt-in message. title: Optinmessage type: string optoutKeywords: description: Subscriber opt-out keywords. Multiple keywords are comma separated without space. title: Optoutkeywords type: string optoutMessage: description: Subscriber opt-out message. title: Optoutmessage type: string privacyPolicyLink: description: Link to the campaign's privacy policy. title: PrivacyPolicyLink type: string sample1: description: Message sample. Some campaign tiers require 1 or more message samples. title: Sample1 type: string sample2: description: Message sample. Some campaign tiers require 2 or more message samples. title: Sample2 type: string sample3: description: Message sample. Some campaign tiers require 3 or more message samples. title: Sample3 type: string sample4: description: Message sample. Some campaign tiers require 4 or more message samples. title: Sample4 type: string sample5: description: Message sample. Some campaign tiers require 5 or more message samples. title: Sample5 type: string subUsecases: description: Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases items: type: string title: Subusecases type: array uniqueItems: true subscriberOptin: description: Does campaign require subscriber to opt-in before SMS is sent to subscriber? title: Subscriberoptin type: boolean subscriberOptout: description: Does campaign support subscriber opt-out keyword(s)? title: Subscriberoptout type: boolean tcrBrandId: description: Unique identifier assigned to the brand by the registry. example: BBRAND1 title: TcrBrandid type: string tcrCampaignId: description: Unique identifier assigned to the campaign by the registry. example: CCAMP1 title: TcrCampaignid type: string termsAndConditions: description: Is terms & conditions accepted? title: Termsandconditions type: boolean termsAndConditionsLink: description: Link to the campaign's terms and conditions. title: TermsAndConditionsLink type: string updatedAt: description: Date and time that the brand was last updated at. example: '2021-03-08T17:57:48.801186' type: string usecase: description: Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. title: Usecase type: string webhookFailoverURL: description: Failover webhook to which campaign status updates are sent. example: https://example.com/failover-webhook title: WebhookFailoverURL type: string webhookURL: description: Webhook to which campaign status updates are sent. example: https://example.com/webhook title: WebhookURL type: string required: - tcrBrandId - tcrCampaignId title: TelnyxDownstreamCampaign type: object TelnyxDownstreamCampaignRecordSet: properties: page: title: Page type: integer records: items: $ref: '#/components/schemas/TelnyxDownstreamCampaign' title: Records type: array totalRecords: title: Totalrecords type: integer title: TelnyxDownstreamCampaignRecordSet type: object TelnyxTranscriptionLanguage: default: en description: Language to use for speech recognition enum: - en - zh - de - es - ru - ko - fr - ja - pt - tr - pl - ca - nl - ar - sv - it - id - hi - fi - vi - he - uk - el - ms - cs - ro - da - hu - ta - 'no' - th - ur - hr - bg - lt - la - mi - ml - cy - sk - te - fa - lv - bn - sr - az - sl - kn - et - mk - br - eu - is - hy - ne - mn - bs - kk - sq - sw - gl - mr - pa - si - km - sn - yo - so - af - oc - ka - be - tg - sd - gu - am - yi - lo - uz - fo - ht - ps - tk - nn - mt - sa - lb - my - bo - tl - mg - as - tt - haw - ln - ha - ba - jw - su - auto_detect example: en title: Telnyx transcription engine list of languages type: string TelnyxVoiceSettings: properties: voice_speed: default: 1.0 description: The voice speed to be used for the voice. The voice speed must be between 0.1 and 2.0. Default value is 1.0. example: 1.0 format: float maximum: 2.0 minimum: 0.1 type: number title: Telnyx Voice Settings type: object TemplateType: enum: - custom - default title: TemplateType type: string TestRunDetailResult: properties: name: title: Name type: string status: $ref: '#/components/schemas/TestStatus' required: - name - status title: TestRunDetailResult type: object TestRunResponse: description: 'Response model containing test run execution details and results. Provides comprehensive information about a test execution including status, timing, logs, and detailed evaluation results.' properties: completed_at: description: Timestamp when the test run finished execution. format: date-time title: Completed At type: string conversation_id: description: Identifier of the conversation created during test execution. title: Conversation Id type: string conversation_insights_id: description: Identifier for conversation analysis and insights data. title: Conversation Insights Id type: string created_at: description: Timestamp when the test run was created and queued. example: - '2024-01-15T10:30:00Z' format: date-time title: Created At type: string detail_status: description: Detailed evaluation results for each rubric criteria. Name is name of the criteria from the rubric and status is the result of the evaluation. This list will have a result for every criteria in the rubric section. items: $ref: '#/components/schemas/TestRunDetailResult' title: Detail Status type: array logs: description: Detailed execution logs and debug information. title: Logs type: string run_id: description: Unique identifier for this specific test run execution. example: 987fcdeb-51a2-43d1-b456-426614174000 format: uuid title: Run Id type: string status: $ref: '#/components/schemas/TestStatus' test_id: description: Identifier of the assistant test that was executed. example: 123e4567-e89b-12d3-a456-426614174000 format: uuid title: Test Id type: string test_suite_run_id: description: Identifier linking this run to a test suite execution batch. format: uuid title: Test Suite Run Id type: string triggered_by: description: How this test run was initiated (manual, scheduled, or API). example: - manual - cron title: Triggered By type: string updated_at: description: Timestamp of the last update to this test run. format: date-time title: Updated At type: string required: - run_id - test_id - status - triggered_by - created_at title: TestRunResponse type: object TestStatus: description: "Represents the lifecycle of a test:\n - 'pending': Test is waiting\ \ to be executed.\n - 'starting': Test execution is initializing.\n - 'running':\ \ Test is currently executing.\n - 'passed': Test completed successfully.\n\ \ - 'failed': Test executed but did not pass.\n - 'error': An error occurred\ \ during test execution." enum: - pending - starting - running - passed - failed - error title: TestStatus type: string TestSuitesResponse: description: 'Response containing all available test suite names. Returns a list of distinct test suite names that can be used for filtering and organizing tests.' properties: data: description: Array of unique test suite names available to the user. example: - - customer-support - sales-flow - onboarding items: type: string title: Data type: array required: - data title: TestSuitesResponse type: object TestWebhookToolRequest: description: Request model for testing a webhook tool properties: arguments: additionalProperties: true description: Key-value arguments to use for the webhook test title: Arguments type: object dynamic_variables: additionalProperties: true description: Key-value dynamic variables to use for the webhook test title: Dynamic Variables type: object title: TestWebhookToolRequest type: object TestWebhookToolResponse: description: Response model for webhook tool test results properties: content_type: title: Content Type type: string request: additionalProperties: true title: Request type: object response: title: Response type: string status_code: title: Status Code type: integer success: title: Success type: boolean required: - success - status_code - content_type - response - request title: TestWebhookToolResponse type: object TestWebhookToolResponseData: description: Response model for webhook tool test results properties: data: $ref: '#/components/schemas/TestWebhookToolResponse' required: - data title: TestWebhookToolResponseData type: object 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 shaken_stir_enabled: true 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 tags: - tag1 - tag2 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 shaken_stir_enabled: default: false description: When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls. example: false type: boolean 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: uri 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 tags: description: Tags associated with the Texml Application. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri type: string title: Texml Application type: object TexmlBidirectionalStreamCodec: default: PCMU description: Indicates codec for bidirectional streaming RTP payloads. Used only with stream_bidirectional_mode=rtp. Case sensitive. enum: - PCMU - PCMA - G722 example: G722 title: Stream Bidirectional Codec type: string TexmlBidirectionalStreamMode: default: mp3 description: Configures method of bidirectional streaming (mp3, rtp). enum: - mp3 - rtp example: rtp title: Stream Bidirectional Mode type: string TexmlCreateCallRecordingRequestBody: properties: PlayBeep: $ref: '#/components/schemas/PlayBeep' RecordingChannels: $ref: '#/components/schemas/TexmlRecordingChannels' RecordingStatusCallback: $ref: '#/components/schemas/TexmlStatusCallback' RecordingStatusCallbackEvent: $ref: '#/components/schemas/RecordingStatusCallbackEvent' RecordingStatusCallbackMethod: $ref: '#/components/schemas/TexmlStatusCallbackMethod' RecordingTrack: $ref: '#/components/schemas/RecordingTrack' SendRecordingUrl: $ref: '#/components/schemas/SendRecordingUrl' title: Texml Create Call Recording Request Body type: object TexmlCreateCallRecordingResponseBody: properties: account_sid: $ref: '#/components/schemas/AccountSid' call_sid: $ref: '#/components/schemas/CallControlId' channels: $ref: '#/components/schemas/TwimlRecordingChannels' conference_sid: $ref: '#/components/schemas/ConferenceSid' date_created: $ref: '#/components/schemas/DateTimeRFC2822' date_updated: $ref: '#/components/schemas/DateTimeRFC2822' duration: $ref: '#/components/schemas/TexmlRecordingDuration' error_code: $ref: '#/components/schemas/TexmlErrorCode' price: $ref: '#/components/schemas/TexmlRecordingPrice' price_unit: $ref: '#/components/schemas/TexmlPriceUnit' sid: $ref: '#/components/schemas/TexmlSid' source: $ref: '#/components/schemas/RecordingSource' start_time: $ref: '#/components/schemas/DateTimeRFC2822' track: $ref: '#/components/schemas/RecordingTrack' uri: description: The relative URI for this recording resource. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json type: string title: Texml Create Call Recording Response Body type: object TexmlCreateCallStreamingRequestBody: properties: BidirectionalCodec: $ref: '#/components/schemas/TexmlBidirectionalStreamCodec' BidirectionalMode: $ref: '#/components/schemas/TexmlBidirectionalStreamMode' Name: $ref: '#/components/schemas/StreamName' StatusCallback: $ref: '#/components/schemas/TexmlStatusCallback' StatusCallbackMethod: $ref: '#/components/schemas/TexmlStatusCallbackMethod' Track: $ref: '#/components/schemas/StreamTrack' Url: $ref: '#/components/schemas/TexmlStreamUrl' title: Texml Create Call Streaming Request Body type: object TexmlCreateCallStreamingResponseBody: properties: account_sid: $ref: '#/components/schemas/AccountSid' call_sid: $ref: '#/components/schemas/CallControlId' date_updated: $ref: '#/components/schemas/DateTimeRFC2822' name: description: The user specified name of Stream. example: My stream type: string sid: $ref: '#/components/schemas/TexmlSid' status: description: The status of the streaming. enum: - in-progress example: in-progress type: string uri: description: The relative URI for this streaming resource. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA/Streams/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json type: string title: Texml Create Call Streaming Response Body type: object TexmlCreateSiprecSessionRequestBody: properties: ConnectorName: description: The name of the connector to use for the SIPREC session. example: my_connector type: string IncludeMetadataCustomHeaders: description: "When set, custom parameters will be added as metadata (recording.session.ExtensionParameters).\ \ Otherwise, they\u2019ll be added to sip headers." enum: - true - false example: true type: boolean Name: description: Name of the SIPREC session. May be used to stop the SIPREC session from TeXML instruction. example: my_siprec_session type: string Secure: description: Controls whether to encrypt media sent to your SRS using SRTP and TLS. When set you need to configure SRS port in your connector to 5061. enum: - true - false example: true type: boolean SessionTimeoutSecs: default: 1800 description: Sets `Session-Expires` header to the INVITE. A reinvite is sent every half the value set. Usefull for session keep alive. Minimum value is 90, set to 0 to disable. example: 900 type: integer SipTransport: default: udp description: Specifies SIP transport protocol. enum: - udp - tcp - tls example: tcp type: string StatusCallback: description: URL destination for Telnyx to send status callback events to for the siprec session. example: https://www.example.com/callback type: string StatusCallbackMethod: description: HTTP request type used for `StatusCallback`. enum: - GET - POST example: GET type: string Track: description: The track to be used for siprec session. Can be `both_tracks`, `inbound_track` or `outbound_track`. Defaults to `both_tracks`. enum: - both_tracks - inbound_track - outbound_track example: both_tracks type: string title: Create Siprec Session Request type: object TexmlCreateSiprecSessionResponseBody: properties: account_sid: description: The id of the account the resource belongs to. example: 61bf923e-5e4d-4595-a110-56190ea18a1b type: string call_sid: description: The id of the call the resource belongs to. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string date_created: description: The date and time the siprec session was created. example: Fri, 11 Aug 2023 19:12:11 +0000 type: string date_updated: description: The date and time the siprec session was last updated. example: Fri, 11 Aug 2023 19:12:11 +0000 type: string error_code: description: The error code of the siprec session. example: null type: string sid: description: The SID of the siprec session. example: 61bf923e-5e4d-4595-a110-56190ea18123 type: string start_time: description: The date and time the siprec session was started. example: Fri, 11 Aug 2023 19:12:11 +0000 type: string status: description: The status of the siprec session. enum: - in-progress - stopped example: in-progress type: string track: description: The track used for the siprec session. enum: - both_tracks - inbound_track - outbound_track example: both_tracks type: string uri: description: The URI of the siprec session. example: https://api.telnyx.com/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18123/Calls/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-ai/Siprec/61bf923e-5e4d-4595-a110-56190ea18123 type: string title: Create Siprec Session Response type: object TexmlErrorCode: example: null nullable: true type: string TexmlGetCallRecordingResponseBody: properties: account_sid: $ref: '#/components/schemas/AccountSid' call_sid: $ref: '#/components/schemas/CallControlId' channels: $ref: '#/components/schemas/TwimlRecordingChannels' conference_sid: $ref: '#/components/schemas/ConferenceSid' date_created: $ref: '#/components/schemas/DateTimeRFC2822' date_updated: $ref: '#/components/schemas/DateTimeRFC2822' duration: $ref: '#/components/schemas/TexmlRecordingDuration' error_code: $ref: '#/components/schemas/TexmlErrorCode' media_url: $ref: '#/components/schemas/TexmlRecordingMediaUrl' sid: $ref: '#/components/schemas/TexmlSid' source: $ref: '#/components/schemas/RecordingSource' start_time: $ref: '#/components/schemas/DateTimeRFC2822' status: $ref: '#/components/schemas/TexmlRecordingStatus' subresources_uris: $ref: '#/components/schemas/TexmlRecordingSubresourcesUris' uri: description: The relative URI for this recording resource. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json type: string title: Texml Get Call Recording Response Body type: object TexmlGetCallRecordingsResponseBody: properties: end: description: The number of the last element on the page, zero-indexed. example: 19 type: integer first_page_uri: description: Relative uri to the first page of the query results example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1 format: uri type: string next_page_uri: description: Relative uri to the next page of the query results example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1 type: string page: description: Current page number, zero-indexed. example: 0 type: integer page_size: description: The number of items on the page example: 20 type: integer previous_page_uri: description: Relative uri to the previous page of the query results example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1 format: uri type: string recordings: items: $ref: '#/components/schemas/TexmlGetCallRecordingResponseBody' type: array start: description: The number of the first element on the page, zero-indexed. example: 0 type: integer uri: description: The URI of the current page. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1 type: string title: Multiple recording resources type: object TexmlPriceUnit: description: The unit in which the price is given. example: USD nullable: true type: string TexmlRecordingChannels: default: dual description: When `dual`, final audio file has the first leg on channel A, and the rest on channel B. `single` mixes both tracks into a single channel. enum: - single - dual example: single type: string TexmlRecordingDuration: description: The duration of this recording, given in seconds. example: '12' nullable: true type: string TexmlRecordingMediaUrl: example: http://recordings.com/mp3/filename.mp3 format: uri type: string TexmlRecordingPrice: description: 'The price of this recording, the currency is specified in the price_unit field. ' example: '0.10' nullable: true type: string TexmlRecordingStatus: enum: - in-progress - completed - paused - stopped example: paused type: string TexmlRecordingSubresourcesUris: description: Subresources details for a recording if available. properties: transcriptions: example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac/Transcriptions.json format: uri nullable: true type: string title: Texml recording subresources uris type: object TexmlRecordingTranscription: properties: account_sid: $ref: '#/components/schemas/AccountSid' api_version: description: The version of the API that was used to make the request. example: '2010-04-01' type: string call_sid: $ref: '#/components/schemas/CallControlId' date_created: $ref: '#/components/schemas/DateTimeRFC2822' date_updated: $ref: '#/components/schemas/DateTimeRFC2822' duration: $ref: '#/components/schemas/TexmlRecordingDuration' recording_sid: $ref: '#/components/schemas/TexmlSid' sid: $ref: '#/components/schemas/TexmlSid' status: description: The status of the recording transcriptions. The transcription text will be available only when the status is completed. enum: - in-progress - completed example: completed type: string transcription_text: description: The recording's transcribed text example: Good morning, how may I help you? type: string uri: description: The relative URI for the recording transcription resource. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Transcriptions/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json type: string title: Texml Get Call Recording Transcription Response Body type: object TexmlSid: description: Identifier of a resource. example: e9cea0be-7dbd-4b98-98b1-c0089d9d43b0 type: string TexmlStatusCallback: description: Url where status callbacks will be sent. example: http://webhook.com/callback format: uri type: string TexmlStatusCallbackMethod: default: POST description: HTTP method used to send status callbacks. enum: - GET - POST example: GET type: string TexmlStreamUrl: description: The destination WebSocket address where the stream is going to be delivered. example: wss://www.example.com/websocket title: Stream destination URL type: string TexmlUpdateCallRecordingRequestBody: properties: Status: enum: - in-progress - paused - stopped example: paused type: string title: Texml Create Call Recording Request Body type: object TexmlUpdateCallStreamingRequestBody: properties: Status: $ref: '#/components/schemas/StreamStatus' title: Texml Update Call Streaming Request Body type: object TexmlUpdateCallStreamingResponseBody: properties: account_sid: $ref: '#/components/schemas/AccountSid' call_sid: $ref: '#/components/schemas/CallControlId' date_updated: $ref: '#/components/schemas/DateTimeRFC2822' sid: $ref: '#/components/schemas/TexmlSid' status: description: The status of the streaming. enum: - stopped example: stopped type: string uri: description: The relative URI for this streaming resource. example: /v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA/Streams/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json type: string title: Texml Update Call Streaming Response Body type: object TexmlUpdateSiprecSessionRequestBody: properties: Status: description: The new status of the resource. Specifying `stopped` will end the siprec session. enum: - stopped example: stopped type: string title: Update Siprec Session Request type: object TexmlUpdateSiprecSessionResponseBody: properties: account_sid: description: The id of the account the resource belongs to. example: 61bf923e-5e4d-4595-a110-56190ea18a1b type: string call_sid: description: The id of the call the resource belongs to. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string date_updated: description: The date and time the siprec session was last updated. example: Fri, 11 Aug 2023 19:12:11 +0000 type: string error_code: description: The error code of the siprec session. example: null type: string sid: description: The SID of the siprec session. example: 61bf923e-5e4d-4595-a110-56190ea18123 type: string status: description: The status of the siprec session. enum: - in-progress - stopped example: in-progress type: string uri: description: The URI of the siprec session. example: https://api.telnyx.com/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18123/Calls/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-ai/Siprec/61bf923e-5e4d-4595-a110-56190ea18123 type: string title: Update Siprec Session Response type: object TextClusteringResponse: properties: task_id: type: string required: - task_id title: TextClusteringResponse type: object TextClusteringResponseData: properties: data: $ref: '#/components/schemas/TextClusteringResponse' required: - data title: TextClusteringResponseData type: object TnReleaseEntry: properties: number_id: description: Phone number ID from the Telnyx API. type: string phone_number: description: Phone number in E164 format. type: string title: TnReleaseEntry type: object TnUploadEntry: properties: civic_address_id: description: Identifies the civic address assigned to the phone number entry. format: uuid type: string error_code: description: A code returned by Microsoft Teams if there is an error with the phone number entry upload. enum: - internal_error - unable_to_retrieve_default_location - unknown_country_code - unable_to_retrieve_location - unable_to_retrieve_partner_info - unable_to_match_geography_entry example: internal_error type: string error_message: description: A message returned by Microsoft Teams if there is an error with the upload process. type: string internal_status: default: pending_assignment description: Represents the status of the phone number entry upload on Telnyx. enum: - pending_assignment - in_progress - all_internal_jobs_completed - release_requested - release_completed - error example: error type: string location_id: description: Identifies the location assigned to the phone number entry. format: uuid type: string number_id: $ref: '#/components/schemas/UUID' phone_number: description: Phone number in E164 format. type: string status: default: pending_upload description: Represents the status of the phone number entry upload on Microsoft Teams. enum: - pending_upload - pending - in_progress - success - error example: error type: string title: TnUploadEntry type: object To: description: The phone number, in E.164 format, the fax will be sent to or SIP URI example: '+13127367276' type: string ToNumber: description: Receiving address (+E.164 formatted phone number or short code). example: +E.164 format: address type: string TokenRequest: properties: client_id: description: OAuth client ID (if not using HTTP Basic auth) type: string client_secret: description: OAuth client secret (if not using HTTP Basic auth) type: string code: description: Authorization code (for authorization_code flow) type: string code_verifier: description: PKCE code verifier (for authorization_code flow) type: string grant_type: description: OAuth 2.0 grant type enum: - client_credentials - authorization_code - refresh_token type: string redirect_uri: description: Redirect URI (for authorization_code flow) format: uri type: string refresh_token: description: Refresh token (for refresh_token flow) type: string scope: description: Space-separated list of requested scopes (for client_credentials) example: admin type: string required: - grant_type type: object TokenResponse: properties: access_token: description: The access token type: string expires_in: description: Token lifetime in seconds type: integer refresh_token: description: Refresh token (if applicable) type: string scope: description: Space-separated list of granted scopes type: string token_type: description: Token type enum: - Bearer type: string required: - access_token - token_type - expires_in type: object TotalSummary: properties: credits: description: Total credits as decimal string example: '-5.00' type: string existing_mrc: description: Total existing monthly recurring charges as decimal string example: '100.00' type: string grand_total: description: Grand total of all charges as decimal string example: '180.00' type: string ledger_adjustments: description: Ledger adjustments as decimal string example: '0.00' type: string new_mrc: description: Total new monthly recurring charges as decimal string example: '50.00' type: string new_otc: description: Total new one-time charges as decimal string example: '25.00' type: string other: description: Other charges as decimal string example: '10.00' type: string required: - new_mrc - new_otc - existing_mrc - other - credits - ledger_adjustments - grand_total type: object TrafficType: default: conversational description: Specifies the type of traffic allowed in this profile. enum: - conversational 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 is_final: true 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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: Call Control App ID (formerly 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 is_final: description: When false, it means that this is an interim result. example: true type: boolean transcript: description: Recognized text. example: hello this is a test speech type: string transcription_track: description: Indicates which leg of the call has been transcribed. This is only available when `transcription_engine` is set to `B`. enum: - inbound - outbound example: inbound 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 TranscriptionConfig: description: The settings associated with speech to text for the voice assistant. This is only relevant if the assistant uses a text-to-text language model. Any assistant using a model with native audio support (e.g. `fixie-ai/ultravox-v0_4`) will ignore this field. properties: model: default: distil-whisper/distil-large-v2 description: 'The speech to text model to be used by the voice assistant. - `distil-whisper/distil-large-v2` is lower latency but English-only. - `openai/whisper-large-v3-turbo` is multi-lingual with automatic language detection but slightly higher latency. - `google` is a multi-lingual option, please describe the language in the `language` field.' example: distil-whisper/distil-large-v2 type: string type: object TranscriptionEngineAConfig: properties: enable_speaker_diarization: default: false description: Enables speaker diarization. example: true type: boolean hints: default: [] description: Hints to improve transcription accuracy. example: - Telnyx items: type: string type: array interim_results: default: false description: Whether to send also interim results. If set to false, only final results will be sent. example: true type: boolean language: $ref: '#/components/schemas/GoogleTranscriptionLanguage' max_speaker_count: default: 6 description: Defines maximum number of speakers in the conversation. example: 4 format: int32 type: integer min_speaker_count: default: 2 description: Defines minimum number of speakers in the conversation. example: 4 format: int32 type: integer model: description: The model to use for transcription. enum: - latest_long - latest_short - command_and_search - phone_call - video - default - medical_conversation - medical_dictation type: string profanity_filter: default: false description: Enables profanity_filter. example: true type: boolean speech_context: description: Speech context to improve transcription accuracy. items: properties: boost: default: 1.0 description: Boost factor for the speech context. example: 1.0 maximum: 20.0 minimum: 0.0 type: number phrases: default: [] example: - Telnyx items: type: string type: array type: object type: array transcription_engine: description: Engine identifier for Google transcription service enum: - A type: string use_enhanced: default: false description: Enables enhanced transcription, this works for models `phone_call` and `video`. example: true type: boolean title: Transcription engine A config type: object TranscriptionEngineBConfig: properties: language: $ref: '#/components/schemas/TelnyxTranscriptionLanguage' transcription_engine: description: Engine identifier for Telnyx transcription service enum: - B type: string transcription_model: default: openai/whisper-tiny description: The model to use for transcription. enum: - openai/whisper-tiny - openai/whisper-large-v3-turbo type: string title: Transcription engine B config type: object TranscriptionEvent: properties: data: $ref: '#/components/schemas/Transcription' title: Transcription Event type: object TranscriptionSettings: properties: language: description: The language of the audio to be transcribed. This is only applicable for `openai/whisper-large-v3-turbo` model. If not set, of if set to `auto`, the model will automatically detect the language. For the full list of supported languages, see the [whisper tokenizer](https://github.com/openai/whisper/blob/main/whisper/tokenizer.py). type: string model: description: 'The speech to text model to be used by the voice assistant. - `distil-whisper/distil-large-v2` is lower latency but English-only. - `openai/whisper-large-v3-turbo` is multi-lingual with automatic language detection but slightly higher latency.' type: string 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 any command with the same `command_id` for the same `call_control_id`. example: 891510ac-f3e4-11e8-af5b-de00688a4901 type: string transcription_engine: default: A description: Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`. enum: - A - B example: A type: string transcription_engine_config: discriminator: mapping: A: '#/components/schemas/TranscriptionEngineAConfig' B: '#/components/schemas/TranscriptionEngineBConfig' propertyName: transcription_engine oneOf: - $ref: '#/components/schemas/TranscriptionEngineAConfig' - $ref: '#/components/schemas/TranscriptionEngineBConfig' transcription_tracks: default: inbound description: Indicates which leg of the call will be transcribed. Use `inbound` for the leg that requested the transcription, `outbound` for the other leg, and `both` for both legs of the call. Will default to `inbound`. example: both 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 any command with the same `command_id` for the same `call_control_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 early_media: true from: '+18005550101' from_display_name: Company Name media_encryption: SRTP sip_auth_password: password sip_auth_username: username sip_headers: - name: User-to-User value: value sip_transport_protocol: TLS stream_track: both_tracks stream_url: wss://www.example.com/websocket 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: - premium - 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 any command with the same `command_id` for the same `call_control_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 early_media: default: true description: If set to false, early media will not be passed to the originating leg. example: false type: boolean 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 `to` 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_encryption: default: disabled description: Defines whether media should be encrypted on the new call leg. enum: - disabled - SRTP - DTLS 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 mute_dtmf: default: none description: When enabled, DTMF tones are not passed to the call participant. The webhooks containing the DTMF information will be sent. enum: - none - both - self - opposite example: opposite 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 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 sip_headers: description: SIP headers to be added to the SIP INVITE. Currently only User-to-User header is supported. example: - name: User-to-User value: value items: $ref: '#/components/schemas/SipHeader' type: array sip_transport_protocol: default: UDP description: Defines SIP transport protocol to be used on the call. enum: - UDP - TCP - TLS type: string sound_modifications: $ref: '#/components/schemas/SoundModifications' 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 maximum: 14400 minimum: 30 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 600 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: - to title: Transfer Call Request type: object TransferTool: properties: transfer: $ref: '#/components/schemas/inference-embedding_TransferToolParams' type: enum: - transfer type: string required: - type - transfer title: TransferTool type: object TransferToolParams: properties: from: description: Number or SIP URI placing the call. example: '+35319605860' type: string targets: description: The different possible targets of the transfer. The assistant will be able to choose one of the targets to transfer the call to. items: properties: name: description: The name of the target. example: Support type: string to: description: The destination number or SIP URI of the call. example: '+13129457420' type: string type: object type: array required: - targets - from title: TransferToolParams type: object TriggerTestRunRequest: description: 'Request model for triggering a single test run. Optional request body for the trigger test run endpoint.' properties: destination_version_id: description: Optional assistant version ID to use for this test run. If provided, the version must exist or a 400 error will be returned. If not provided, test will run on main version example: 123e4567-e89b-12d3-a456-426614174000 title: Destination Version Id type: string title: TriggerTestRunRequest type: object TriggerTestSuiteRunsRequest: description: 'Request model for triggering test suite runs. Optional request body for the trigger test suite runs endpoint.' properties: destination_version_id: description: Optional assistant version ID to use for all test runs in this suite. If provided, the version must exist or a 400 error will be returned. If not provided, test will run on main version example: 123e4567-e89b-12d3-a456-426614174000 title: Destination Version Id type: string title: TriggerTestSuiteRunsRequest type: object TwimlRecordingChannels: default: 2 enum: - 1 - 2 example: 1 type: integer UUID: description: Uniquely identifies the resource. example: 542c3bca-d247-42bc-8fe7-e01d16ecd761 format: uuid title: UUID type: string UnauthorizedError: allOf: - $ref: '#/components/schemas/GenericError' - properties: code: example: '10009' type: string detail: example: The required authentication headers were either invalid or not included in the request. type: string meta: properties: url: example: https://developers.telnyx.com/docs/overview/errors/10009 type: string type: object title: example: Authentication failed type: string type: object UnexpectedError: allOf: - $ref: '#/components/schemas/GenericError' - properties: code: example: '10007' type: string detail: example: An unexpected error occurred. type: string meta: properties: url: example: https://developers.telnyx.com/docs/overview/errors/10007 type: string type: object title: example: Unexpected error type: string type: object UnprocessableEntityError: properties: code: format: int64 type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. format: json-pointer type: string type: object title: type: string required: - code - title type: object UnusedUserBundlesResponse: properties: data: items: $ref: '#/components/schemas/UnusedUserBundlesSchema' title: Data type: array required: - data title: UnusedUserBundlesResponse type: object UnusedUserBundlesSchema: properties: billing_bundle: $ref: '#/components/schemas/BillingBundleSummary' user_bundle_ids: description: List of user bundle IDs for given bundle. example: - 1e650b96-4c6a-4d6f-b8ed-87c3fcacf595 - 53beb701-1231-4548-8abf-c802f38b14aa items: format: uuid type: string title: User Bundle Ids type: array required: - billing_bundle - user_bundle_ids title: UnusedUserBundlesSchema type: object UpdateAssistantRequest: properties: description: type: string dynamic_variables: additionalProperties: true description: Map of dynamic variables and their default values type: object dynamic_variables_webhook_url: description: If the dynamic_variables_webhook_url is set for the assistant, we will send a request at the start of the conversation. See our [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) for more information. type: string enabled_features: items: $ref: '#/components/schemas/EnabledFeatures' type: array uniqueItems: true greeting: description: Text that the assistant will use to start the conversation. This may be templated with [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) type: string insight_settings: $ref: '#/components/schemas/InsightSettings' instructions: description: System instructions for the assistant. These may be templated with [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) type: string llm_api_key_ref: description: 'This is only needed when using third-party inference providers. The `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your LLM provider''s API key. Warning: Free plans are unlikely to work with this integration.' type: string messaging_settings: $ref: '#/components/schemas/MessagingSettings' model: description: ID of the model to use. You can use the [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get) to see all of your available models, type: string name: type: string privacy_settings: $ref: '#/components/schemas/PrivacySettings' telephony_settings: $ref: '#/components/schemas/TelephonySettings' tools: $ref: '#/components/schemas/AssistantTools' transcription: $ref: '#/components/schemas/TranscriptionSettings' voice_settings: $ref: '#/components/schemas/VoiceSettings' title: UpdateAssistantRequest type: object UpdateAssistantRequestWithPromotion: allOf: - $ref: '#/components/schemas/UpdateAssistantRequest' - properties: promote_to_main: default: true description: Indicates whether the assistant should be promoted to the main version. Defaults to true. type: boolean type: object UpdateAssistantTestRequest: description: 'Request model for updating an existing assistant test. All fields are optional, allowing partial updates of test configuration. Only provided fields will be updated, others remain unchanged.' properties: description: description: Updated description of the test's purpose and evaluation criteria. maxLength: 1000 title: Description type: string destination: description: Updated target destination for test conversations. minLength: 1 title: Destination type: string instructions: description: Updated test scenario instructions and objectives. maxLength: 5000 minLength: 1 title: Instructions type: string max_duration_seconds: description: Updated maximum test duration in seconds. maximum: 3600.0 minimum: 1.0 title: Max Duration Seconds type: integer name: description: Updated name for the assistant test. Must be unique and descriptive. maxLength: 255 minLength: 1 title: Name type: string rubric: description: Updated evaluation criteria for assessing assistant performance. items: additionalProperties: false properties: criteria: description: "Specific guidance on how to assess the assistant\u2019\ s performance for this rubric item." type: string name: description: Label for the evaluation criterion, e.g., Empathy, Accuracy, Clarity. type: string required: - name - criteria type: object minItems: 1 title: Rubric type: array telnyx_conversation_channel: $ref: '#/components/schemas/TelnyxConversationChannel' description: Updated communication channel for the test execution. test_suite: description: Updated test suite assignment for better organization. maxLength: 100 title: Test Suite type: string title: UpdateAssistantTestRequest type: object 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 type: object UpdateBrand: properties: altBusinessIdType: $ref: '#/components/schemas/AltBusinessIdType' altBusiness_id: description: Alternate business identifier such as DUNS, LEI, or GIIN maxLength: 50 title: Altbusiness Id type: string businessContactEmail: description: 'Business contact email. Required if `entityType` will be changed to `PUBLIC_PROFIT`.' example: name@example.com title: BusinessContactEmail type: string city: description: City name example: New York maxLength: 100 title: City type: string companyName: description: (Required for Non-profit/private/public) Legal company name. example: ABC Inc. maxLength: 100 title: Companyname type: string country: description: 'ISO2 2 characters country code. Example: US - United States' example: US maxLength: 2 title: Country type: string displayName: description: Display or marketing name of the brand. example: ABC Mobile maxLength: 100 title: Displayname type: string ein: description: (Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S. example: '111111111' maxLength: 20 title: Ein type: string email: description: Valid email address of brand support contact. maxLength: 100 title: Email type: string entityType: allOf: - $ref: '#/components/schemas/EntityType' description: Entity type behind the brand. This is the form of business establishment. firstName: description: First name of business contact. example: John maxLength: 100 title: Firstname type: string identityStatus: $ref: '#/components/schemas/BrandIdentityStatus' ipAddress: description: IP address of the browser requesting to create brand identity. maxLength: 50 title: Ipaddress type: string isReseller: title: Isreseller type: boolean lastName: description: Last name of business contact. example: Smith maxLength: 100 title: Lastname type: string phone: description: Valid phone number in e.164 international format. example: '+12024567890' maxLength: 20 title: Phone type: string postalCode: description: Postal codes. Use 5 digit zipcode for United States example: '10001' maxLength: 10 title: Postalcode type: string state: description: State. Must be 2 letters code for United States. example: NY maxLength: 20 title: State type: string stockExchange: allOf: - $ref: '#/components/schemas/StockExchange' description: (Required for public company) stock exchange. example: NASDAQ stockSymbol: description: (Required for public company) stock symbol. example: ABC maxLength: 10 title: Stocksymbol type: string street: description: Street number and name. example: '123' maxLength: 100 title: Street type: string vertical: allOf: - $ref: '#/components/schemas/Vertical' description: Vertical or industry segment of the brand. webhookFailoverURL: description: Webhook failover URL for brand status updates. example: https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6 title: WebhookFailoverURL type: string webhookURL: description: Webhook URL for brand status updates. example: https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93 title: WebhookURL type: string website: description: Brand website URL. example: http://www.abcmobile.com maxLength: 100 title: Website type: string required: - entityType - displayName - country - email - vertical title: UpdateBrand type: object 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 shaken_stir_enabled: true sip_subdomain: example sip_subdomain_receive_settings: only_my_connections outbound: channel_limit: 10 outbound_voice_profile_id: '1293384261075731499' redact_dtmf_debug_logging: true 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' redact_dtmf_debug_logging: default: false description: When enabled, DTMF digits entered by users will be redacted in debug logs to protect PII data entered through IVR interactions. example: true type: boolean tags: description: Tags assigned to the Call Control Application. example: - tag1 - tag2 items: type: string type: array 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 UpdateCallRequest: example: Status: completed properties: FallbackMethod: description: HTTP request type used for `FallbackUrl`. enum: - GET - POST example: GET type: string FallbackUrl: description: A failover URL for which Telnyx will retrieve the TeXML call instructions if the Url is not responding. example: https://www.example.com/intruction-c.xml type: string Method: description: HTTP request type used for `Url`. enum: - GET - POST example: GET type: string Status: description: The value to set the call status to. Setting the status to completed ends the call. example: completed type: string StatusCallback: description: URL destination for Telnyx to send status callback events to for the call. example: https://www.example.com/callback type: string StatusCallbackMethod: description: HTTP request type used for `StatusCallback`. enum: - GET - POST example: GET type: string Texml: description: TeXML to replace the current one with. example: <?xml version="1.0" encoding="UTF-8"?><Response><Say>Hello</Say></Response> type: string Url: description: The URL where TeXML will make a request to retrieve a new set of TeXML instructions to continue the call flow. example: https://www.example.com/intruction-b.xml type: string title: Update Call Request type: object UpdateCampaignRequest: properties: autoRenewal: default: true description: Help message of the campaign. title: Autorenewal type: boolean helpMessage: description: Help message of the campaign. maxLength: 255 title: Helpmessage type: string messageFlow: description: Message flow description. maxLength: 2048 title: Messageflow type: string resellerId: description: Alphanumeric identifier of the reseller that you want to associate with this campaign. maxLength: 8 title: Resellerid type: string sample1: description: Message sample. Some campaign tiers require 1 or more message samples. maxLength: 255 title: Sample1 type: string sample2: description: Message sample. Some campaign tiers require 2 or more message samples. maxLength: 255 title: Sample2 type: string sample3: description: Message sample. Some campaign tiers require 3 or more message samples. maxLength: 255 title: Sample3 type: string sample4: description: Message sample. Some campaign tiers require 4 or more message samples. maxLength: 255 title: Sample4 type: string sample5: description: Message sample. Some campaign tiers require 5 or more message samples. maxLength: 255 title: Sample5 type: string webhookFailoverURL: description: Webhook failover to which campaign status updates are sent. title: WebhookURL type: string webhookURL: description: Webhook to which campaign status updates are sent. title: WebhookURL type: string title: UpdateCampaignRequest type: object UpdateCommandResult: example: sid: c46e06d7-b78f-4b13-96b6-c576af9640ff status: accepted properties: sid: example: c46e06d7-b78f-4b13-96b6-c576af9640ff type: string status: example: accepted type: string title: TeXml REST Update Command Result type: object UpdateConferenceParticipantRequest: example: BeepOnExit: false properties: AnnounceMethod: description: The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`. enum: - GET - POST example: GET type: string AnnounceUrl: description: The URL to call to announce something to the participant. The URL may return an MP3 fileo a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. example: https://www.example.com/announce.xml type: string BeepOnExit: description: Whether to play a notification beep to the conference when the participant exits. example: false type: boolean CallSidToCoach: description: The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching. example: v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ type: string Coaching: description: Whether the participant is coaching another call. When `true`, `CallSidToCoach` has to be given. example: false type: boolean EndConferenceOnExit: description: Whether to end the conference when the participant leaves. example: false type: boolean Hold: description: Whether the participant should be on hold. example: true type: boolean HoldMethod: description: The HTTP method to use when calling the `HoldUrl`. enum: - GET - POST example: POST type: string HoldUrl: description: The URL to be called using the `HoldMethod` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. example: true type: string Muted: description: Whether the participant should be muted. example: true type: boolean WaitUrl: description: The URL to call for an audio file to play while the participant is waiting for the conference to start. example: https://www.example.com/wait_music.mp3 type: string title: Update Conference Participant Request type: object UpdateConferenceRequest: example: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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 UpdateConversationRequest: properties: metadata: additionalProperties: type: string description: Metadata associated with the conversation. type: object title: UpdateConversationRequest type: object UpdateCredentialConnectionRequest: example: active: true anchorsite_override: Latency android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_enabled: true sip_compact_headers_enabled: true timeout_1xx_secs: 10 timeout_2xx_secs: 20 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 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: customer password: my123secure456password789 rtcp_settings: capture_enabled: true port: rtcp-mux report_frequency_seconds: 10 sip_uri_calling_preference: ' disabled' tags: - tag1 - tag2 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' android_push_credential_id: $ref: '#/components/schemas/ConnectionAndroidPushCredentialId' connection_name: $ref: '#/components/schemas/ConnectionName' 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' ios_push_credential_id: $ref: '#/components/schemas/ConnectionIosPushCredentialId' 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: 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 tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri 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 UpdateExternalConnectionPhoneNumberRequest: properties: location_id: description: Identifies the location to assign the phone number to. format: uuid type: string title: Update External Connection Phone Number Request type: object UpdateExternalConnectionRequest: example: active: false outbound: outbound_voice_profile_id: '1911630617284445511' properties: active: $ref: '#/components/schemas/ConnectionActive' 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 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/external-voice-integrations_OutboundVoiceProfileId' required: - outbound_voice_profile_id type: object tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri 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: - outbound title: Update External 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' tags: - tag1 - tag2 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' fax_email_recipient: $ref: '#/components/schemas/FaxEmailRecipient' 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 tags: description: Tags associated with the Fax Application. example: - tag1 - tag2 items: type: string type: array 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 android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_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 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 onnet_t38_passthrough_enabled: true rtcp_settings: capture_enabled: true port: rtcp-mux report_frequency_secs: 10 tags: - tag1 - tag2 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' android_push_credential_id: $ref: '#/components/schemas/ConnectionAndroidPushCredentialId' connection_name: $ref: '#/components/schemas/ConnectionName' 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' ios_push_credential_id: $ref: '#/components/schemas/ConnectionIosPushCredentialId' 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 outbound: $ref: '#/components/schemas/OutboundFqdn' rtcp_settings: $ref: '#/components/schemas/ConnectionRtcpSettings' tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array transport_protocol: $ref: '#/components/schemas/FqdnConnectionTransportProtocol' webhook_api_version: $ref: '#/components/schemas/WebhookApiVersion' webhook_event_failover_url: $ref: '#/components/schemas/WebhookEventFailoverUrl' webhook_event_url: $ref: '#/components/schemas/WebhookEventUrl' webhook_timeout_secs: $ref: '#/components/schemas/WebhookTimeoutSecs' title: Update FQDN Connection Request type: object 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 android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e 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 shaken_stir_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 ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 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: customer tech_prefix: string rtcp_settings: capture_enabled: true port: rtcp-mux report_frequency_secs: 10 tags: - tag1 - tag2 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' android_push_credential_id: $ref: '#/components/schemas/ConnectionAndroidPushCredentialId' 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' ios_push_credential_id: $ref: '#/components/schemas/ConnectionIosPushCredentialId' 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' tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri 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 type: object 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 UpdateManagedAccountGlobalChannelLimitRequest: example: channel_limit: 30 properties: channel_limit: description: Integer value that indicates the number of allocatable global outbound channels that should be allocated to the managed account. Must be 0 or more. If the value is 0 then the account will have no usable channels and will not be able to perform outbound calling. example: 30 type: integer title: Update Managed Account Global Outbound Channels Request type: object UpdateManagedAccountRequest: example: managed_account_allow_custom_pricing: true properties: managed_account_allow_custom_pricing: description: Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed, but there may be time lag between when the value is changed and pricing changes take effect. example: false type: boolean title: Update Managed Account 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. The maximum allowed vale is 630720000, which translates to 20 years. 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. The maximum allowed vale is 630720000, which translates to 20 years. example: 86400 type: integer title: Upload media request type: object UpdateMessageTemplateRequest: description: The request body when updating a message template. properties: text: description: The text content of the message template. example: 'Your {{app_name}} verification code is: {{code}}.' type: string required: - text title: UpdateMessageTemplateRequest 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: alpha_sender: description: The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID. nullable: true pattern: ^[A-Za-z0-9 ]{1,11}$ type: string created_at: description: ISO 8601 formatted date indicating when the resource was created. format: date-time readOnly: true type: string daily_spend_limit: description: The maximum amount of money (in USD) that can be spent by this profile before midnight UTC. pattern: ^[0-9]+(?:\.[0-9]+)?$ type: string daily_spend_limit_enabled: description: Whether to enforce the value configured by `daily_spend_limit`. type: boolean 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 mms_fall_back_to_sms: default: false description: enables SMS fallback for MMS messages. type: boolean mms_transcoding: default: false description: enables automated resizing of MMS media. type: boolean 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. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. This field is required if the messaging profile doesn''t have it defined yet.' items: description: ISO 3166-1 alpha-2 country code. pattern: ^[A-Z]{2}$ type: string 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: date-time 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 type: object UpdateNumberOrderPhoneNumberRequest: properties: regulatory_requirements: items: $ref: '#/components/schemas/UpdateRegulatoryRequirement' type: array type: object UpdateNumberOrderRequest: properties: customer_reference: description: A customer reference string for customer look ups. example: MY REF 001 type: string regulatory_requirements: items: $ref: '#/components/schemas/UpdateRegulatoryRequirement' type: array type: object 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 UpdatePartnerCampaignRequest: properties: webhookFailoverURL: description: Webhook failover to which campaign status updates are sent. example: https://webhook.com/9010a453-4df8-4be6-a551-1070892888d6 title: WebhookURL type: string webhookURL: description: Webhook to which campaign status updates are sent. example: https://webhook.com/67ea78a8-9f32-4d04-b62d-f9502e8e5f93 title: WebhookURL type: string title: UpdateCampaignRequest type: object UpdatePhoneNumberMessagingSettingsRequest: example: messaging_product: P2P messaging_profile_id: dd50eba1-a0c0-4563-9925-b25e842a7cb6 properties: messaging_product: description: 'Configure the messaging product for this number: * Omit this field or set its value to `null` to keep the current value. * Set this field to a quoted product ID to set this phone number to that product' example: P2P type: string messaging_profile_id: description: 'Configure the messaging profile this phone number is assigned to: * Omit this field or set its value to `null` to keep the current value. * Set this field to `""` to unassign the number from its messaging profile * Set this field to a quoted UUID of a messaging profile to assign this number to that 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' hd_voice_enabled: true id: dc8e4d67-33a0-4cbb-af74-7b58f05bd494 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 hd_voice_enabled: description: Indicates whether HD voice is enabled for this number. example: true type: boolean id: description: Identifies the type of resource. readOnly: true 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 caller_id_name_enabled: true cnam_listing: cnam_listing_details: example cnam_listing_enabled: true inbound_call_screening: disabled media_features: accept_any_rtp_packets_enabled: true 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' caller_id_name_enabled: default: false description: Controls whether the caller ID name is enabled for this phone number. type: boolean cnam_listing: $ref: '#/components/schemas/CnamListing' inbound_call_screening: default: disabled description: The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it. enum: - disabled - reject_calls - flag_calls type: string 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 documents: $ref: '#/components/schemas/PortingOrderDocuments' end_user: $ref: '#/components/schemas/PortingOrderEndUser' messaging: properties: enable_messaging: description: Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider. example: true type: boolean type: object misc: $ref: '#/components/schemas/PortingOrderMisc' phone_number_configuration: $ref: '#/components/schemas/PortingOrderPhoneNumberConfiguration' requirement_group_id: description: If present, we will read the current values from the specified Requirement Group into the Documents and Requirements for this Porting Order. Note that any future changes in the Requirement Group would have no impact on this Porting Order. We will return an error if a specified Requirement Group conflicts with documents or requirements in the same request. example: DE748D99-06FA-4D90-9F9A-F4B62696BADA format: uuid type: string 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: description: Specifies a value for a requirement on the Porting Order. properties: field_value: description: identifies the document or provides the text value that satisfies this requirement example: 9787fb5f-cbe5-4de4-b765-3303774ee9fe type: string requirement_type_id: description: Identifies the requirement type that the `field_value` fulfills 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. For address and document requirements, this should be the ID of the resource. For textual, this should be the value of the requirement. 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 type: object 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 type: object 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 shaken_stir_enabled: true 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 tags: - tag1 - tag2 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 shaken_stir_enabled: default: false description: When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls. example: false type: boolean 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: uri 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 tags: description: Tags associated with the Texml Application. example: - tag1 - tag2 items: type: string type: array 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: uri 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: uri type: string required: - friendly_name - voice_url title: Update Texml Application Request type: object UpdateVerifyProfileCallRequest: properties: app_name: description: The name that identifies the application requesting 2fa in the verification message. example: Example Secure App pattern: ^[A-Za-z0-9 -]{1,30}$ type: string code_length: default: 5 description: The length of the verify code to generate. example: 6 type: integer default_verification_timeout_secs: default: 300 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_template_id: description: The message template identifier selected from /verify_profiles/templates example: 0abb5b4f-459f-445a-bfcd-488998b7572d format: uuid type: string whitelisted_destinations: description: Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. example: - US - CA items: description: ISO 3166-1 alpha-2 country code pattern: ^[A-Z]{2}$ type: string type: array title: UpdateVerifyProfileCallRequest type: object UpdateVerifyProfileFlashcallRequest: properties: default_verification_timeout_secs: default: 300 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 whitelisted_destinations: description: Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. example: - US - CA items: description: ISO 3166-1 alpha-2 country code pattern: ^[A-Z]{2}$ type: string type: array title: UpdateVerifyProfileFlashcallRequest type: object UpdateVerifyProfileSMSRequest: properties: alpha_sender: default: Telnyx description: The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID. nullable: true pattern: ^[A-Za-z0-9 ]{1,11}$ type: string app_name: description: The name that identifies the application requesting 2fa in the verification message. example: Example Secure App pattern: ^[A-Za-z0-9 -]{1,30}$ type: string code_length: default: 5 description: The length of the verify code to generate. example: 6 type: integer default_verification_timeout_secs: default: 300 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_template_id: description: The message template identifier selected from /verify_profiles/templates example: 0abb5b4f-459f-445a-bfcd-488998b7572d format: uuid type: string whitelisted_destinations: description: Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. example: - US - CA items: description: ISO 3166-1 alpha-2 country code pattern: ^[A-Z]{2}$ type: string type: array title: UpdateVerifyProfileSMSRequest 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 Upload: properties: available_usages: items: description: Available usages for the numbers in the upload on Microsoft Teams. enum: - calling_user_assignment - first_party_app_assignment type: string type: array error_code: description: A code returned by Microsoft Teams if there is an error with the upload process. type: string error_message: description: A message set if there is an error with the upload process. type: string location_id: example: c37e5036-1e87-42e6-86a2-b3e8dd39a2ad format: uuid type: string status: default: pending_upload description: Represents the status of the upload on Microsoft Teams. enum: - pending_upload - pending - in_progress - partial_success - success - error example: error type: string tenant_id: example: ea175aba-f47c-4702-9400-efaa42688048 format: uuid type: string ticket_id: $ref: '#/components/schemas/UUID' tn_upload_entries: items: $ref: '#/components/schemas/TnUploadEntry' type: array title: Upload 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 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. The maximum allowed vale is 630720000, which translates to 20 years. 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. The maximum allowed vale is 630720000, which translates to 20 years. example: 86400 type: integer required: - media_url title: Upload media request type: object Url: properties: url: format: uri maxLength: 2083 minLength: 1 title: Url type: string required: - url title: 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: - rate-deck example: rate-deck type: string UsageReportsOptionsRecord: description: An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records properties: product: description: Telnyx Product example: wireless type: string product_dimensions: description: Telnyx Product Dimensions example: '[''mnc'', ''mcc'', ''sim_card_id'', ''sim_group_name'']' items: type: string type: array product_metrics: description: Telnyx Product Metrics example: '[''uplink_data_bytes'',''downlink_data'',''downlink_data_bytes'',''uplink_data'',''data_cost'']' items: type: string type: array record_types: description: Subproducts if applicable example: 'null' items: $ref: '#/components/schemas/usage-reports_RecordType' type: array type: object UsageReportsOptionsResponse: description: An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records properties: data: description: Collection of product description items: $ref: '#/components/schemas/UsageReportsOptionsRecord' type: array type: object UsageReportsResponse: properties: data: example: - cost: 0.012 count: 8 country_iso: LC customer_carrier_fee: 0 direction: outbound parts: 12 product: messaging product_name: long_code - cost: 0.021 count: 12 country_iso: MP customer_carrier_fee: 0 direction: outbound parts: 21 product: messaging product_name: long_code items: additionalProperties: true type: object type: array meta: $ref: '#/components/schemas/PaginationData' type: object UseCaseCategories: description: Tollfree usecase categories enum: - 2FA - App Notifications - Appointments - Auctions - Auto Repair Services - Bank Transfers - Billing - Booking Confirmations - Business Updates - COVID-19 Alerts - Career Training - Chatbot - Conversational / Alerts - Courier Services & Deliveries - Emergency Alerts - Events & Planning - Financial Services - Fraud Alerts - Fundraising - General Marketing - General School Updates - HR / Staffing - Healthcare Alerts - Housing Community Updates - Insurance Services - Job Dispatch - Legal Services - Mixed - Motivational Reminders - Notary Notifications - Order Notifications - Political - Public Works - Real Estate Services - Religious Services - Repair and Diagnostics Alerts - Rewards Program - Surveys - System Alerts - Voting Reminders - Waitlist Alerts - Webinar Reminders - Workshop Alerts title: UseCaseCategories type: string UsecaseMetadata: properties: annualFee: description: Campaign annual subscription fee title: Annualfee type: number maxSubUsecases: description: Maximum number of sub-usecases declaration required. title: Maxsubusecases type: integer minSubUsecases: description: Minimum number of sub-usecases declaration required. title: Minsubusecases type: integer mnoMetadata: additionalProperties: true description: Map of usecase metadata for each MNO. Key is the network ID of the MNO (e.g. 10017), Value is the mno metadata for the usecase. title: Mnometadata type: object monthlyFee: description: Campaign monthly subscription fee title: Monthlyfee type: number quarterlyFee: description: Campaign quarterly subscription fee title: Quarterlyfee type: number usecase: description: Campaign usecase title: Usecase type: string title: UsecaseMetadata type: object UserAddress: properties: administrative_area: $ref: '#/components/schemas/user-addresses_administrative_area' borough: $ref: '#/components/schemas/user-addresses_borough' business_name: $ref: '#/components/schemas/user-addresses_business_name' country_code: $ref: '#/components/schemas/user-addresses_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/user-addresses_extended_address' first_name: $ref: '#/components/schemas/user-addresses_first_name' id: description: Uniquely identifies the user address. example: c3527e69-dc5a-4b3e-8f44-99d209f83c1d format: uuid type: string last_name: $ref: '#/components/schemas/user-addresses_last_name' locality: $ref: '#/components/schemas/user-addresses_locality' neighborhood: $ref: '#/components/schemas/user-addresses_neighborhood' phone_number: $ref: '#/components/schemas/user-addresses_phone_number' postal_code: $ref: '#/components/schemas/user-addresses_postal_code' record_type: description: Identifies the type of the resource. example: user_address type: string street_address: $ref: '#/components/schemas/user-addresses_street_address' updated_at: description: ISO 8601 formatted date indicating when the resource was updated. example: '2018-02-02T22:25:27.521Z' type: string title: UserAddress type: object UserAddressCreate: properties: administrative_area: $ref: '#/components/schemas/user-addresses_administrative_area' borough: $ref: '#/components/schemas/user-addresses_borough' business_name: $ref: '#/components/schemas/user-addresses_business_name' country_code: $ref: '#/components/schemas/user-addresses_country_code' customer_reference: $ref: '#/components/schemas/customer_reference' extended_address: $ref: '#/components/schemas/user-addresses_extended_address' first_name: $ref: '#/components/schemas/user-addresses_first_name' last_name: $ref: '#/components/schemas/user-addresses_last_name' locality: $ref: '#/components/schemas/user-addresses_locality' neighborhood: $ref: '#/components/schemas/user-addresses_neighborhood' phone_number: $ref: '#/components/schemas/user-addresses_phone_number' postal_code: $ref: '#/components/schemas/user-addresses_postal_code' skip_address_verification: $ref: '#/components/schemas/skip_address_verification' street_address: $ref: '#/components/schemas/user-addresses_street_address' required: - first_name - last_name - business_name - street_address - locality - country_code type: object UserBalance: example: available_credit: '400.00' balance: '300.00' credit_limit: '100.00' currency: USD pending: '10.00' record_type: balance properties: available_credit: description: Available amount to spend (balance + credit limit) example: '400.00' type: string balance: description: The account's current balance. example: '300.00' type: string credit_limit: description: The account's credit limit. example: '100.00' type: string currency: description: The ISO 4217 currency identifier. example: USD type: string pending: description: "The account\u2019s pending amount." example: '10.00' type: string record_type: description: Identifies the type of the resource. enum: - balance example: balance type: string type: object UserBundle: properties: active: description: Status of the user bundle. example: true type: boolean billing_bundle: $ref: '#/components/schemas/BillingBundleSummary' created_at: description: Date the user bundle was created. example: '2025-01-20' format: date type: string id: description: User bundle's ID, this is used to identify the user bundle in the API. example: ca1d2263-d1f1-43ac-ba53-248e7a4bb26a format: uuid type: string resources: example: [] items: $ref: '#/components/schemas/UserBundleResourceSchema' type: array updated_at: description: Date the user bundle was last updated. example: '2025-01-20' format: date nullable: true type: string user_id: description: The customer's ID that owns this user bundle. example: 16856d8c-cd59-4b08-9ac2-1ebb01d419e1 format: uuid type: string required: - id - active - user_id - created_at - billing_bundle - resources type: object UserBundleCreateRequest: properties: billing_bundle_id: format: uuid title: Billing Bundle Id type: string required: - billing_bundle_id title: UserBundleCreateRequest type: object UserBundleCreateResponse: properties: data: $ref: '#/components/schemas/UserBundle' required: - data title: UserBundleCreateResponse type: object UserBundleResourceSchema: properties: created_at: description: Date the resource was created. example: '2025-01-20' format: date type: string id: description: Resource's ID. example: ca1d2263-d1f1-43ac-ba53-248e7a4bb26a format: uuid type: string resource: description: The resource itself (usually a phone number). example: '+15617819942' type: string resource_type: description: The type of the resource (usually 'number'). example: number type: string updated_at: description: Date the resource was last updated. example: '2025-01-20' format: date nullable: true type: string required: - id - resource - resource_type - created_at title: UserBundleResourceSchema type: object UserBundleResourcesResponse: properties: data: items: $ref: '#/components/schemas/UserBundleResourceSchema' title: Data type: array required: - data title: UserBundleResourcesResponse type: object UserBundleResponse: properties: data: $ref: '#/components/schemas/UserBundle' required: - data title: UserBundleResponse type: object UserBundleSummary: properties: active: title: Active type: boolean billing_bundle: $ref: '#/components/schemas/BillingBundleSummary' created_at: format: date title: Created At type: string id: format: uuid title: Id type: string resources: items: $ref: '#/components/schemas/UserBundleResourceSchema' title: Resources type: array updated_at: format: date title: Updated At type: string user_id: title: User Id type: string required: - id - active - user_id - created_at - billing_bundle - resources title: UserBundleSummary type: object UserEmbeddedBuckets: properties: buckets: items: type: string title: Buckets type: array required: - buckets title: UserEmbeddedBuckets type: object UserEmbeddedBucketsData: properties: data: $ref: '#/components/schemas/UserEmbeddedBuckets' required: - data title: UserEmbeddedBucketsData type: object UserId: description: Identifier of the user to whom the fax belongs example: yfff7c54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string UserRequirement: properties: created_at: format: date-time type: string expires_at: format: date-time type: string field_type: type: string field_value: type: string requirement_id: type: string status: enum: - approved - unapproved - pending-approval - declined type: string updated_at: format: date-time type: string type: object UserTagList: description: 'A list of your tags on the given resource type. NOTE: The casing of the tags returned will not necessarily match the casing of the tags when they were added to a resource. This is because the tags will have the casing of the first time they were used within the Telnyx system regardless of source.' items: example: my-tag type: string type: array ValidateAddressField: 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/ValidateAddressField' additionalProperties: true description: Provides normalized address when available. type: object required: - result - suggested title: Validate address action result type: object ValidationCodes: properties: order_id: format: uuid type: string phone_numbers: items: properties: phone_number: format: +E.164 type: string status: enum: - verified - rejected - already_verified type: string required: - phone_number - status type: object type: array required: - phone_numbers - order_id type: object ValidationCodesRequest: properties: verification_codes: items: properties: code: type: string phone_number: format: +E.164 type: string required: - phone_number - code type: object type: array required: - verification_codes type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object Verification: properties: created_at: example: '2020-09-14T17:03:32.965812' type: string custom_code: default: null description: Send a self-generated numeric code to the end-user example: '43612' nullable: true 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 type: $ref: '#/components/schemas/VerificationType' updated_at: example: '2020-09-14T17:03:32.965812' type: string 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 VerificationCodesRequest: properties: phone_numbers: items: format: +E.164 type: string type: array verification_method: enum: - sms - call - flashcall type: string required: - phone_numbers - verification_method 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 VerificationRequestEgress: description: A verification request as it comes out of the database properties: additionalInformation: example: This is for security purposes, blah blah blah title: Additionalinformation type: string businessAddr1: example: 600 Congress Avenue title: Businessaddr1 type: string businessAddr2: example: 14th Floor title: Businessaddr2 type: string businessCity: example: Austin title: Businesscity type: string businessContactEmail: example: email@example.com title: Businesscontactemail type: string businessContactFirstName: example: John title: Businesscontactfirstname type: string businessContactLastName: example: Doe title: Businesscontactlastname type: string businessContactPhone: example: '+18005550100' title: Businesscontactphone type: string businessName: example: Telnyx LLC title: Businessname type: string businessState: example: Texas title: Businessstate type: string businessZip: example: '78701' title: Businesszip type: string corporateWebsite: example: http://example.com title: Corporatewebsite type: string id: format: uuid title: Id type: string isvReseller: example: 'Yes' title: Isvreseller type: string messageVolume: allOf: - $ref: '#/components/schemas/Volume' description: 'One of the following exact values: 10; 100; 1,000; 10,000; 100,000; 250,000; 500,000; 750,000; 1,000,000; 5,000,000; 10,000,000+' example: 100,000 optInWorkflow: example: User signs into the Telnyx portal, enters number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset title: Optinworkflow type: string optInWorkflowImageURLs: example: - url: https://telnyx.com/sign-up - url: https://telnyx.com/company/data-privacy items: $ref: '#/components/schemas/Url' title: Optinworkflowimageurls type: array phoneNumbers: example: - phoneNumber: '+18773554398' - phoneNumber: '+18773554399' items: $ref: '#/components/schemas/TFPhoneNumber' title: Phonenumbers type: array productionMessageContent: example: Your Telnyx OTP is XXXX title: Productionmessagecontent type: string useCase: allOf: - $ref: '#/components/schemas/UseCaseCategories' example: 2FA useCaseSummary: example: This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal title: Usecasesummary type: string verificationRequestId: title: Verificationrequestid type: string verificationStatus: allOf: - $ref: '#/components/schemas/TFVerificationStatus' default: In Progress webhookUrl: example: http://example-webhook.com title: Webhookurl type: string required: - businessName - corporateWebsite - businessAddr1 - businessCity - businessState - businessZip - businessContactFirstName - businessContactLastName - businessContactEmail - businessContactPhone - messageVolume - phoneNumbers - useCase - useCaseSummary - productionMessageContent - optInWorkflow - optInWorkflowImageURLs - additionalInformation - isvReseller - id - verificationRequestId title: VerificationRequestEgress type: object VerificationRequestStatus: description: A verification request and its status, suitable for returning to users properties: additionalInformation: example: This is for security purposes, blah blah blah title: Additionalinformation type: string businessAddr1: example: 600 Congress Avenue title: Businessaddr1 type: string businessAddr2: example: 14th Floor title: Businessaddr2 type: string businessCity: example: Austin title: Businesscity type: string businessContactEmail: example: email@example.com title: Businesscontactemail type: string businessContactFirstName: example: John title: Businesscontactfirstname type: string businessContactLastName: example: Doe title: Businesscontactlastname type: string businessContactPhone: example: '+18889809750' title: Businesscontactphone type: string businessName: example: Telnyx LLC title: Businessname type: string businessState: example: Texas title: Businessstate type: string businessZip: example: '78701' title: Businesszip type: string corporateWebsite: example: http://example.com title: Corporatewebsite type: string createdAt: example: '2024-01-23T18:10:02.574Z' format: date-time title: Createdat type: string id: example: eaba9f52-164e-58e0-b002-4f668e18b7ed format: uuid title: Id type: string isvReseller: example: 'Yes' title: Isvreseller type: string messageVolume: allOf: - $ref: '#/components/schemas/Volume' description: 'One of the following exact values: 10; 100; 1,000; 10,000; 100,000; 250,000; 500,000; 750,000; 1,000,000; 5,000,000; 10,000,000+' example: 100,000 optInWorkflow: example: User signs into the Telnyx portal, enters number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset title: Optinworkflow type: string optInWorkflowImageURLs: example: - url: https://telnyx.com/sign-up - url: https://telnyx.com/company/data-privacy items: $ref: '#/components/schemas/Url' title: Optinworkflowimageurls type: array phoneNumbers: example: - phoneNumber: '+18773554398' - phoneNumber: '+18773554399' items: $ref: '#/components/schemas/TFPhoneNumber' title: Phonenumbers type: array productionMessageContent: example: Your Telnyx OTP is XXXX title: Productionmessagecontent type: string reason: example: Unfortunately, we have to cancel this request as we do not support non tollfree US numbers. title: Reason type: string updatedAt: example: '2024-01-23T18:10:02.574Z' format: date-time title: Updatedat type: string useCase: allOf: - $ref: '#/components/schemas/UseCaseCategories' example: 2FA useCaseSummary: example: This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal title: Usecasesummary type: string verificationStatus: allOf: - $ref: '#/components/schemas/TFVerificationStatus' example: Pending Customer Feedback webhookUrl: example: http://example-webhook.com title: Webhookurl type: string required: - businessName - corporateWebsite - businessAddr1 - businessCity - businessState - businessZip - businessContactFirstName - businessContactLastName - businessContactEmail - businessContactPhone - messageVolume - phoneNumbers - useCase - useCaseSummary - productionMessageContent - optInWorkflow - optInWorkflowImageURLs - additionalInformation - isvReseller - id - verificationStatus title: VerificationRequestStatus type: object VerificationStatus: description: The possible statuses of the verification request. enum: - pending - accepted - invalid - expired - error example: accepted title: VerificationStatus type: string VerificationType: description: The possible types of verification. enum: - sms - call - flashcall example: sms title: VerificationType type: string VerifiedNumberRecordType: description: The possible verified numbers record types. enum: - verified_number example: verified_number title: VerifiedNumberRecordType type: string VerifiedNumberResponse: properties: phone_number: example: '+15551234567' type: string record_type: $ref: '#/components/schemas/VerifiedNumberRecordType' verified_at: example: '2020-09-14T17:03:32.965812' type: string title: VerifiedNumberResponse type: object VerifiedNumberResponseDataWrapper: properties: data: $ref: '#/components/schemas/VerifiedNumberResponse' additionalProperties: true type: object title: VerifiedNumberResponseDataWrapper type: object VerifyDetailRecord: properties: created_at: example: '2021-07-08T00:00:41.000000+00:00' format: date-time type: string currency: description: Telnyx account currency used to describe monetary values, including billing costs example: USD type: string delivery_status: example: pending type: string destination_phone_number: description: E.164 formatted phone number example: '+13124515883' type: string id: description: Unique ID of the verification example: 0add777f-1549-46f7-84e9-ad7350f6aa97 format: uuid type: string rate: description: Currency amount per billing unit used to calculate the Telnyx billing costs example: '0.002' type: string rate_measured_in: description: Billing unit used to calculate the Telnyx billing costs example: number of occurrences type: string record_type: default: verification_detail_record example: verification_detail_record type: string updated_at: example: '2021-07-08T00:00:41.000000+00:00' format: date-time type: string verification_status: example: pending type: string verify_channel_id: example: 5b7a8365-91f3-420a-befc-498d1efd6c20 format: uuid type: string verify_channel_type: description: 'Depending on the type of verification, the `verify_channel_id` points to one of the following channel ids; --- verify_channel_type | verify_channel_id ------------------- | ----------------- sms, psd2 | messaging_id call, flashcall | call_control_id --- ' enum: - sms - psd2 - call - flashcall type: string verify_profile_id: example: 49000176-1ab2-8bc1-352e-4009f6c37f82 format: uuid type: string verify_usage_fee: description: Currency amount for Verify Usage Fee example: '0.002' type: string required: - record_type type: object VerifyProfileCallResponse: properties: app_name: description: The name that identifies the application requesting 2fa in the verification message. example: Example Secure App pattern: ^[A-Za-z0-9 -]{1,30}$ type: string code_length: default: 5 description: The length of the verify code to generate. example: 6 type: integer default_verification_timeout_secs: default: 300 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_template_id: description: The message template identifier selected from /verify_profiles/templates example: 0abb5b4f-459f-445a-bfcd-488998b7572d format: uuid type: string whitelisted_destinations: description: Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. example: - US - CA items: description: ISO 3166-1 alpha-2 country code pattern: ^[A-Z]{2}$ type: string type: array title: VerifyProfileCallResponse type: object VerifyProfileFlashcallResponse: properties: default_verification_timeout_secs: default: 300 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 VerifyProfileMessageTemplateResponse: properties: id: example: 0abb5b4f-459f-445a-bfcd-488998b7572d format: uuid type: string text: example: 'Your {{app_name}} verification code is: {{code}}.' type: string title: VerifyProfileResponse type: object VerifyProfileResponse: properties: call: $ref: '#/components/schemas/VerifyProfileCallResponse' additionalProperties: true type: object created_at: example: '2020-09-14T17:03:32.965812' type: string flashcall: $ref: '#/components/schemas/VerifyProfileFlashcallResponse' additionalProperties: true 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 record_type: $ref: '#/components/schemas/VerificationProfileRecordType' sms: $ref: '#/components/schemas/VerifyProfileSMSResponse' additionalProperties: true 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 title: VerifyProfileResponse type: object VerifyProfileResponseDataWrapper: properties: data: $ref: '#/components/schemas/VerifyProfileResponse' additionalProperties: true type: object title: VerifyProfileResponseDataWrapper type: object VerifyProfileSMSResponse: properties: alpha_sender: default: Telnyx description: The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID. nullable: true pattern: ^[A-Za-z0-9 ]{1,11}$ type: string app_name: description: The name that identifies the application requesting 2fa in the verification message. example: Example Secure App pattern: ^[A-Za-z0-9 -]{1,30}$ type: string code_length: default: 5 description: The length of the verify code to generate. example: 6 type: integer default_verification_timeout_secs: default: 300 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_template_id: description: The message template identifier selected from /verify_profiles/templates example: 0abb5b4f-459f-445a-bfcd-488998b7572d format: uuid type: string whitelisted_destinations: description: Enabled country destinations to send verification codes. The elements in the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all destinations will be allowed. example: - US - CA items: description: ISO 3166-1 alpha-2 country code pattern: ^[A-Z]{2}$ type: string type: array title: VerifyProfileSMSResponse type: object VerifyVerificationCodeRequestById: properties: code: description: This is the code the user submits for verification. example: '17686' type: string status: description: Identifies if the verification code has been accepted or rejected. Only permitted if custom_code was used for the verification. enum: - accepted - rejected example: accepted type: string title: VerifyVerificationCodeRequestById type: object VerifyVerificationCodeRequestByPhoneNumber: properties: code: description: This is the code the user submits for verification. example: '17686' type: string verify_profile_id: description: The identifier of the associated Verify profile. example: 12ade33a-21c0-473b-b055-b3c836e1c292 format: uuid type: string required: - code - verify_profile_id title: VerifyVerificationCodeRequestByPhoneNumber 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 VersionConfig: description: Configuration for a single version in canary deploy. properties: percentage: description: Percentage of traffic for this version [1-99] exclusiveMaximum: true exclusiveMinimum: true maximum: 100.0 minimum: 0.0 title: Percentage type: number version_id: description: Version ID string that references assistant_versions.version_id title: Version Id type: string required: - version_id - percentage title: VersionConfig type: object Vertical: description: Vertical or industry segment of the brand or campaign. enum: - REAL_ESTATE - HEALTHCARE - ENERGY - ENTERTAINMENT - RETAIL - AGRICULTURE - INSURANCE - EDUCATION - HOSPITALITY - FINANCIAL - GAMBLING - CONSTRUCTION - NGO - MANUFACTURING - GOVERNMENT - TECHNOLOGY - COMMUNICATION example: TECHNOLOGY title: Vertical type: string VideoRegion: properties: height: description: Height of the video region example: 360 minimum: 16 nullable: true type: integer max_columns: description: Maximum number of columns of the region's placement grid. By default, the region has as many columns as needed to layout all the specified video sources. example: 3 maximum: 1000 minimum: 1 nullable: true type: integer max_rows: description: Maximum number of rows of the region's placement grid. By default, the region has as many rows as needed to layout all the specified video sources. example: 3 maximum: 1000 minimum: 1 nullable: true type: integer video_sources: description: Array of video recording ids to be composed in the region. Can be "*" to specify all video recordings in the session items: example: 7b61621f-62e0-4aad-ab11-9fd19e272e73 format: uuid type: string type: array width: description: Width of the video region example: 480 minimum: 16 nullable: true type: integer x_pos: default: 0 description: X axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport. example: 100 nullable: true type: integer y_pos: default: 0 description: Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport. example: 100 nullable: true type: integer z_pos: default: 0 description: Regions with higher z_pos values are stacked on top of regions with lower z_pos values example: 1 maximum: 99 minimum: -99 nullable: true type: integer type: object VirtualCrossConnect: allOf: - $ref: '#/components/schemas/Record' - $ref: '#/components/schemas/Interface' - properties: bandwidth_mbps: description: The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.<br /><br />The available bandwidths can be found using the /virtual_cross_connect_regions endpoint. example: 50 type: number bgp_asn: description: The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx. example: 1234 type: number cloud_provider: description: The Virtual Private Cloud with which you would like to establish a cross connect. enum: - aws - azure - gce example: aws type: string cloud_provider_region: description: The region where your Virtual Private Cloud hosts are located.<br /><br />The available regions can be found using the /virtual_cross_connect_regions endpoint. example: us-east-1 type: string primary_bgp_key: description: The authentication key for BGP peer configuration. example: yFV4wEPtPVPfDUGLWiyQzwga type: string primary_cloud_account_id: description: The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider. example: '123456789012' type: string primary_cloud_ip: description: The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. example: 169.254.0.2 type: string primary_enabled: description: Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit. example: true readOnly: true type: boolean primary_telnyx_ip: description: The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. example: 169.254.0.1 type: string record_type: description: Identifies the type of the resource. example: virtual_cross_connect readOnly: true type: string secondary_bgp_key: description: The authentication key for BGP peer configuration. example: ge1lONeK9RcA83uuWaw9DvZy type: string secondary_cloud_account_id: description: The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.<br /><br />This attribute is only necessary for GCE. example: '' type: string secondary_cloud_ip: description: The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. example: 169.254.0.4 type: string secondary_enabled: description: Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit. example: true readOnly: true type: boolean secondary_telnyx_ip: description: The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted. example: 169.254.0.3 type: string title: VirtualCrossConnect type: object VirtualCrossConnectCombined: allOf: - $ref: '#/components/schemas/VirtualCrossConnectCreate' - $ref: '#/components/schemas/VirtualCrossConnectPatch' - $ref: '#/components/schemas/RegionOut' VirtualCrossConnectCoverage: allOf: - properties: available_bandwidth: description: The available throughput in Megabits per Second (Mbps) for your Virtual Cross Connect. example: - 50 - 100 - 200 - 500 items: type: number type: array cloud_provider: description: The Virtual Private Cloud with which you would like to establish a cross connect. enum: - aws - azure - gce example: aws type: string cloud_provider_region: description: The region where your Virtual Private Cloud hosts are located. Should be identical to how the cloud provider names region, i.e. us-east-1 for AWS but Frankfurt for Azure example: us-east-1 type: string location: $ref: '#/components/schemas/netapps_Location' record_type: description: Identifies the type of the resource. example: virtual_cross_connects_coverage readOnly: true type: string title: VirtualCrossConnectCoverage type: object VirtualCrossConnectCreate: allOf: - $ref: '#/components/schemas/VirtualCrossConnect' - $ref: '#/components/schemas/RegionIn' - required: - network_id - region_code - cloud_provider - cloud_provider_region - bgp_asn - primary_cloud_account_id title: VirtualCrossConnectCreate type: object VirtualCrossConnectPatch: allOf: - properties: primary_cloud_ip: description: The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned. example: 169.254.0.2 type: string primary_enabled: description: Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit. example: true type: boolean primary_routing_announcement: description: Whether the primary BGP route is being announced. example: false type: boolean secondary_cloud_ip: description: The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned. example: 169.254.0.4 type: string secondary_enabled: description: Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit. example: true type: boolean secondary_routing_announcement: description: Whether the secondary BGP route is being announced. example: false type: boolean title: VirtualCrossConnectPatch type: object VoiceConfig: default: Telnyx.KokoroTTS.af description: "The voice to be used by the voice assistant. Currently we support\ \ ElevenLabs, Telnyx and AWS voices.\n\n **Supported Providers:**\n- **AWS:**\ \ Use `AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural voices,\ \ which provide more realistic, human-like speech, append `-Neural` to the\ \ `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)\ \ for compatibility.\n- **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,\ \ Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural, Azure.en-US-Ava:DragonHDLatestNeural.\ \ For a complete list of voices, go to [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)\n\ - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g., `ElevenLabs.BaseModel.John`).\ \ The `ModelId` part is optional. To use ElevenLabs, you must provide your\ \ ElevenLabs API key as an integration secret under `\"voice_settings\": {\"\ api_key_ref\": \"<secret_id>\"}`. See [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)\ \ for details. Check [available voices](https://elevenlabs.io/docs/api-reference/get-voices).\n\ \ - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`" example: Telnyx.KokoroTTS.af type: string VoiceSettings: properties: api_key_ref: description: 'The `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your ElevenLabs API key. Warning: Free plans are unlikely to work with this integration.' type: string voice: description: 'The voice to be used by the voice assistant. Check the full list of [available voices](https://developers.telnyx.com/api/call-control/list-text-to-speech-voices) via our voices API. To use ElevenLabs, you must reference your ElevenLabs API key as an integration secret under the `api_key_ref` field. See [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) for details. For Telnyx voices, use `Telnyx.<model_id>.<voice_id>` (e.g. Telnyx.KokoroTTS.af_heart)' type: string voice_speed: default: 1 description: The speed of the voice in the range [0.25, 2.0]. 1.0 is deafult speed. Larger numbers make the voice faster, smaller numbers make it slower. This is only applicable for Telnyx Natural voices. type: number required: - voice type: object VoicemailPrefResponse: example: enabled: 'true' pin: '1234' properties: enabled: description: Whether voicemail is enabled. example: true type: boolean pin: description: The pin used for the voicemail. example: 1234 type: string type: object VoicemailRequest: properties: enabled: description: Whether voicemail is enabled. example: true type: boolean pin: description: The pin used for voicemail example: 1234 type: string type: object Volume: description: Message Volume Enums enum: - '10' - '100' - 1,000 - 10,000 - 100,000 - 250,000 - 500,000 - 750,000 - 1,000,000 - 5,000,000 - 10,000,000+ title: Volume type: string 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: uri 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: uri title: Webhook Event URL type: string WebhookPortingOrderDeletedPayload: description: The webhook payload for the porting_order.deleted event properties: customer_reference: description: Identifies the customer reference associated with the porting order. example: my-ref-001 type: string deleted_at: description: ISO 8601 formatted date indicating when the porting order was deleted. example: '2021-03-19T10:07:15.527Z' format: date-time type: string id: description: Identifies the porting order that was deleted. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string type: object WebhookPortingOrderMessagingChangedPayload: description: The webhook payload for the porting_order.messaging_changed event properties: customer_reference: description: Identifies the customer reference associated with the porting order. example: my-ref-001 type: string id: description: Identifies the porting order that was moved. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string messaging: description: The messaging portability status of the porting order. properties: enable_messaging: description: Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider. example: true type: boolean messaging_capable: description: Indicates whether the porting order is messaging capable. example: true type: boolean messaging_port_completed: description: Indicates whether the messaging port is completed. example: true type: boolean messaging_port_status: description: Indicates the messaging port status of the porting order. enum: - not_applicable - pending - activating - exception - canceled - partial_port_complete - ported example: ported type: string type: object support_key: description: Identifies the support key associated with the porting order. example: sr_b1a2c3 type: string type: object WebhookPortingOrderNewCommentPayload: description: The webhook payload for the porting_order.new_comment event properties: comment: description: The comment that was added to the porting order. properties: body: description: The body of the comment. example: This is a comment. type: string id: description: Identifies the comment. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string inserted_at: description: ISO 8601 formatted date indicating when the comment was created. example: '2021-03-19T10:07:15.527Z' format: date-time type: string user_id: description: Identifies the user that create the comment. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string user_type: description: Identifies the type of the user that created the comment. enum: - user - admin - system example: user type: string type: object porting_order_id: description: Identifies the porting order that the comment was added to. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string support_key: description: Identifies the support key associated with the porting order. example: sr_b1a2c3 type: string type: object WebhookPortingOrderSplitPayload: description: The webhook payload for the porting_order.split event properties: from: description: The porting order that was split. properties: id: description: Identifies the porting order that was split. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string type: object porting_phone_numbers: description: The list of porting phone numbers that were moved to the new porting order. items: properties: id: description: Identifies the porting phone number that was moved. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string type: object type: array to: description: The new porting order that the phone numbers was moved to. properties: id: description: Identifies the porting order that was split. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string type: object type: object WebhookPortingOrderStatusChangedPayload: description: The webhook payload for the porting_order.status_changed event properties: customer_reference: description: Identifies the customer reference associated with the porting order. example: my-ref-001 type: string id: description: Identifies the porting order that was moved. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string status: $ref: '#/components/schemas/PortingOrderStatus' support_key: description: Identifies the support key associated with the porting order. example: sr_b1a2c3 type: string updated_at: description: ISO 8601 formatted date indicating when the porting order was moved. example: '2021-03-19T10:07:15.527Z' format: date-time type: string webhook_url: description: The URL to send the webhook to. example: https://example.com/webhook type: string type: object WebhookPortoutFocDateChangedPayload: description: The webhook payload for the portout.foc_date_changed event properties: foc_date: description: ISO 8601 formatted date indicating the new FOC date. example: '2021-03-19T10:07:15.527Z' format: date-time type: string id: description: Identifies the port-out order that have the FOC date changed. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string user_id: description: Identifies the organization that port-out order belongs to. example: 0e19c89e-f0ce-458a-a36c-3c60bc2014b1 type: string type: object WebhookPortoutNewCommentPayload: description: The webhook payload for the portout.new_comment event properties: comment: description: The body of the comment. example: This is a comment. type: string id: description: Identifies the comment that was added to the port-out order. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string portout_id: description: Identifies the port-out order that the comment was added to. example: d26109e5-0605-4671-a235-d3c649cc8406 format: uuid type: string user_id: description: Identifies the user that added the comment. example: 1c45c968-c2e0-4559-b1dd-db073962fc61 format: uuid type: string type: object WebhookPortoutStatusChangedPayload: description: The webhook payload for the portout.status_changed event properties: attempted_pin: description: The PIN that was attempted to be used to authorize the port out. example: '1234' type: string carrier_name: description: Carrier the number will be ported out to example: Testing Carrier type: string id: description: Identifies the port out that was moved. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string phone_numbers: description: Phone numbers associated with this port-out order example: - '+35312345678' items: description: E164 formatted phone number type: string type: array rejection_reason: description: The reason why the order is being rejected by the user. If the order is authorized, this field can be left null example: null type: string spid: description: The new carrier SPID. example: 987H type: string status: description: The new status of the port out. enum: - pending - authorized - ported - rejected - rejected-pending - canceled example: authorized type: string subscriber_name: description: The name of the port-out's end user. example: John Doe type: string user_id: description: Identifies the user that the port-out order belongs to. example: 96dfa9e4-c753-4fd3-97cd-42d66f26cf0c format: uuid type: string type: object 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 WebhookTool: properties: type: enum: - webhook type: string webhook: $ref: '#/components/schemas/inference-embedding_WebhookToolParams' required: - type - webhook title: WebhookTool type: object WebhookToolParams: properties: body_parameters: description: The body parameters the webhook tool accepts, described as a JSON Schema object. These parameters will be passed to the webhook as the body of the request. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format example: properties: age: description: The age of the customer. type: integer location: description: The location of the customer. type: string required: - age - location type: object properties: properties: description: The properties of the body parameters. type: object required: description: The required properties of the body parameters. items: type: string type: array type: enum: - object type: string type: object description: description: The description of the tool. type: string headers: description: The headers to be sent to the external tool. items: properties: name: type: string value: description: The value of the header. Note that we support mustache templating for the value. For example you can use `Bearer {{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of the integration secret as the bearer token. type: string type: object type: array method: default: POST description: The HTTP method to be used when calling the external tool. enum: - GET - POST - PUT - DELETE - PATCH type: string name: description: The name of the tool. type: string path_parameters: description: The path parameters the webhook tool accepts, described as a JSON Schema object. These parameters will be passed to the webhook as the path of the request if the URL contains a placeholder for a value. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format example: properties: id: description: The id of the customer. type: string required: - id type: object properties: properties: description: The properties of the path parameters. type: object required: description: The required properties of the path parameters. items: type: string type: array type: enum: - object type: string type: object query_parameters: description: The query parameters the webhook tool accepts, described as a JSON Schema object. These parameters will be passed to the webhook as the query of the request. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format example: properties: page: description: The page number. type: integer required: - page type: object properties: properties: description: The properties of the query parameters. type: object required: description: The required properties of the query parameters. items: type: string type: array type: enum: - object type: string type: object url: description: 'The URL of the external tool to be called. This URL is going to be used by the assistant. The URL can be templated like: `https://example.com/api/v1/{id}`, where `{id}` is a placeholder for a value that will be provided by the assistant if `path_parameters` are provided with the `id` attribute.' example: https://example.com/api/v1/function type: string required: - url - name - description title: WebhookToolParams type: object WireguardInterface: allOf: - $ref: '#/components/schemas/Record' - $ref: '#/components/schemas/Interface' - properties: enable_sip_trunking: description: Enable SIP traffic forwarding over VPN interface. example: false type: boolean endpoint: description: The Telnyx WireGuard peers `Peer.endpoint` value. example: 203.0.113.0:51871 readOnly: true type: string public_key: description: The Telnyx WireGuard peers `Peer.PublicKey`. example: qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU= readOnly: true type: string record_type: description: Identifies the type of the resource. example: wireguard_interface readOnly: true type: string title: WireguardInterface type: object WireguardInterfaceCreate: allOf: - $ref: '#/components/schemas/WireguardInterface' - $ref: '#/components/schemas/RegionIn' - required: - network_id - region_code title: WireguardInterfaceCreate type: object WireguardInterfaceRead: allOf: - $ref: '#/components/schemas/WireguardInterface' - $ref: '#/components/schemas/RegionOut' WireguardPeer: allOf: - $ref: '#/components/schemas/Record' - $ref: '#/components/schemas/WireguardPeerPatch' - properties: last_seen: description: ISO 8601 formatted date-time indicating when peer sent traffic last time. example: '2018-02-02T22:25:27.521Z' readOnly: true type: string private_key: description: Your WireGuard `Interface.PrivateKey`.<br /><br />This attribute is only ever utlised if, on POST, you do NOT provide your own `public_key`. In which case, a new Public and Private key pair will be generated for you. When your `private_key` is returned, you must save this immediately as we do not save it within Telnyx. If you lose your Private Key, it can not be recovered. example: qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU= readOnly: true type: string record_type: description: Identifies the type of the resource. example: wireguard_peer readOnly: true type: string wireguard_interface_id: description: The id of the wireguard interface associated with the peer. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string title: WireguardPeer type: object WireguardPeerCreate: allOf: - $ref: '#/components/schemas/WireguardPeer' - required: - wireguard_interface_id title: WireguardPeerCreate type: object WireguardPeerPatch: properties: public_key: description: The WireGuard `PublicKey`.<br /><br />If you do not provide a Public Key, a new Public and Private key pair will be generated for you. example: qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU= type: string title: WireguardPeerPatch type: object WirelessBlocklist: 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 name: description: The wireless blocklist name. example: My wireless blocklist. type: string record_type: example: wireless_blocklist readOnly: true type: string type: default: country description: The type of the wireless blocklist. enum: - country - mcc - plmn example: country 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 values: description: Values to block. The values here depend on the `type` of Wireless Blocklist. example: - CA - MX - US items: oneOf: - $ref: '#/components/schemas/CountryCode' - $ref: '#/components/schemas/MobileCountryCode' - $ref: '#/components/schemas/PLMNCode' type: array 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 cell_id: description: The cell ID to which the SIM connected. example: 311210-6813 readOnly: true type: string created_at: description: ISO 8601 formatted date-time indicating when the record was created. example: '2018-02-02T22:25:27.521Z' 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 network operators 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: 081932214823362973 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 last_seen: description: ISO 8601 formatted date-time indicating when the last heartbeat to the device was successfully recorded. example: '2018-02-02T22:25:27.521Z' 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/>\n\ \ 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: TX 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 error codes. items: type: integer 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 audit-logs_Error: properties: code: description: Error code. example: '10001' type: string detail: description: Detailed information about the error. example: The request requires user authentication. type: string title: description: Short description of the error. example: Unauthorized type: string type: object audit-logs_PaginationMeta: properties: page_number: example: 1 type: integer page_size: example: 10 type: integer total_pages: example: 3 type: integer total_results: example: 50 type: integer title: Pagination Meta type: object billing-group_Error: properties: code: format: int32 type: integer detail: type: string meta: additionalProperties: true properties: {} type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object billing-group_Errors: properties: errors: items: $ref: '#/components/schemas/billing-group_Error' type: array type: object billing_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object billing_Errors: properties: errors: items: $ref: '#/components/schemas/billing_Error' type: array type: object 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 bundle-pricing_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. example: '+15617819942' type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object bundle-pricing_Errors: properties: errors: items: $ref: '#/components/schemas/bundle-pricing_Error' type: array type: object 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 call-control_Error: properties: code: format: integer 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 call-control_Errors: properties: errors: items: $ref: '#/components/schemas/call-control_Error' type: array call-recordings_CursorPaginationMeta: properties: cursors: $ref: '#/components/schemas/Cursor' next: description: Path to next page. example: /v2/recording_transcriptions?page[after]=v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI= type: string previous: description: Path to previous page. example: /v2/recording_transcriptions?page[before]=v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI= type: string title: Cursor Pagination Meta type: object call-recordings_Error: properties: code: description: Error code identifier (string or numeric string). type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object call-recordings_Errors: properties: errors: items: $ref: '#/components/schemas/call-recordings_Error' type: array type: object call-scripting_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 title: Pagination Meta type: object call-scripting_ResourceNotFoundError: example: errors: - detail: Resource not found properties: errors: items: properties: detail: type: string type: object type: array title: Resource not found type: object call-scripting_UpdateConferenceRequest: example: Status: completed properties: AnnounceMethod: description: The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`. enum: - GET - POST example: GET type: string AnnounceUrl: description: The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains `<Play>`, `<Say>`, `<Pause>`, or `<Redirect>` verbs. example: https://www.example.com/announce.xml type: string Status: description: The new status of the resource. Specifying `completed` will end the conference and hang up all participants. example: completed type: string title: Update Conference Request type: object callConversationEnded: example: created_at: '2025-05-29T13:35:38.927621Z' event_type: call.conversation.ended id: eb8775a6-634f-48b0-b177-d5465a8a8e9f occurred_at: '2025-05-29T13:35:38.817785Z' payload: assistant_id: assistant-d9082b56-ba2d-4ad1-a50c-58661eb1463d call_control_id: v3:HDR1vQHx697hpP9xZ0bhlbUOWPFPDtPcxw-nuSMuC6mGVpb0euoklQ call_leg_id: cc29cce6-3c91-11f0-a8e5-02420aef3d20 call_session_id: cc29c8d6-3c91-11f0-aa7c-02420aef3d20 calling_party_type: sip client_state: g3QAAAACbQAAAAtkYXRhX2NlbnRlcm0AAAADY2gxbQAAAApkZXBsb3ltZW50bQAAAARiYXNl connection_id: '2694492062593582591' conversation_id: 0424805b-adc1-4ff8-9f95-e1de6883ecbe duration_sec: 3 from: '+13124287921' llm_model: openai/gpt-4o stt_model: distil-whisper/distil-large-v2 to: jamesw@assistant-d9082b56-ba2d-4ad1-a50c-58661eb1463d.sip.telnyx.com tts_model_id: Natural tts_provider: telnyx tts_voice_id: Marissa record_type: event properties: created_at: description: Timestamp when the event was created in the system. example: '2025-05-29T13:35:38.927621Z' format: date-time type: string event_type: description: The type of event being delivered. enum: - call.conversation.ended example: call.conversation.ended type: string id: description: Unique identifier for the event. 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: assistant_id: description: Unique identifier of the assistant involved in the call. example: assistant-d9082b56-ba2d-4ad1-a50c-58661eb1463d type: string call_control_id: description: Call ID used to issue commands via Call Control API. example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg type: string call_leg_id: description: ID that is unique to the call leg. example: cc29cce6-3c91-11f0-a8e5-02420aef3d20 type: string call_session_id: description: ID that is unique to the call session (group of related call legs). example: cc29c8d6-3c91-11f0-aa7c-02420aef3d20 type: string calling_party_type: description: The type of calling party connection. enum: - pstn - sip example: sip type: string client_state: description: Base64-encoded state received from a command. example: g3QAAAACbQAAAAtkYXRhX2NlbnRlcm0AAAADY2gxbQAAAApkZXBsb3ltZW50bQAAAARiYXNl type: string connection_id: description: Call Control App ID (formerly Telnyx connection ID) used in the call. example: 7267xxxxxxxxxxxxxx type: string conversation_id: description: ID unique to the conversation or insight group generated for the call. example: 0424805b-adc1-4ff8-9f95-e1de6883ecbe type: string duration_sec: description: Duration of the conversation in seconds. example: 3 type: integer from: description: The caller's number or identifier. example: '+13124287921' type: string llm_model: description: The large language model used during the conversation. example: openai/gpt-4o type: string stt_model: description: The speech-to-text model used in the conversation. example: distil-whisper/distil-large-v2 type: string to: description: The callee's number or SIP address. example: jamesw@assistant-d9082b56-ba2d-4ad1-a50c-58661eb1463d.sip.telnyx.com type: string tts_model_id: description: The model ID used for text-to-speech synthesis. example: Natural type: string tts_provider: description: The text-to-speech provider used in the call. example: telnyx type: string tts_voice_id: description: Voice ID used for TTS. example: Marissa type: string type: object record_type: description: Identifies the type of the resource. enum: - event example: event type: string title: Call Conversation Ended type: object callConversationEndedEvent: properties: data: $ref: '#/components/schemas/callConversationEnded' title: Call Conversation Ended Event type: object callConversationInsightsGenerated: example: event_type: call.conversation_insights.generated id: 898e96ef-be63-45aa-9e7d-01332bff9a97 occurred_at: '2025-02-19T17:02:49.371454Z' payload: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 calling_party_type: pstn client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx insight_group_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1 results: - insight_id: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1 result: The user inquired about the menu at Ember & Oak. The menu offers various options, including vegetarian, vegan, and gluten-free dishes, as well as a children's menu. The restaurant also has a daily happy hour from 4 PM to 6 PM and offers takeaway and delivery services. The user found the information helpful but had to leave without making any further decisions or requests. No specific preferences or goals were expressed beyond inquiring about the menu. record_type: event properties: event_type: description: The type of event being delivered. enum: - call.conversation_insights.generated example: call.conversation_insights.generated 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1 type: string calling_party_type: description: The type of calling party connection. enum: - pstn - sip example: pstn 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 insight_group_id: description: ID that is unique to the insight group being generated for the call. example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1 type: string results: description: Array of insight results being generated for the call. items: properties: insight_id: description: ID that is unique to the insight result being generated for the call. example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1 type: string result: oneOf: - description: The result of the insight. type: object - description: The result of the insight. type: string type: object type: array type: object record_type: description: Identifies the type of the resource. enum: - event example: event type: string title: Call Conversation Insights Generated type: object callConversationInsightsGeneratedEvent: properties: data: $ref: '#/components/schemas/callConversationInsightsGenerated' title: Call Conversation Insights Generated Event type: object callRecordingError: example: event_type: call.recording.error 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 result: Internal server error record_type: event properties: event_type: description: The type of event being delivered. enum: - call.recording.error example: call.recording.error 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: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. 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 reason: description: Indication that there was a problem recording the call. enum: - Failed to authorize with storage using custom credentials - Invalid credentials json - Unsupported backend - Internal server error example: Internal server error type: string type: object record_type: description: Identifies the type of the resource. enum: - event example: event type: string title: Call Recording Error type: object callRecordingErrorEvent: properties: data: $ref: '#/components/schemas/callRecordingError' title: Call Recording Error Event type: object callRecordingTranscriptionSaved: example: event_type: call.recording.transcription.saved id: 898e96ef-be63-45aa-9e7d-01332bff9a97 occurred_at: '2025-02-19T17:02:49.371454Z' payload: call_control_id: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg call_leg_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 call_session_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 calling_party_type: pstn client_state: aGF2ZSBhIG5pY2UgZGF5ID1d connection_id: 7267xxxxxxxxxxxxxx recording_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 recording_transcription_id: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 status: completed transcription_text: Hi! record_type: event properties: event_type: description: The type of event being delivered. enum: - call.recording.transcription.saved example: call.recording.transcription.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_control_id: description: Call ID used to issue commands via Call Control API. example: v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg 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. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call. example: 428c31b6-abf3-3bc1-b7f4-5013ef9657c1 type: string calling_party_type: description: The type of calling party connection. enum: - pstn - sip example: pstn 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 recording_id: description: ID that is unique to the recording session and can be used to correlate webhook events. example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 type: string recording_transcription_id: description: ID that is unique to the transcription process and can be used to correlate webhook events. example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 type: string status: description: The transcription status. enum: - completed example: completed type: string transcription_text: description: The transcribed text example: Hi! type: string type: object record_type: description: Identifies the type of the resource. enum: - event example: event type: string title: Call Recording Transcription Saved type: object callRecordingTranscriptionSavedEvent: properties: data: $ref: '#/components/schemas/callRecordingTranscriptionSaved' title: Call Recording Transcription Saved Event type: object charges_Error: properties: code: format: integer 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 charges_Errors: properties: errors: items: $ref: '#/components/schemas/charges_Error' type: array cloudflare-ip-list-sync_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object cloudflare-ip-list-sync_Errors: properties: errors: items: $ref: '#/components/schemas/cloudflare-ip-list-sync_Error' type: array type: object cloudflare-ip-list-sync_PaginationMeta: properties: page_number: type: integer page_size: type: integer total_pages: type: integer total_results: type: integer required: - page_number - page_size - total_pages - total_results title: PaginationMeta type: object connections_IntId: description: Uniquely identifies the resource. example: '1293384261075731499' format: int64 title: Int ID type: string connections_OutboundVoiceProfileId: description: Identifies the associated outbound voice profile. example: '1293384261075731499' format: int64 title: Outbound Voice Profile ID type: string connections_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 title: Pagination Meta type: object 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 customer_service_record_ResourceNotFoundError: allOf: - $ref: '#/components/schemas/GenericError' - properties: code: example: '10005' type: string detail: example: The requested resource or URL could not be found. type: string meta: properties: url: example: https://developers.telnyx.com/docs/overview/errors/10005 type: string type: object title: example: Resource not found type: string type: object customer_service_record_UnprocessableEntityError: allOf: - $ref: '#/components/schemas/GenericError' - properties: code: example: '10002' type: string detail: example: The phone number is invalid. type: string meta: properties: url: example: https://developers.telnyx.com/docs/overview/errors/10002 type: string type: object source: properties: pointer: example: /phone_numbers type: string type: object title: example: Invalid phone number type: string type: object detail-records_PaginationMeta: properties: page_number: example: 2 format: int32 type: integer page_size: example: 25 format: int32 type: integer total_pages: example: 3 format: int32 type: integer total_results: example: 55 format: int32 type: integer type: object documents_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object documents_Errors: properties: errors: items: $ref: '#/components/schemas/documents_Error' type: array type: object emergency_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object emergency_Errors: properties: errors: items: $ref: '#/components/schemas/emergency_Error' type: array type: object extended_address: description: Additional street address information about the address such as, but not limited to, unit number or apartment number. example: 14th Floor type: string external-voice-integrations_Error: properties: code: example: '10015' format: int64 type: string detail: example: The value provided for the attribute is not valid. Check the value used and try again. type: string meta: properties: url: description: URL with additional information on the error. example: https://developers.telnyx.com/docs/overview/errors/10015 type: string type: object source: properties: parameter: description: Indicates which parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. example: /attribute format: json-pointer type: string type: object title: example: Invalid attribute type: string required: - code - title type: object external-voice-integrations_Errors: properties: errors: items: $ref: '#/components/schemas/external-voice-integrations_Error' type: array type: object external-voice-integrations_IntId: description: Uniquely identifies the resource. example: '1293384261075731499' format: int64 title: Int ID type: string external-voice-integrations_OutboundVoiceProfileId: description: Identifies the associated outbound voice profile. example: '1293384261075731499' format: int64 title: Outbound Voice Profile ID type: string external-voice-integrations_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 title: Pagination Meta type: object 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 type: object http_headers: description: List of headers, limited to 10kB. example: - - header_name - header_value items: items: type: string type: array type: array inference-embedding_Assistant: properties: created_at: format: date-time type: string description: type: string dynamic_variables: additionalProperties: true description: Map of dynamic variables and their values type: object dynamic_variables_webhook_url: description: If the dynamic_variables_webhook_url is set for the assistant, we will send a request at the start of the conversation. See our [guide](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) for more information. type: string enabled_features: items: $ref: '#/components/schemas/EnabledFeatures' title: Enabled Features type: array uniqueItems: true greeting: description: Text that the assistant will use to start the conversation. This may be templated with [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) type: string id: type: string import_metadata: $ref: '#/components/schemas/ImportMetadata' insight_settings: $ref: '#/components/schemas/InsightSettings' instructions: description: System instructions for the assistant. These may be templated with [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables) type: string llm_api_key_ref: description: 'This is only needed when using third-party inference providers. The `identifier` for an integration secret [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) that refers to your LLM provider''s API key. Warning: Free plans are unlikely to work with this integration.' type: string messaging_settings: $ref: '#/components/schemas/MessagingSettings' model: description: ID of the model to use. You can use the [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get) to see all of your available models, type: string name: type: string privacy_settings: $ref: '#/components/schemas/PrivacySettings' telephony_settings: $ref: '#/components/schemas/TelephonySettings' tools: $ref: '#/components/schemas/AssistantTools' transcription: $ref: '#/components/schemas/TranscriptionSettings' voice_settings: $ref: '#/components/schemas/VoiceSettings' required: - id - name - created_at - model - instructions type: object inference-embedding_BucketIds: properties: bucket_ids: description: List of [embedded storage buckets](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding) to use for retrieval-augmented generation. items: type: string type: array max_num_results: description: The maximum number of results to retrieve as context for the language model. type: integer required: - bucket_ids title: BucketIds type: object inference-embedding_TransferToolParams: properties: custom_headers: description: Custom headers to be added to the SIP INVITE for the transfer command. items: properties: name: type: string value: description: The value of the header. Note that we support mustache templating for the value. For example you can use `{{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of the integration secret. type: string type: object type: array from: description: Number or SIP URI placing the call. example: '+35319605860' type: string targets: description: The different possible targets of the transfer. The assistant will be able to choose one of the targets to transfer the call to. items: properties: name: description: The name of the target. example: Support type: string to: description: The destination number or SIP URI of the call. example: '+13129457420' type: string type: object type: array required: - targets - from title: TransferToolParams type: object inference-embedding_WebhookToolParams: properties: body_parameters: description: The body parameters the webhook tool accepts, described as a JSON Schema object. These parameters will be passed to the webhook as the body of the request. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format example: properties: age: description: The age of the customer. type: integer location: description: The location of the customer. type: string required: - age - location type: object properties: properties: additionalProperties: true description: The properties of the body parameters. type: object required: description: The required properties of the body parameters. items: type: string type: array type: enum: - object type: string type: object description: description: The description of the tool. type: string headers: description: The headers to be sent to the external tool. items: properties: name: type: string value: description: The value of the header. Note that we support mustache templating for the value. For example you can use `Bearer {{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of the integration secret as the bearer token. [Telnyx signature headers](https://developers.telnyx.com/docs/voice/programmable-voice/voice-api-webhooks) will be automatically added to the request. type: string type: object type: array method: default: POST description: The HTTP method to be used when calling the external tool. enum: - GET - POST - PUT - DELETE - PATCH type: string name: description: The name of the tool. type: string path_parameters: description: The path parameters the webhook tool accepts, described as a JSON Schema object. These parameters will be passed to the webhook as the path of the request if the URL contains a placeholder for a value. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format example: properties: id: description: The id of the customer. type: string required: - id type: object properties: properties: additionalProperties: true description: The properties of the path parameters. type: object required: description: The required properties of the path parameters. items: type: string type: array type: enum: - object type: string type: object query_parameters: description: The query parameters the webhook tool accepts, described as a JSON Schema object. These parameters will be passed to the webhook as the query of the request. See the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format example: properties: page: description: The page number. type: integer required: - page type: object properties: properties: additionalProperties: true description: The properties of the query parameters. type: object required: description: The required properties of the query parameters. items: type: string type: array type: enum: - object type: string type: object url: description: 'The URL of the external tool to be called. This URL is going to be used by the assistant. The URL can be templated like: `https://example.com/api/v1/{id}`, where `{id}` is a placeholder for a value that will be provided by the assistant if `path_parameters` are provided with the `id` attribute.' example: https://example.com/api/v1/function type: string required: - url - name - description title: WebhookToolParams type: object integration-secrets_Error: properties: code: title: Telnyx error code type: string detail: title: Error details type: string title: title: Error title type: string required: - detail title: Error type: object integration-secrets_ErrorResponse: properties: errors: items: $ref: '#/components/schemas/integration-secrets_Error' title: Errors type: array title: ErrorResponse type: object integration-secrets_Metadata: properties: page_number: example: 1 title: Page Number type: integer page_size: example: 25 title: Page Size type: integer total_pages: example: 10 title: Total Pages type: integer total_results: example: 250 title: Total Items type: integer required: - page_size - page_number - total_pages - total_results title: Metadata type: object invoice_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object invoice_Errors: properties: errors: items: $ref: '#/components/schemas/invoice_Error' type: array type: object 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: Austin type: string media-storage_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object media-storage_Errors: properties: errors: items: $ref: '#/components/schemas/media-storage_Error' type: array type: object media-streaming_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object media-streaming_Errors: properties: errors: items: $ref: '#/components/schemas/media-streaming_Error' type: array type: object messaging_Error: properties: code: format: integer 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 messaging_Errors: properties: errors: items: $ref: '#/components/schemas/messaging_Error' type: array 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 netapps_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object netapps_Errors: properties: errors: items: $ref: '#/components/schemas/netapps_Error' type: array type: object netapps_Location: properties: code: description: Location code. example: chicago-il type: string name: description: Human readable name of location. example: Chicago IL, US type: string pop: description: Point of presence of location. example: CH1 type: string region: description: Identifies the geographical region of location. example: AMER type: string site: description: Site of location. example: ORD type: string title: Location type: object netapps_Region: properties: code: description: A code for the region. example: ashburn-va type: string 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 name: description: A name for the region. example: Ashburn type: string record_type: description: Identifies the type of the resource. example: region readOnly: true type: string supported_interfaces: description: List of interface types supported in this region. items: example: wireguard_interface 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: Region type: object notifications_Error: properties: code: format: int64 type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. format: json-pointer type: string type: object title: type: string required: - code - title type: object notifications_Errors: properties: errors: items: $ref: '#/components/schemas/notifications_Error' type: array type: object number-lookup_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object number-lookup_Errors: properties: errors: items: $ref: '#/components/schemas/number-lookup_Error' type: array type: object numbers_Error: properties: code: example: '10007' type: string detail: example: An unexpected error occured. type: string meta: properties: url: description: URL with additional information on the error. example: https://developers.telnyx.com/docs/overview/errors/10015 type: string type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. example: /base type: string type: object title: example: Unexpected error type: string required: - code - title type: object numbers_Errors: properties: errors: items: $ref: '#/components/schemas/numbers_Error' type: array type: object numbers_IntId: description: Identifies the resource. example: '1293384261075731499' readOnly: true type: string numbers_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 oauth_Error: properties: error: description: Error code type: string error_description: description: Human-readable error description type: string required: - error type: object oauth_PaginationMeta: properties: page_number: description: Current page number type: integer page_size: description: Number of items per page type: integer total_pages: description: Total number of pages type: integer total_results: description: Total number of results type: integer type: object organization_id: description: The id from the Organization the authentication provider belongs to. example: 24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7 format: uuid type: string payment_Error: properties: code: example: '10007' format: integer type: string detail: example: An unexpected error occurred. type: string source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. example: /base format: json-pointer type: string type: object title: example: Unexpected error type: string required: - code - title payment_Errors: properties: errors: items: $ref: '#/components/schemas/payment_Error' type: array phone_number: description: The phone number associated with the address. example: '+12125559000' type: string portability-check_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object portability-check_Errors: properties: errors: items: $ref: '#/components/schemas/portability-check_Error' type: array type: object postal_code: description: The postal code of the address. example: '78701' type: string programmable-fax_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object programmable-fax_Errors: properties: errors: items: $ref: '#/components/schemas/programmable-fax_Error' type: array type: object programmable-fax_RecordType: description: Identifies the type of the resource. enum: - event example: event type: string push-notifications_Error: properties: code: example: 10015 type: string detail: example: has already been taken type: string meta: additionalProperties: true example: url: https://developers.telnyx.com/docs/overview/errors/10015 type: object source: properties: parameter: description: Indicates which query parameter caused the error. example: application_name type: string pointer: description: JSON pointer (RFC6901) to the offending entity. example: /mobile_push_credentials type: string type: object title: example: Bad Request type: string required: - code - title type: object push-notifications_Errors: properties: errors: items: $ref: '#/components/schemas/push-notifications_Error' type: array type: object reporting_PaginationMeta: properties: page_number: example: 2 format: int32 type: integer page_size: example: 25 format: int32 type: integer total_pages: example: 3 format: int32 type: integer total_results: example: 55 format: int32 type: integer type: object 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 format: uri 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 format: uri 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 format: uri 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 siprec_Error: properties: code: format: int32 type: integer detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object siprec_Errors: properties: errors: items: $ref: '#/components/schemas/siprec_Error' type: array type: object skip_address_verification: default: false description: An optional boolean value specifying if verification of the address should be skipped or not. UserAddresses are generally used for shipping addresses, and failure to validate your shipping address will likely result in a failure to deliver SIM cards or other items ordered from Telnyx. Do not use this parameter unless you are sure that the address is correct even though it cannot be validated. If this is set to any value other than true, verification of the address will be attempted, and the user address will not be allowed if verification fails. If verification fails but suggested values are available that might make the address correct, they will be present in the response as well. If this value is set to true, then the verification will not be attempted. Defaults to false (verification will be performed). type: string street_address: description: The primary street address information about the address. example: 600 Congress Avenue type: string toll-free-verification_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object toll-free-verification_Errors: properties: errors: items: $ref: '#/components/schemas/toll-free-verification_Error' type: array type: object usage-reports_ErrorResponse: properties: errors: items: $ref: '#/components/schemas/ErrorRecord' type: array type: object usage-reports_RecordType: description: An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records properties: product_dimensions: description: Telnyx Product Dimensions example: '[''direction'', ''currency'', ''message_type'']' items: type: string type: array product_metrics: description: Telnyx Product Metrics example: '[''cost'', ''billed_sec'']' items: type: string type: array record_type: description: Telnyx Product type example: conversation_event type: string type: object user-addresses_Error: example: code: '20207' description: The street address provided is invalid. source: pointer: /street_address title: Invalid street address properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object user-addresses_Errors: properties: errors: items: $ref: '#/components/schemas/user-addresses_Error' type: array type: object user-addresses_administrative_area: description: The locality of the user address. For US addresses, this corresponds to the state of the address. example: TX type: string user-addresses_borough: description: The borough of the user address. This field is not used for addresses in the US but is used for some international addresses. example: Guadalajara type: string user-addresses_business_name: description: The business name associated with the user address. example: Toy-O'Kon type: string user-addresses_country_code: description: The two-character (ISO 3166-1 alpha-2) country code of the user address. example: US type: string user-addresses_extended_address: description: Additional street address information about the user address such as, but not limited to, unit number or apartment number. example: 14th Floor type: string user-addresses_first_name: description: The first name associated with the user address. example: Alfred type: string user-addresses_last_name: description: The last name associated with the user address. example: Foster type: string user-addresses_locality: description: The locality of the user address. For US addresses, this corresponds to the city of the address. example: Austin type: string user-addresses_neighborhood: description: The neighborhood of the user 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 user-addresses_phone_number: description: The phone number associated with the user address. example: '+12125559000' type: string user-addresses_postal_code: description: The postal code of the user address. example: '78701' type: string user-addresses_street_address: description: The primary street address information about the user address. example: 600 Congress Avenue 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 verified-numbers_Error: properties: code: type: string detail: type: string meta: properties: url: description: URL with additional information on the error. type: string type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object verified-numbers_Errors: properties: errors: items: $ref: '#/components/schemas/verified-numbers_Error' type: array type: object verified-numbers_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 verify_Error: properties: code: example: '10015' type: string detail: example: The value provided for sorting is not valid. Check the value used and try again. type: string meta: properties: url: description: URL with additional information on the error. example: https://developers.telnyx.com/docs/overview/errors/10015 type: string type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. example: /sort type: string type: object title: example: Invalid sorting value type: string required: - code - title type: object verify_Errors: properties: errors: items: $ref: '#/components/schemas/verify_Error' type: array type: object verify_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 video_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object video_Errors: properties: errors: items: $ref: '#/components/schemas/video_Error' type: array type: object voice-channels_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object voice-channels_Errors: properties: errors: items: $ref: '#/components/schemas/voice-channels_Error' type: array type: object voicemail_Error: properties: code: example: '10007' type: string detail: example: An unexpected error occurred. type: string source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. example: /base type: string type: object title: example: Unexpected error type: string required: - code - title type: object voicemail_Errors: properties: errors: items: $ref: '#/components/schemas/voicemail_Error' type: array type: object 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. 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 webhooks_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 wireless-public_PaginationMeta: properties: page_number: example: 2 format: int32 type: integer page_size: example: 25 format: int32 type: integer total_pages: example: 3 format: int32 type: integer total_results: example: 55 format: int32 type: integer type: object wireless_CreatedAt: description: ISO 8601 formatted date-time indicating when the resource was created. example: '2018-02-02T22:25:27.521Z' readOnly: true type: string wireless_Error: properties: code: type: string detail: type: string meta: additionalProperties: true type: object source: properties: parameter: description: Indicates which query parameter caused the error. type: string pointer: description: JSON pointer (RFC6901) to the offending entity. type: string type: object title: type: string required: - code - title type: object wireless_Errors: properties: errors: items: $ref: '#/components/schemas/wireless_Error' type: array type: object wireless_Id: description: Identifies the resource. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid readOnly: true type: string wireless_Region: properties: code: description: The unique code of the region. example: dc2 type: string inserted_at: description: Timestamp when the region was inserted. format: date-time type: string name: description: The name of the region. example: Washington DC, US type: string updated_at: description: Timestamp when the region was last updated. format: date-time type: string required: - code - name title: Region type: object wireless_UpdatedAt: description: ISO 8601 formatted date-time indicating when the resource was updated. example: '2018-02-02T22:25:27.521Z' readOnly: true type: string securitySchemes: 10dlc_bearerAuth: bearerFormat: JWT scheme: bearer type: http bearerAuth: scheme: bearer type: http oauthClientAuth: description: OAuth client credentials (client_id:client_secret) via HTTP Basic Auth, or client credentials in request body for public clients scheme: basic type: http info: contact: email: support@telnyx.com description: SIP trunking, SMS, MMS, Call Control and Telephony Data Services. title: Telnyx API version: 2.0.0 x-endpoint-cost: light openapi: 3.1.0 paths: /: get: description: List all Buckets. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html operationId: ListBuckets responses: '200': content: application/xml: schema: $ref: '#/components/schemas/ListBucketsResponse' description: Success '401': description: Unauthorized summary: ListBuckets tags: - Bucket x-latency-category: responsive /.well-known/oauth-authorization-server: get: description: OAuth 2.0 Authorization Server Metadata (RFC 8414) responses: '200': content: application/json: schema: $ref: '#/components/schemas/AuthorizationServerMetadata' description: Authorization server metadata security: [] summary: Authorization server metadata tags: - OAuth Discovery x-latency-category: responsive servers: - url: https://api.telnyx.com /.well-known/oauth-protected-resource: get: description: OAuth 2.0 Protected Resource Metadata for resource discovery responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResourceMetadata' description: Protected resource metadata security: [] summary: Protected resource metadata tags: - OAuth Discovery x-latency-category: responsive servers: - url: https://api.telnyx.com /access_ip_address: get: operationId: ListAccessIpAddresses parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[ip_source], filter[ip_address], filter[created_at]. Supports complex bracket operations for dynamic filtering.' examples: Complex filtering example: summary: 'Combine multiple filters: cloudflare source IPs created within 2023' value: created_at: gt: '2023-01-01T00:00:00Z' lt: '2023-12-31T23:59:59Z' ip_source: cloudflare filter[created_at][gt]=2023-01-01T00:00:00Z: summary: Filter IP addresses created after the specified date-time value: created_at: gt: '2023-01-01T00:00:00Z' filter[created_at][lt]=2023-12-31T23:59:59Z: summary: Filter IP addresses created before the specified date-time value: created_at: lt: '2023-12-31T23:59:59Z' filter[ip_address]=192.168.1.1: summary: Filter by specific IP address value: ip_address: 192.168.1.1 filter[ip_source]=cloudflare: summary: Filter access IP addresses by source 'cloudflare' value: ip_source: cloudflare explode: true in: query name: filter schema: additionalProperties: true properties: created_at: oneOf: - description: Filter by exact creation date-time format: date-time type: string - additionalProperties: false description: Date range filtering operations properties: gt: description: Filter for creation date-time greater than format: date-time type: string gte: description: Filter for creation date-time greater than or equal to format: date-time type: string lt: description: Filter for creation date-time less than format: date-time type: string lte: description: Filter for creation date-time less than or equal to format: date-time type: string title: DateRangeFilter type: object ip_address: description: Filter by IP address type: string ip_source: description: Filter by IP source type: string type: object style: deepObject - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' examples: page[number]=1&page[size]=20: summary: Default pagination with first page and 20 records per page value: number: 1 size: 20 page[number]=1&page[size]=50: summary: First page with 50 records per page value: number: 1 size: 50 page[number]=2&page[size]=20: summary: Second page with 20 records per page value: number: 2 size: 20 page[number]=5&page[size]=100: summary: Fifth page with 100 records per page value: number: 5 size: 100 explode: true in: query name: page schema: properties: number: default: 1 type: integer size: default: 20 maximum: 250 type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessIPAddressListResponseSchema' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/cloudflare-ip-list-sync_Errors' description: Validation Error summary: List all Access IP Addresses tags: - IP Addresses x-latency-category: responsive post: operationId: CreateAccessIpAddress requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessIPAddressPOST' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessIPAddressResponseSchema' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/cloudflare-ip-list-sync_Errors' description: Validation Error summary: Create new Access IP Address tags: - IP Addresses x-latency-category: responsive /access_ip_address/{access_ip_address_id}: delete: operationId: DeleteAccessIpAddress parameters: - in: path name: access_ip_address_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessIPAddressResponseSchema' description: Successful Response summary: Delete access IP address tags: - IP Addresses x-latency-category: responsive get: operationId: GetAccessIpAddress parameters: - in: path name: access_ip_address_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessIPAddressResponseSchema' description: Successful Response summary: Retrieve an access IP address tags: - IP Addresses x-latency-category: responsive /access_ip_ranges: get: operationId: ListAccessIpRanges parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[cidr_block], filter[cidr_block][startswith], filter[cidr_block][endswith], filter[cidr_block][contains], filter[created_at]. Supports complex bracket operations for dynamic filtering.' examples: Complex filtering example: summary: 'Combine multiple filters: CIDR blocks starting with ''10.0'' and ending with ''/16'', created within 2023' value: cidr_block: endswith: /16 startswith: '10.0' created_at: gt: '2023-01-01T00:00:00Z' lt: '2023-12-31T23:59:59Z' filter[cidr_block]=192.168.1.0/24: summary: Filter by exact CIDR block match value: cidr_block: 192.168.1.0/24 filter[cidr_block][contains]=10.0: summary: Filter CIDR blocks containing '10.0' value: cidr_block: contains: '10.0' filter[cidr_block][endswith]=/24: summary: Filter CIDR blocks ending with '/24' value: cidr_block: endswith: /24 filter[cidr_block][startswith]=192.168: summary: Filter CIDR blocks starting with '192.168' value: cidr_block: startswith: '192.168' filter[created_at][gt]=2023-01-01T00:00:00Z: summary: Filter IP ranges created after the specified date-time value: created_at: gt: '2023-01-01T00:00:00Z' filter[created_at][lt]=2023-12-31T23:59:59Z: summary: Filter IP ranges created before the specified date-time value: created_at: lt: '2023-12-31T23:59:59Z' explode: true in: query name: filter schema: additionalProperties: true properties: cidr_block: oneOf: - description: Filter by exact CIDR block match type: string - additionalProperties: false description: CIDR block pattern matching operations properties: contains: description: Filter CIDR blocks containing the specified string type: string endswith: description: Filter CIDR blocks ending with the specified string type: string startswith: description: Filter CIDR blocks starting with the specified string type: string title: CidrBlockPatternFilter type: object created_at: oneOf: - description: Filter by exact creation date-time format: date-time type: string - additionalProperties: false description: Date range filtering operations properties: gt: description: Filter for creation date-time greater than format: date-time type: string gte: description: Filter for creation date-time greater than or equal to format: date-time type: string lt: description: Filter for creation date-time less than format: date-time type: string lte: description: Filter for creation date-time less than or equal to format: date-time type: string title: DateRangeFilter type: object type: object style: deepObject - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' examples: page[number]=1&page[size]=20: summary: Default pagination with first page and 20 records per page value: number: 1 size: 20 page[number]=1&page[size]=50: summary: First page with 50 records per page value: number: 1 size: 50 page[number]=2&page[size]=20: summary: Second page with 20 records per page value: number: 2 size: 20 page[number]=5&page[size]=100: summary: Fifth page with 100 records per page value: number: 5 size: 100 explode: true in: query name: page schema: properties: number: default: 1 type: integer size: default: 20 maximum: 250 type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessIPRangeListResponseSchema' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/cloudflare-ip-list-sync_Errors' description: Validation Error summary: List all Access IP Ranges tags: - IP Ranges x-latency-category: responsive post: operationId: CreateAccessIPRange requestBody: content: application/json: schema: $ref: '#/components/schemas/AccessIPRangePOST' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessIPRangeResponseSchema' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/cloudflare-ip-list-sync_Errors' description: Validation Error summary: Create new Access IP Range tags: - IP Ranges x-latency-category: responsive /access_ip_ranges/{access_ip_range_id}: delete: parameters: - in: path name: access_ip_range_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccessIPRangeResponseSchema' description: Successful Response summary: Delete access IP ranges tags: - IP Ranges x-latency-category: responsive /actions/purchase/esims: post: description: 'Purchases and registers the specified amount of eSIMs to the current user''s account.<br/><br/> If <code>sim_card_group_id</code> is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used.<br/><br/> ' operationId: PurchaseESim requestBody: content: application/json: schema: $ref: '#/components/schemas/ESimPurchase' required: true responses: '202': $ref: '#/components/responses/RegisterSimCardsResponse' '401': description: Unauthorized summary: Purchase eSIMs 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: RegisterSimCards requestBody: content: application/json: schema: $ref: '#/components/schemas/SIMCardRegistration' required: true responses: '202': $ref: '#/components/responses/RegisterSimCardsResponse' '401': description: Unauthorized summary: Register SIM cards tags: - SIM Cards x-latency-category: background /addresses: get: description: Returns a list of your addresses. operationId: FindAddresses parameters: - $ref: '#/components/parameters/PageConsolidated' - $ref: '#/components/parameters/FilterConsolidated' - $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 /addresses/{id}/actions/accept_suggestions: post: operationId: acceptAddressSuggestions parameters: - description: The UUID of the address that should be accepted. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AcceptSuggestionsRequest' required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddressSuggestionResponse' description: This address suggestion has already been accepted. '202': content: application/json: schema: $ref: '#/components/schemas/AddressSuggestionResponse' description: This address suggestion was accepted. The numbers associated to it will resume processing in the background. '404': content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundError' description: Address not found or not accessible by the user. summary: Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft. tags: - Addresses x-latency-category: responsive /advanced_orders: get: operationId: list_advanced_orders_v2 responses: '200': content: application/json: schema: $ref: '#/components/responses/ListAdvancedOrderResponse' description: Successful Response summary: List Advanced Orders tags: - Advanced Number Orders x-latency-category: responsive post: operationId: create_advanced_order_v2 requestBody: content: application/json: schema: $ref: '#/components/schemas/AdvancedOrderRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/responses/AdvancedOrderResponse' description: Successful Response summary: Create Advanced Order tags: - Advanced Number Orders x-latency-category: responsive /advanced_orders/{order_id}: get: operationId: get_advanced_order_v2 parameters: - in: path name: order_id required: true schema: format: uuid title: Order Id type: string responses: '200': content: application/json: schema: $ref: '#/components/responses/AdvancedOrderResponse' description: Successful Response summary: Get Advanced Order tags: - Advanced Number Orders x-latency-category: responsive patch: operationId: update_advanced_order_v2 parameters: - in: path name: order_id required: true schema: format: uuid title: Order Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AdvancedOrderRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/responses/AdvancedOrderResponse' description: Successful Response summary: Update Advanced Order tags: - Advanced Number Orders x-latency-category: responsive /ai/assistants: get: description: Retrieve a list of all AI Assistants configured by the user. operationId: get_assistants_public_assistants_get responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssistantsListData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List assistants tags: - Assistants x-latency-category: responsive post: description: Create a new AI Assistant. operationId: create_new_assistant_public_assistants_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAssistantRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inference-embedding_Assistant' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create an assistant tags: - Assistants x-latency-category: responsive /ai/assistants/import: post: description: Import assistants from external providers. Any assistant that has already been imported will be overwritten with its latest version from the importing provider. operationId: import_assistants_public_assistants_import_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportAssistantsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssistantsListData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Import assistants from external provider tags: - Assistants x-latency-category: responsive /ai/assistants/tests: get: description: Retrieves a paginated list of assistant tests with optional filtering capabilities operationId: get_assistant_tests_public_assistants_tests_get parameters: - description: Filter tests by test suite name in: query name: test_suite required: false schema: description: Filter tests by test suite name title: Test Suite type: string - description: Filter tests by communication channel (e.g., 'web_chat', 'sms') in: query name: telnyx_conversation_channel required: false schema: description: Filter tests by communication channel (e.g., 'web_chat', 'sms') title: Telnyx Conversation Channel type: string - description: Filter tests by destination (phone number, webhook URL, etc.) in: query name: destination required: false schema: description: Filter tests by destination (phone number, webhook URL, etc.) title: Destination type: string - description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: Page number to retrieve (1-based indexing) minimum: 1 title: Page[Number] type: integer size: default: 20 description: Number of tests to return per page (1-100) maximum: 100 minimum: 1 title: Page[Size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAssistantTestList' description: Returns paginated test list with metadata for navigation and filtering '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List assistant tests with pagination tags: - Assistants x-latency-category: responsive post: description: Creates a comprehensive test configuration for evaluating AI assistant performance operationId: create_assistant_test_public_assistants_tests_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAssistantTestRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/AssistantTestResponse' description: Returns the created test configuration with assigned test ID '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create a new assistant test tags: - Assistants x-latency-category: responsive /ai/assistants/tests/test-suites: get: description: Retrieves a list of all distinct test suite names available to the current user operationId: fetch_test_suites_public_assistants_tests_test_suites_get responses: '200': content: application/json: schema: $ref: '#/components/schemas/TestSuitesResponse' description: Returns an array of unique test suite names for filtering and organization '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get all test suite names tags: - Assistants x-latency-category: responsive /ai/assistants/tests/test-suites/{suite_name}/runs: get: description: Retrieves paginated history of test runs for a specific test suite with filtering options operationId: get_test_suite_runs_for_test_public_assistants_tests_test_suites__suite_name__runs_get parameters: - in: path name: suite_name required: true schema: title: Suite Name type: string - description: Filter runs by execution status (pending, running, completed, failed, timeout) in: query name: status required: false schema: description: Filter runs by execution status (pending, running, completed, failed, timeout) title: Status type: string - description: Filter runs by specific suite execution batch ID in: query name: test_suite_run_id required: false schema: description: Filter runs by specific suite execution batch ID title: Test Suite Run Id type: string - description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: Page number to retrieve (1-based indexing) minimum: 1 title: Page[Number] type: integer size: default: 20 description: Number of test runs to return per page (1-100) maximum: 100 minimum: 1 title: Page[Size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTestRunList' description: Returns paginated list of test runs within the specified suite '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get test suite run history tags: - Assistants x-latency-category: responsive post: description: Executes all tests within a specific test suite as a batch operation operationId: trigger_test_suite_runs_public_assistants_tests_test_suites__suite_name__runs_post parameters: - in: path name: suite_name required: true schema: title: Suite Name type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TriggerTestSuiteRunsRequest' title: Request responses: '201': content: application/json: schema: items: $ref: '#/components/schemas/TestRunResponse' title: Response Trigger Test Suite Runs Public Assistants Tests Test Suites Suite Name Runs Post type: array description: Returns array of created test runs for all tests in the suite '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Trigger test suite execution tags: - Assistants x-latency-category: responsive /ai/assistants/tests/{test_id}: delete: description: Permanently removes an assistant test and all associated data operationId: delete_assistant_test_public_assistants_tests__test_id__delete parameters: - in: path name: test_id required: true schema: title: Test Id type: string responses: '200': content: application/json: schema: {} description: Returns success status when test is successfully deleted '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete an assistant test tags: - Assistants x-latency-category: responsive get: description: Retrieves detailed information about a specific assistant test operationId: get_assistant_test_public_assistants_tests__test_id__get parameters: - in: path name: test_id required: true schema: title: Test Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssistantTestResponse' description: Returns complete test configuration including rubric, schedule, and metadata '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get assistant test by ID tags: - Assistants x-latency-category: responsive put: description: Updates an existing assistant test configuration with new settings operationId: update_assistant_test_public_assistants_tests__test_id__put parameters: - in: path name: test_id required: true schema: title: Test Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAssistantTestRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssistantTestResponse' description: Returns the updated test configuration with all changes applied '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update an assistant test tags: - Assistants x-latency-category: responsive /ai/assistants/tests/{test_id}/runs: get: description: Retrieves paginated execution history for a specific assistant test with filtering options operationId: get_test_runs_for_test_public_assistants_tests__test_id__runs_get parameters: - in: path name: test_id required: true schema: title: Test Id type: string - description: Filter runs by execution status (pending, running, completed, failed, timeout) in: query name: status required: false schema: description: Filter runs by execution status (pending, running, completed, failed, timeout) title: Status type: string - description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: Page number to retrieve (1-based indexing) minimum: 1 title: Page[Number] type: integer size: default: 20 description: Number of test runs to return per page (1-100) maximum: 100 minimum: 1 title: Page[Size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTestRunList' description: Returns paginated list of test runs for the specified test '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get test run history for a specific test tags: - Assistants x-latency-category: responsive post: description: Initiates immediate execution of a specific assistant test operationId: trigger_test_run_public_assistants_tests__test_id__runs_post parameters: - in: path name: test_id required: true schema: title: Test Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TriggerTestRunRequest' title: Request responses: '201': content: application/json: schema: $ref: '#/components/schemas/TestRunResponse' description: Returns the created test run with execution details and status '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Trigger a manual test run tags: - Assistants x-latency-category: responsive /ai/assistants/tests/{test_id}/runs/{run_id}: get: description: Retrieves detailed information about a specific test run execution operationId: get_test_run_public_assistants_tests__test_id__runs__run_id__get parameters: - in: path name: test_id required: true schema: title: Test Id type: string - in: path name: run_id required: true schema: title: Run Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TestRunResponse' description: Returns complete test run details including results, logs, and performance metrics '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get specific test run details tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}: delete: description: Delete an AI Assistant by `assistant_id`. operationId: delete_assistant_public_assistants__assistant_id__delete parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssistantDeletedResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete an assistant tags: - Assistants x-latency-category: responsive get: description: Retrieve an AI Assistant configuration by `assistant_id`. operationId: get_assistant_public_assistants__assistant_id__get parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: query name: fetch_dynamic_variables_from_webhook required: false schema: default: false title: Fetch Dynamic Variables From Webhook type: boolean - in: query name: from required: false schema: title: From type: string - in: query name: to required: false schema: title: To type: string - in: query name: call_control_id required: false schema: title: Call Control Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/inference-embedding_Assistant' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get an assistant tags: - Assistants x-latency-category: responsive post: description: Update an AI Assistant's attributes. operationId: update_assistant_public_assistants__assistant_id__post parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAssistantRequestWithPromotion' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update an assistant tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/canary-deploys: delete: description: 'Endpoint to delete a canary deploy configuration for an assistant. Removes all canary deploy configurations for the specified assistant.' operationId: delete_canary_deploy_assistants__assistant_id__canary_deploys_delete parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete Canary Deploy tags: - Assistants x-latency-category: responsive get: description: 'Endpoint to get a canary deploy configuration for an assistant. Retrieves the current canary deploy configuration with all version IDs and their traffic percentages for the specified assistant.' operationId: get_canary_deploy_assistants__assistant_id__canary_deploys_get parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CanaryDeployResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Canary Deploy tags: - Assistants x-latency-category: responsive post: description: 'Endpoint to create a canary deploy configuration for an assistant. Creates a new canary deploy configuration with multiple version IDs and their traffic percentages for A/B testing or gradual rollouts of assistant versions.' operationId: create_canary_deploy_assistants__assistant_id__canary_deploys_post parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CanaryDeployRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CanaryDeployResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create Canary Deploy tags: - Assistants x-latency-category: responsive put: description: "Endpoint to update a canary deploy configuration for an assistant.\n\ \nUpdates the existing canary deploy configuration with new version IDs and\ \ percentages.\n All old versions and percentages are replaces by new ones\ \ from this request." operationId: update_canary_deploy_assistants__assistant_id__canary_deploys_put parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CanaryDeployRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CanaryDeployResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update Canary Deploy tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/chat: post: description: This endpoint allows a client to send a chat message to a specific AI Assistant. The assistant processes the message and returns a relevant reply based on the current conversation context. Refer to the Conversation API to [create a conversation](https://developers.telnyx.com/api/inference/inference-embedding/create-new-conversation-public-conversations-post), [filter existing conversations](https://developers.telnyx.com/api/inference/inference-embedding/get-conversations-public-conversations-get), [fetch messages for a conversation](https://developers.telnyx.com/api/inference/inference-embedding/get-conversations-public-conversation-id-messages-get), and [manually add messages to a conversation](https://developers.telnyx.com/api/inference/inference-embedding/add-new-message). operationId: assistant_chat_public_assistants__assistant_id__chat_post parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssistantChatReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssistantChatResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Assistant Chat (BETA) tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/clone: post: description: Clone an existing assistant, excluding telephony and messaging settings. operationId: clone_assistant_public_assistants__assistant_id__clone_post parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/inference-embedding_Assistant' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Clone Assistant tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/scheduled_events: get: description: Get scheduled events for an assistant with pagination and filtering operationId: get_scheduled_events parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: query name: from_date required: false schema: format: date-time title: From Date type: string - in: query name: to_date required: false schema: format: date-time title: To Date type: string - in: query name: conversation_channel required: false schema: $ref: '#/components/schemas/ConversationChannelType' title: Conversation Channel - description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 minimum: 1 title: Page[Number] type: integer size: default: 20 maximum: 100 minimum: 1 title: Page[Size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedScheduledEventList' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List scheduled events tags: - Assistants x-latency-category: responsive post: description: Create a scheduled event for an assistant operationId: create_scheduled_event parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateScheduledEventRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ScheduledEventResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create a scheduled event tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/scheduled_events/{event_id}: delete: description: If the event is pending, this will cancel the event. Otherwise, this will simply remove the record of the event. operationId: delete_scheduled_event parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: path name: event_id required: true schema: title: Event Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete a scheduled event tags: - Assistants x-latency-category: responsive get: description: Retrieve a scheduled event by event ID operationId: get_scheduled_event parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: path name: event_id required: true schema: title: Event Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ScheduledEventResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get a scheduled event tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/texml: get: description: Get an assistant texml by `assistant_id`. operationId: get_assistant_texml_public_assistants__assistant_id__texml_get parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string responses: '200': content: application/json: schema: type: string description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get assistant texml tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/tools/{tool_id}/test: post: description: Test a webhook tool for an assistant operationId: test_assistant_tool_public_assistants__assistant_id__tools__tool_id__test_post parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: path name: tool_id required: true schema: title: Tool Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TestWebhookToolRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TestWebhookToolResponseData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Test Assistant Tool tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/versions: get: description: Retrieves all versions of a specific assistant with complete configuration and metadata operationId: get_assistant_versions_public_assistants__assistant_id__versions_get parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssistantsListData' description: Returns list of assistant versions ordered by creation date (newest first) '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get all versions of an assistant tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/versions/{version_id}: delete: description: Permanently removes a specific version of an assistant. Can not delete main version operationId: delete_assistant_version_public_assistants__assistant_id__versions__version_id__delete parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: path name: version_id required: true schema: title: Version Id type: string responses: '204': description: Returns HTTP 204 No Content on successful deletion '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete a specific assistant version tags: - Assistants x-latency-category: responsive get: description: Retrieves a specific version of an assistant by assistant_id and version_id operationId: get_assistant_version_public_assistants__assistant_id__versions__version_id__get parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: path name: version_id required: true schema: title: Version Id type: string - in: query name: include_mcp_servers required: false schema: type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/inference-embedding_Assistant' description: Returns the specific assistant version configuration '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get a specific assistant version tags: - Assistants x-latency-category: responsive post: description: Updates the configuration of a specific assistant version. Can not update main version operationId: update_assistant_version_public_assistants__assistant_id__versions__version_id__post parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: path name: version_id required: true schema: title: Version Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAssistantRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inference-embedding_Assistant' description: Returns the updated assistant version configuration '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update a specific assistant version tags: - Assistants x-latency-category: responsive /ai/assistants/{assistant_id}/versions/{version_id}/promote: post: description: Promotes a specific version to be the main/current version of the assistant. This will delete any existing canary deploy configuration and send all live production traffic to this version. operationId: promote_assistant_version_public_assistants__assistant_id__versions__version_id__promote_post parameters: - in: path name: assistant_id required: true schema: title: Assistant Id type: string - in: path name: version_id required: true schema: title: Version Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/inference-embedding_Assistant' description: Returns the promoted assistant configuration '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Promote an assistant version to main tags: - Assistants x-latency-category: responsive /ai/audio/transcriptions: post: description: Transcribe speech to text. This endpoint is consistent with the [OpenAI Transcription API](https://platform.openai.com/docs/api-reference/audio/createTranscription) and may be used with the OpenAI JS or Python SDK. operationId: audio_public_audio_transcriptions_post requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/AudioTranscriptionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/AudioTranscriptionResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Transcribe speech to text tags: - Audio x-latency-category: responsive /ai/chat/completions: post: description: Chat with a language model. This endpoint is consistent with the [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat) and may be used with the OpenAI JS or Python SDK. operationId: chat_public_chat_completions_post requestBody: content: application/json: example: messages: - content: You are a friendly chatbot. role: system - content: Hello, world! role: user schema: $ref: '#/components/schemas/ChatCompletionRequest' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create a chat completion tags: - Chat x-latency-category: responsive /ai/clusters: get: operationId: list_all_requested_clusters_public_text_clusters_get parameters: - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 0 title: Page[Number] type: integer size: default: 20 title: Page[Size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusteringRequestInfoData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List all clusters tags: - Clusters x-latency-category: responsive post: description: Starts a background task to compute how the data in an [embedded storage bucket](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding) is clustered. This helps identify common themes and patterns in the data. operationId: compute_new_cluster_public_text_clusters_post requestBody: content: application/json: schema: $ref: '#/components/schemas/PublicTextClusteringRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TextClusteringResponseData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Compute new clusters tags: - Clusters x-latency-category: responsive /ai/clusters/{task_id}: delete: operationId: delete_cluster_by_task_id_public_text_clusters__task_id__delete parameters: - in: path name: task_id required: true schema: title: Task Id type: string responses: '204': description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete a cluster tags: - Clusters x-latency-category: responsive get: operationId: fetch_cluster_by_task_id_public_text_clusters__task_id__get parameters: - in: path name: task_id required: true schema: title: Task Id type: string - description: The number of nodes in the cluster to return in the response. Nodes will be sorted by their centrality within the cluster. in: query name: top_n_nodes required: false schema: default: 0 title: Top N Nodes type: integer - description: Whether or not to include subclusters and their nodes in the response. in: query name: show_subclusters required: false schema: default: false title: Show Subclusters type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/ClusteringStatusResponseData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Fetch a cluster tags: - Clusters x-latency-category: responsive /ai/clusters/{task_id}/graph: get: operationId: fetch_cluster_image_by_task_id_public_text_clusters__task_id__image_get parameters: - in: path name: task_id required: true schema: title: Task Id type: string - in: query name: cluster_id required: false schema: title: Cluster Id type: integer responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Fetch a cluster visualization tags: - Clusters x-latency-category: responsive /ai/conversations: get: description: Retrieve a list of all AI conversations configured by the user. Supports [PostgREST-style query parameters](https://postgrest.org/en/stable/api.html#horizontal-filtering-rows) for filtering. Examples are included for the standard metadata fields, but you can filter on any field in the metadata JSON object. For example, to filter by a custom field `metadata->custom_field`, use `metadata->custom_field=eq.value`. operationId: get_conversations_public_conversations_get parameters: - description: Filter by conversation ID (e.g. id=eq.123) in: query name: id required: false schema: type: string - description: Filter by conversation Name (e.g. `name=like.Voice%`) in: query name: name required: false schema: type: string - description: Filter by creation datetime (e.g., `created_at=gte.2025-01-01`) in: query name: created_at required: false schema: type: string - description: Filter by last message datetime (e.g., `last_message_at=lte.2025-06-01`) in: query name: last_message_at required: false schema: type: string - description: Filter by assistant ID (e.g., `metadata->assistant_id=eq.assistant-123`) in: query name: metadata->assistant_id required: false schema: type: string - description: Filter by call control ID (e.g., `metadata->call_control_id=eq.v3:123`) in: query name: metadata->call_control_id required: false schema: type: string - description: Filter by the phone number, SIP URI, or other identifier for the agent (e.g., `metadata->telnyx_agent_target=eq.+13128675309`) in: query name: metadata->telnyx_agent_target required: false schema: type: string - description: Filter by the phone number, SIP URI, or other identifier for the end user (e.g., `metadata->telnyx_end_user_target=eq.+13128675309`) in: query name: metadata->telnyx_end_user_target required: false schema: type: string - description: Filter by conversation channel (e.g., `metadata->telnyx_conversation_channel=eq.phone_call`) in: query name: metadata->telnyx_conversation_channel required: false schema: type: string - description: Limit the number of returned conversations (e.g., `limit=10`) in: query name: limit required: false schema: minimum: 1 type: integer - description: Order the results by specific fields (e.g., `order=created_at.desc` or `order=last_message_at.asc`) in: query name: order required: false schema: type: string - description: Apply OR conditions using PostgREST syntax (e.g., `or=(created_at.gte.2025-04-01,last_message_at.gte.2025-04-01)`) in: query name: or required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConversationsListData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List conversations tags: - Conversations x-latency-category: responsive post: description: Create a new AI Conversation. operationId: create_new_conversation_public_conversations_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConversationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Conversation' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create a conversation tags: - Conversations x-latency-category: responsive /ai/conversations/insight-groups: get: description: Get all insight groups operationId: get_all_insight_groups parameters: - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: Page number (0-based) minimum: 1 title: Page[Number] type: integer size: default: 20 description: Number of items per page exclusiveMinimum: true maximum: 100 minimum: 0 title: Page[Size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetInsightTemplateGroupsRespData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Insight Template Groups tags: - Conversations x-latency-category: responsive post: description: Create a new insight group operationId: create_insight_group requestBody: content: application/json: schema: $ref: '#/components/schemas/InsightTemplateGroupCreateReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InsightTemplateGroupDetailRespData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create Insight Template Group tags: - Conversations x-latency-category: responsive /ai/conversations/insight-groups/{group_id}: delete: description: Delete insight group by ID operationId: delete_insight_group_by_id parameters: - description: The ID of the insight group in: path name: group_id required: true schema: description: The ID of the insight group format: uuid title: Group Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete Insight Template Group tags: - Conversations x-latency-category: responsive get: description: Get insight group by ID operationId: get_insight_group_by_id parameters: - description: The ID of the insight group in: path name: group_id required: true schema: description: The ID of the insight group format: uuid title: Group Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/InsightTemplateGroupDetailRespData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Insight Template Group tags: - Conversations x-latency-category: responsive put: description: Update an insight template group operationId: update_insight_group_by_id parameters: - description: The ID of the insight group in: path name: group_id required: true schema: description: The ID of the insight group format: uuid title: Group Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InsightTemplateGroupUpdateReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InsightTemplateGroupDetailRespData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update Insight Template Group tags: - Conversations x-latency-category: responsive /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign: post: description: Assign an insight to a group operationId: assign_insight_to_group parameters: - description: The ID of the insight group in: path name: group_id required: true schema: description: The ID of the insight group format: uuid title: Group Id type: string - description: The ID of the insight in: path name: insight_id required: true schema: description: The ID of the insight format: uuid title: Insight Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Assign Insight Template To Group tags: - Conversations x-latency-category: responsive /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign: delete: description: Remove an insight from a group operationId: unassign_insight_from_group parameters: - description: The ID of the insight group in: path name: group_id required: true schema: description: The ID of the insight group format: uuid title: Group Id type: string - description: The ID of the insight in: path name: insight_id required: true schema: description: The ID of the insight format: uuid title: Insight Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Unassign Insight Template From Group tags: - Conversations x-latency-category: responsive /ai/conversations/insights: get: description: Get all insights operationId: get_all_insights parameters: - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: Page number (0-based) minimum: 1 title: Page[Number] type: integer size: default: 20 description: Number of items per page exclusiveMinimum: true maximum: 100 minimum: 0 title: Page[Size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetInsightTemplatesRespData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Insight Templates tags: - Conversations x-latency-category: responsive post: description: Create a new insight operationId: create_insight requestBody: content: application/json: schema: $ref: '#/components/schemas/InsightTemplateCreateReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InsightTemplateDetailRespData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create Insight Template tags: - Conversations x-latency-category: responsive /ai/conversations/insights/{insight_id}: delete: description: Delete insight by ID operationId: delete_insight_by_id parameters: - description: The ID of the insight in: path name: insight_id required: true schema: description: The ID of the insight format: uuid title: Insight Id type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete Insight Template tags: - Conversations x-latency-category: responsive get: description: Get insight by ID operationId: get_insight_by_id parameters: - description: The ID of the insight in: path name: insight_id required: true schema: description: The ID of the insight format: uuid title: Insight Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/InsightTemplateDetailRespData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Insight Template tags: - Conversations x-latency-category: responsive put: description: Update an insight template operationId: update_insight_by_id parameters: - description: The ID of the insight in: path name: insight_id required: true schema: description: The ID of the insight format: uuid title: Insight Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/InsightTemplateUpdateReq' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/InsightTemplateDetailRespData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update Insight Template tags: - Conversations x-latency-category: responsive /ai/conversations/{conversation_id}: delete: description: Delete a specific conversation by its ID. operationId: delete_conversation_by_id_public_conversations_delete parameters: - description: The ID of the conversation to delete in: path name: conversation_id required: true schema: type: string responses: '200': description: Successful Response '404': description: Conversation Not Found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete a conversation tags: - Conversations x-latency-category: responsive get: description: Retrieve a specific AI conversation by its ID. operationId: get_conversation_by_id_public_conversations_get parameters: - description: The ID of the conversation to retrieve in: path name: conversation_id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/Conversation' description: Successful Response '404': description: Conversation Not Found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get a conversation tags: - Conversations x-latency-category: responsive put: description: Update metadata for a specific conversation. operationId: update_conversation_by_id_public_conversations_put parameters: - description: The ID of the conversation to update in: path name: conversation_id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConversationRequest' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/Conversation' description: Successful Update '404': description: Conversation Not Found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update conversation metadata tags: - Conversations x-latency-category: responsive /ai/conversations/{conversation_id}/conversations-insights: get: description: Retrieve insights for a specific conversation operationId: get_conversations_public__conversation_id__insights_get parameters: - in: path name: conversation_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConversationInsightListData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get insights for a conversation tags: - Conversations x-latency-category: responsive /ai/conversations/{conversation_id}/messages: get: description: Retrieve messages for a specific conversation, including tool calls made by the assistant. operationId: get_conversations_public__conversation_id__messages_get parameters: - in: path name: conversation_id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConversationMessageListData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get conversation messages tags: - Conversations x-latency-category: responsive post: description: Add a new message to the conversation. Used to insert a new messages to a conversation manually ( without using chat endpoint ) operationId: add_new_message parameters: - description: The ID of the conversation in: path name: conversation_id required: true schema: description: The ID of the conversation format: uuid title: Conversation Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMsgReq' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create Message tags: - Conversations x-latency-category: responsive /ai/embeddings: get: description: Retrieve tasks for the user that are either `queued`, `processing`, `failed`, `success` or `partial_success` based on the query string. Defaults to `queued` and `processing`. operationId: GetTasksByStatus parameters: - description: List of task statuses i.e. `status=queued&status=processing` in: query name: status required: false schema: default: - processing - queued description: List of task statuses i.e. `status=queued&status=processing` items: type: string title: Status type: array responses: '200': content: application/json: schema: $ref: '#/components/schemas/BackgroundTasksQueryResponseData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Tasks by Status tags: - Embeddings x-latency-category: responsive post: description: "Perform embedding on a Telnyx Storage Bucket using the a embedding\ \ model.\nThe current supported file types are:\n- PDF\n- HTML\n- txt/unstructured\ \ text files\n- json\n- csv\n- audio / video (mp3, mp4, mpeg, mpga, m4a, wav,\ \ or webm ) - Max of 100mb file size.\n\nAny files not matching the above\ \ types will be attempted to be embedded as unstructured text.\n\nThis process\ \ can be slow, so it runs in the background and the user can check\nthe status\ \ of the task using the endpoint `/ai/embeddings/{task_id}`.\n\n **Important\ \ Note**: When you update documents in a Telnyx Storage bucket, their associated\ \ embeddings are automatically kept up to date. If you add or update a file,\ \ it is automatically embedded. If you delete a file, the embeddings are deleted\ \ for that particular file.\n\nYou can also specify a custom `loader` param.\ \ Currently the only supported loader value is\n`intercom` which loads Intercom\ \ article jsons as specified by [the Intercom article API](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/Articles/article/)\n\ This loader will split each article into paragraphs and save additional parameters\ \ relevant to Intercom docs, such as\n`article_url` and `heading`. These values\ \ will be returned by the `/v2/ai/embeddings/similarity-search` endpoint in\ \ the `loader_metadata` field." operationId: PostEmbedding requestBody: content: application/json: schema: $ref: '#/components/schemas/EmbeddingBucketRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmbeddingResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Embed documents tags: - Embeddings x-latency-category: responsive /ai/embeddings/buckets: get: description: Get all embedding buckets for a user. operationId: GetEmbeddingBuckets responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserEmbeddedBucketsData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List embedded buckets tags: - Embeddings x-latency-category: responsive /ai/embeddings/buckets/{bucket_name}: delete: description: Deletes an entire bucket's embeddings and disables the bucket for AI-use, returning it to normal storage pricing. operationId: embedding_bucket_files_public_embedding_buckets__bucket_name__delete parameters: - in: path name: bucket_name required: true schema: title: Bucket Name type: string responses: '200': description: Bucket Embeddings Deleted Successfully '404': content: application/json: schema: $ref: '#/components/schemas/BucketNotFoundError' description: Bucket Not Found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Disable AI for an Embedded Bucket tags: - Embeddings x-latency-category: responsive get: description: Get all embedded files for a given user bucket, including their processing status. operationId: GetBucketName parameters: - in: path name: bucket_name required: true schema: title: Bucket Name type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmbeddingsBucketFilesData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get file-level embedding statuses for a bucket tags: - Embeddings x-latency-category: responsive /ai/embeddings/similarity-search: post: description: "Perform a similarity search on a Telnyx Storage Bucket, returning\ \ the most similar `num_docs` document chunks to the query.\n\nCurrently the\ \ only available distance metric is cosine similarity which will return a\ \ `distance` between 0 and 1.\nThe lower the distance, the more similar the\ \ returned document chunks are to the query.\nA `certainty` will also be returned,\ \ which is a value between 0 and 1 where the higher the certainty, the more\ \ similar the document.\nYou can read more about Weaviate distance metrics\ \ here: [Weaviate Docs](https://weaviate.io/developers/weaviate/config-refs/distances)\n\ \nIf a bucket was embedded using a custom loader, such as `intercom`, the\ \ additional metadata will be returned in the \n`loader_metadata` field." operationId: PostEmbeddingSimilaritySearch requestBody: content: application/json: schema: $ref: '#/components/schemas/EmbeddingSimilaritySearchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmbeddingSimilaritySearchResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Search for documents tags: - Embeddings x-latency-category: responsive /ai/embeddings/url: post: description: Embed website content from a specified URL, including child pages up to 5 levels deep within the same domain. The process crawls and loads content from the main URL and its linked pages into a Telnyx Cloud Storage bucket. As soon as each webpage is added to the bucket, its content is immediately processed for embeddings, that can be used for [similarity search](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding-similarity-search) and [clustering](https://developers.telnyx.com/docs/inference/clusters). operationId: PostEmbeddingUrl requestBody: content: application/json: schema: $ref: '#/components/schemas/EmbeddingUrlRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmbeddingResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Embed URL content tags: - Embeddings x-latency-category: responsive /ai/embeddings/{task_id}: get: description: 'Check the status of a current embedding task. Will be one of the following: - `queued` - Task is waiting to be picked up by a worker - `processing` - The embedding task is running - `success` - Task completed successfully and the bucket is embedded - `failure` - Task failed and no files were embedded successfully - `partial_success` - Some files were embedded successfully, but at least one failed' operationId: GetEmbeddingTask parameters: - in: path name: task_id required: true schema: title: Task Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TaskStatusResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get an embedding task's status tags: - Embeddings x-latency-category: responsive /ai/fine_tuning/jobs: get: description: Retrieve a list of all fine tuning jobs created by the user. operationId: get_finetuningjob_public_finetuning_get responses: '200': content: application/json: schema: $ref: '#/components/schemas/FineTuningJobsListData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List fine tuning jobs tags: - Fine Tuning x-latency-category: responsive post: description: Create a new fine tuning job. operationId: create_new_finetuningjob_public_finetuning_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFineTuningJobRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/FineTuningJob' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create a fine tuning job tags: - Fine Tuning x-latency-category: responsive /ai/fine_tuning/jobs/{job_id}: get: description: Retrieve a fine tuning job by `job_id`. operationId: get_finetuningjob_public_finetuning__job_id__get parameters: - in: path name: job_id required: true schema: title: Job Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FineTuningJob' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get a fine tuning job tags: - Fine Tuning x-latency-category: responsive /ai/fine_tuning/jobs/{job_id}/cancel: post: description: Cancel a fine tuning job. operationId: cancel_new_finetuningjob_public_finetuning_post parameters: - in: path name: job_id required: true schema: title: Job Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/FineTuningJob' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Cancel a fine tuning job tags: - Fine Tuning x-latency-category: responsive /ai/models: get: description: 'This endpoint returns a list of Open Source and OpenAI models that are available for use. <br /><br /> **Note**: Model `id`''s will be in the form `{source}/{model_name}`. For example `openai/gpt-4` or `mistralai/Mistral-7B-Instruct-v0.1` consistent with HuggingFace naming conventions.' operationId: get_models_public_models_get responses: '200': content: application/json: schema: $ref: '#/components/schemas/ModelsResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get available models tags: - Chat x-latency-category: responsive /ai/summarize: post: description: "Generate a summary of a file's contents. \n\n Supports the following\ \ text formats: \n- PDF, HTML, txt, json, csv\n\n Supports the following media\ \ formats (billed for both the transcription and summary): \n- flac, mp3,\ \ mp4, mpeg, mpga, m4a, ogg, wav, or webm\n- Up to 100 MB" operationId: PostSummary requestBody: content: application/json: schema: $ref: '#/components/schemas/SummaryRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SummaryResponseData' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Summarize file content tags: - Chat x-latency-category: responsive /audit_events: get: description: Retrieve a list of audit log entries. Audit logs are a best-effort, eventually consistent record of significant account-related changes. operationId: ListAuditLogs parameters: - $ref: '#/components/parameters/audit-logs_PageConsolidated' - $ref: '#/components/parameters/audit-logs_FilterConsolidated' - $ref: '#/components/parameters/Sort' responses: '200': $ref: '#/components/responses/AuditLogListResponse' default: $ref: '#/components/responses/GenericErrorResponse' summary: List Audit Logs tags: - Audit Logs x-latency-category: responsive /authentication_providers: get: deprecated: false description: Returns a list of your SSO authentication providers. operationId: FindAuthenticationProviders parameters: - 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/>\nThat is: <ul>\n <li>\n <code>name</code>: sorts\ \ the result by the\n <code>name</code> field in ascending order.\n \ \ </li>\n <li>\n <code>-name</code>: sorts the result by the\n <code>name</code>\ \ field in descending order.\n </li>\n</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 - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/AuthenticationProvider' type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: Successful response '400': content: application/json: schema: properties: {} type: object description: Bad request '401': content: application/json: schema: properties: {} type: object description: Unauthorized '404': content: application/json: schema: properties: {} type: object description: Resource not found summary: List all SSO authentication providers tags: - Authentication Providers x-latency-category: responsive post: deprecated: false description: Creates an authentication provider. operationId: CreateAuthenticationProvider parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/AuthenticationProviderCreate' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/AuthenticationProvider' type: object description: Successful response '422': content: application/json: schema: properties: {} type: object description: Bad request summary: Creates an authentication provider tags: - Authentication Providers x-latency-category: responsive /authentication_providers/{id}: delete: deprecated: false description: Deletes an existing authentication provider. operationId: DeleteAuthenticationProvider parameters: - description: authentication provider ID in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/AuthenticationProvider' type: object description: Successful response '401': content: application/json: schema: properties: {} type: object description: Unauthorized '404': content: application/json: schema: properties: {} type: object description: Resource not found '422': content: application/json: schema: properties: {} type: object description: Bad request summary: Deletes an authentication provider tags: - Authentication Providers x-latency-category: responsive get: deprecated: false 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': content: application/json: schema: properties: data: $ref: '#/components/schemas/AuthenticationProvider' type: object description: Successful response '401': content: application/json: schema: properties: {} type: object description: Unauthorized '404': content: application/json: schema: properties: {} type: object description: Resource not found '422': content: application/json: schema: properties: {} type: object description: Bad request summary: Retrieve an authentication provider tags: - Authentication Providers x-latency-category: responsive patch: deprecated: false 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: 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 schema: $ref: '#/components/schemas/UpdateAuthenticationProviderRequest' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/AuthenticationProvider' type: object description: Successful response '401': content: application/json: schema: properties: {} type: object description: Unauthorized '404': content: application/json: schema: properties: {} type: object description: Resource not found '422': content: application/json: schema: properties: {} type: object description: Bad request summary: Update an authentication provider tags: - Authentication Providers x-latency-category: responsive /available_phone_number_blocks: get: operationId: ListAvailablePhoneNumberBlocks parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[locality], filter[country_code], filter[national_destination_code], filter[phone_number_type]' explode: true in: query name: filter schema: properties: country_code: description: Filter phone numbers by country. type: string locality: description: Filter phone numbers by city. type: string national_destination_code: description: Filter by the national destination code of the number. type: string phone_number_type: description: Filter phone numbers by number type. enum: - local - toll_free - mobile - national - shared_cost type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListAvailablePhoneNumbersBlockResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List available phone number blocks tags: - Phone Number Search x-latency-category: responsive /available_phone_numbers: get: operationId: ListAvailablePhoneNumbers parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[locality], filter[administrative_area], filter[country_code], filter[national_destination_code], filter[rate_center], filter[phone_number_type], filter[features], filter[limit], filter[best_effort], filter[quickship], filter[reservable], filter[exclude_held_numbers]' explode: true in: query name: filter schema: properties: administrative_area: description: Find numbers in a particular US state or CA province. type: string best_effort: description: Filter to determine if best effort results should be included. Only available in USA/CANADA. type: boolean country_code: description: Filter phone numbers by country. type: string exclude_held_numbers: description: Filter to exclude phone numbers that are currently on hold/reserved for your account. type: boolean features: description: Filter phone numbers with specific features. items: enum: - sms - mms - voice - fax - emergency - hd_voice - international_sms - local_calling type: string type: array limit: description: Limits the number of results. type: integer locality: description: Filter phone numbers by city. type: string national_destination_code: description: Filter by the national destination code of the number. type: string phone_number: additionalProperties: false description: Filter phone numbers by pattern matching. properties: contains: description: Filter numbers containing a pattern (excludes NDC if used with `national_destination_code` filter). type: string ends_with: description: Filter numbers ending with a pattern (excludes NDC if used with `national_destination_code` filter). type: string starts_with: description: Filter numbers starting with a pattern (excludes NDC if used with `national_destination_code` filter). type: string type: object phone_number_type: description: Filter phone numbers by number type. enum: - local - toll_free - mobile - national - shared_cost type: string quickship: description: Filter to exclude phone numbers that need additional time after to purchase to activate. Only applicable for +1 toll_free numbers. type: boolean rate_center: description: Filter phone numbers by rate center. This filter is only applicable to USA and Canada numbers. type: string reservable: description: Filter to ensure only numbers that can be reserved are included in the results. type: boolean type: object style: deepObject responses: '200': $ref: '#/components/responses/ListAvailablePhoneNumbersResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List available phone numbers tags: - Phone 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/billing_GenericErrorResponse' summary: Get user balance details tags: - Billing x-latency-category: responsive /billing_groups: get: deprecated: false description: '' operationId: ListBillingGroups parameters: - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject responses: '200': 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 headers: {} '500': content: application/json: schema: $ref: '#/components/schemas/billing-group_Errors' description: Unexpected error headers: {} summary: List all billing groups tags: - Billing Groups x-latency-category: responsive post: deprecated: false description: '' operationId: CreateBillingGroup requestBody: content: application/json: example: name: string schema: $ref: '#/components/schemas/NewBillingGroup' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/BillingGroup' type: object description: Expected billing group response to a valid request headers: {} '500': content: application/json: schema: $ref: '#/components/schemas/billing-group_Errors' description: Unexpected error headers: {} summary: Create a billing group tags: - Billing Groups x-latency-category: responsive /billing_groups/{id}: delete: deprecated: false description: '' operationId: DeleteBillingGroup parameters: - description: The id of the billing group example: f5586561-8ff0-4291-a0ac-84fe544797bd in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/BillingGroup' type: object description: Expected billing group response to a valid request headers: {} '500': content: application/json: schema: $ref: '#/components/schemas/billing-group_Errors' description: Unexpected error headers: {} summary: Delete a billing group tags: - Billing Groups x-latency-category: responsive get: deprecated: false description: '' operationId: GetBillingGroup parameters: - description: The id of the billing group example: f5586561-8ff0-4291-a0ac-84fe544797bd in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/BillingGroup' type: object description: Expected billing group response to a valid request headers: {} '500': content: application/json: schema: $ref: '#/components/schemas/billing-group_Errors' description: Unexpected error headers: {} summary: Get a billing group tags: - Billing Groups x-latency-category: responsive patch: deprecated: false description: '' operationId: UpdateBillingGroup parameters: - description: The id of the billing group example: f5586561-8ff0-4291-a0ac-84fe544797bd in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: example: name: string schema: $ref: '#/components/schemas/UpdateBillingGroup' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/BillingGroup' type: object description: Expected billing group response to a valid request headers: {} '500': content: application/json: schema: $ref: '#/components/schemas/billing-group_Errors' description: Unexpected error headers: {} summary: Update a billing group tags: - Billing Groups x-latency-category: responsive /brand: get: description: This endpoint is used to list all brands associated with your organization. operationId: GetBrands parameters: - in: query name: page required: false schema: default: 1 minimum: 1 title: Page type: integer - description: number of records per page. maximum of 500 in: query name: recordsPerPage required: false schema: default: 10 description: number of records per page. maximum of 500 title: Recordsperpage type: integer - description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. example: -identityStatus in: query name: sort required: false schema: default: -createdAt description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - assignedCampaignsCount - -assignedCampaignsCount - brandId - -brandId - createdAt - -createdAt - displayName - -displayName - identityStatus - -identityStatus - status - -status - tcrBrandId - -tcrBrandId title: Sort type: string - in: query name: displayName required: false schema: title: Displayname type: string - in: query name: entityType required: false schema: title: Entitytype type: string - in: query name: state required: false schema: title: State type: string - in: query name: country required: false schema: title: Country type: string - description: Filter results by the Telnyx Brand id in: query name: brandId required: false schema: example: 826ef77a-348c-445b-81a5-a9b13c68fbfe title: BrandId type: string - description: Filter results by the TCR Brand id in: query name: tcrBrandId required: false schema: example: BBAND1 title: TCRBrandId type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BrandRecordSetCSP' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List Brands tags: - Brands x-latency-category: responsive post: description: This endpoint is used to create a new brand. A brand is an entity created by The Campaign Registry (TCR) that represents an organization or a company. It is this entity that TCR created campaigns will be associated with. Each brand creation will entail an upfront, non-refundable $4 expense. operationId: CreateBrandPost parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateBrand' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelnyxBrand' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Create Brand tags: - Brands x-latency-category: responsive /brand/feedback/{brandId}: get: description: "Get feedback about a brand by ID. This endpoint can be used after\ \ creating or revetting\na brand.\n\nPossible values for `.category[].id`:\n\ \n* `TAX_ID` - Data mismatch related to tax id and its associated properties.\n\ * `STOCK_SYMBOL` - Non public entity registered as a public for profit entity\ \ or\n the stock information mismatch.\n* `GOVERNMENT_ENTITY` - Non government\ \ entity registered as a government entity.\n Must be a U.S. government entity.\n\ * `NONPROFIT` - Not a recognized non-profit entity. No IRS tax-exempt status\n\ \ found.\n* `OTHERS` - Details of the data misrepresentation if any." operationId: GetBrandFeedbackById parameters: - in: path name: brandId required: true schema: title: Brandid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/BrandFeedback' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Brand Feedback By Id tags: - Brands x-latency-category: responsive /brand/{brandId}: delete: description: Delete Brand. This endpoint is used to delete a brand. Note the brand cannot be deleted if it contains one or more active campaigns, the campaigns need to be inactive and at least 3 months old due to billing purposes. operationId: DeleteBrand parameters: - in: path name: brandId required: true schema: title: Brandid type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Delete Brand tags: - Brands x-latency-category: responsive get: description: Retrieve a brand by `brandId`. operationId: GetBrand parameters: - in: path name: brandId required: true schema: title: Brandid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelnyxBrandWithCampaignsCount' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Brand tags: - Brands x-latency-category: responsive put: description: Update a brand's attributes by `brandId`. operationId: UpdateBrand parameters: - in: path name: brandId required: true schema: title: Brandid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBrand' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelnyxBrand' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update Brand tags: - Brands x-latency-category: responsive /brand/{brandId}/2faEmail: post: operationId: ResendBrand2faEmail parameters: - in: path name: brandId required: true schema: title: Brandid type: string responses: '200': description: Successful Response summary: Resend brand 2FA email tags: - Brands x-latency-category: responsive /brand/{brandId}/externalVetting: get: description: Get list of valid external vetting record for a given brand operationId: ListExternalVettings parameters: - in: path name: brandId required: true schema: title: Brandid type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List External Vettings tags: - Brands x-latency-category: responsive post: description: Order new external vetting for a brand operationId: PostOrderExternalVetting parameters: - in: path name: brandId required: true schema: title: Brandid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OrderExternalVetting' required: true responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Order Brand External Vetting tags: - Brands x-latency-category: responsive put: description: 'This operation can be used to import an external vetting record from a TCR-approved vetting provider. If the vetting provider confirms validity of the record, it will be saved with the brand and will be considered for future campaign qualification.' operationId: PutExternalVettingRecord parameters: - in: path name: brandId required: true schema: title: Brandid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportExternalVetting' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalVetting' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Import External Vetting Record tags: - Brands x-latency-category: responsive /brand/{brandId}/revet: put: description: This operation allows you to revet the brand. However, revetting is allowed once after the successful brand registration and thereafter limited to once every 3 months. operationId: RevetBrand parameters: - in: path name: brandId required: true schema: title: Brandid type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Revet Brand tags: - Brands x-latency-category: responsive /bulk_sim_card_actions: get: description: This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions. operationId: ListBulkSimCardActions parameters: - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/wireless_PageSize' - description: Filter by action type. in: query name: filter[action_type] required: false schema: enum: - bulk_set_public_ips example: bulk_set_public_ips type: string responses: '200': $ref: '#/components/responses/BulkSIMCardActionCollectionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: List bulk SIM card actions tags: - SIM Card Actions x-latency-category: responsive /bulk_sim_card_actions/{id}: get: description: This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions. operationId: GetBulkSimCardAction parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/BulkSIMCardActionDetailedResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get bulk SIM card action details tags: - SIM Card Actions x-latency-category: responsive /bundle_pricing/billing_bundles: get: description: Get all allowed bundles. operationId: GetUserBillingBundles parameters: - $ref: '#/components/parameters/bundle-pricing_FilterConsolidated' - $ref: '#/components/parameters/bundle-pricing_PageConsolidated' - $ref: '#/components/parameters/AuthorizationBearer' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedBillingBundlesResponse' description: Successful Response '401': description: Unauthorized summary: Retrieve Bundles tags: - Bundles x-latency-category: responsive /bundle_pricing/billing_bundles/{bundle_id}: get: description: Get a single bundle by ID. operationId: GetBillingBundleById parameters: - $ref: '#/components/parameters/BundleId' - $ref: '#/components/parameters/AuthorizationBearer' responses: '200': content: application/json: schema: $ref: '#/components/schemas/BillingBundleResponse' description: Successful Response '401': description: Unauthorized '404': description: Resource not found summary: Get Bundle By Id tags: - Bundles x-latency-category: responsive /bundle_pricing/user_bundles: get: description: Get a paginated list of user bundles. operationId: GetUserBundles parameters: - $ref: '#/components/parameters/bundle-pricing_FilterConsolidated' - $ref: '#/components/parameters/bundle-pricing_PageConsolidated' - $ref: '#/components/parameters/AuthorizationBearer' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserBundlesResponse' description: Successful Response '401': description: Unauthorized summary: Get User Bundles tags: - User Bundles x-latency-category: responsive /bundle_pricing/user_bundles/bulk: post: description: Creates multiple user bundles for the user. operationId: CreateUserBundlesBulk parameters: - $ref: '#/components/parameters/AuthorizationBearer' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserBundlesBulkRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/CreatedUserBundlesResponse' description: Successful Response '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found summary: Create User Bundles tags: - User Bundles x-latency-category: responsive /bundle_pricing/user_bundles/unused: get: description: Returns all user bundles that aren't in use. operationId: GetUnusedUserBundles parameters: - $ref: '#/components/parameters/bundle-pricing_FilterConsolidated' - $ref: '#/components/parameters/AuthorizationBearer' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UnusedUserBundlesResponse' description: Successful Response '401': description: Unauthorized summary: Get Unused User Bundles tags: - User Bundles x-latency-category: responsive /bundle_pricing/user_bundles/{user_bundle_id}: delete: description: Deactivates a user bundle by its ID. operationId: DeactivateUserBundle parameters: - $ref: '#/components/parameters/UserBundleId' - $ref: '#/components/parameters/AuthorizationBearer' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserBundleCreateResponse' description: Successful Response '401': description: Unauthorized '404': description: Not Found summary: Deactivate User Bundle tags: - User Bundles x-latency-category: responsive get: description: Retrieves a user bundle by its ID. operationId: GetUserBundleById parameters: - $ref: '#/components/parameters/UserBundleId' - $ref: '#/components/parameters/AuthorizationBearer' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserBundleResponse' description: Successful Response '401': description: Unauthorized '404': description: Not Found summary: Get User Bundle by Id tags: - User Bundles x-latency-category: responsive /bundle_pricing/user_bundles/{user_bundle_id}/resources: get: description: Retrieves the resources of a user bundle by its ID. operationId: GetUserBundleResources parameters: - $ref: '#/components/parameters/UserBundleId' - $ref: '#/components/parameters/AuthorizationBearer' responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserBundleResourcesResponse' description: Successful Response '401': description: Unauthorized '404': description: Not Found summary: Get User Bundle Resources tags: - User Bundles x-latency-category: responsive /call_control_applications: get: description: Return a list of call control applications. operationId: ListCallControlApplications parameters: - $ref: '#/components/parameters/call-control_FilterConsolidated' - $ref: '#/components/parameters/call-control_PageConsolidated' - $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 `occurred_at`. If filter for `leg_id` or `application_session_id` is not present, it only filters events from the last 24 hours. **Note**: Only one `filter[occurred_at]` can be passed. ' operationId: ListCallEvents parameters: - $ref: '#/components/parameters/call-control_FilterConsolidated' - $ref: '#/components/parameters/call-control_PageConsolidated' responses: '200': $ref: '#/components/responses/ListCallEventsResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: List call events tags: - Debugging x-group-parameters: 'true' x-latency-category: responsive /calls: post: 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 (see [schema](https://developers.telnyx.com/api/call-control/dial-call#callbacks) below):** - `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 requested to detect the end of machine greeting - `call.machine.premium.detection.ended` if `answering_machine_detection=premium` was requested - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium` was requested and a beep was detected - `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url` was set When the `record` parameter is set to `record-from-answer`, the response will include a `recording_id` field. ' operationId: DialCall requestBody: content: application/json: schema: $ref: '#/components/schemas/CallRequest' description: Call request required: true responses: '200': $ref: '#/components/responses/RetrieveCallStatusResponseWithRecordingId' default: $ref: '#/components/responses/call-control_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/call-control_GenericErrorResponse' summary: Retrieve a call status tags: - Call Information x-latency-category: interactive /calls/{call_control_id}/actions/ai_assistant_start: post: description: 'Start an AI assistant on the call. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/call-start-ai-assistant#callbacks) below):** - `call.conversation.ended` - `call.conversation_insights.generated` ' operationId: CallStartAIAssistant parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/AIAssistantStartRequest' description: AI Assistant request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponseWithConversationId' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Start AI Assistant tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/ai_assistant_stop: post: description: Stop an AI assistant on the call. operationId: CallStopAIAssistant parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/AIAssistantStopRequest' description: AI Assistant request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Stop AI Assistant tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/answer: post: description: 'Answer an incoming call. You must issue this command before executing subsequent commands on an incoming call. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/answer-call#callbacks) below):** - `call.answered` - `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url` was set When the `record` parameter is set to `record-from-answer`, the response will include a `recording_id` field. ' operationId: AnswerCall 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/CallControlCommandResponseWithRecordingId' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Answer call tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/bridge: post: description: 'Bridge two call control calls. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/bridge-call#callbacks) below):** - `call.bridged` for Leg A - `call.bridged` for Leg B ' operationId: BridgeCall 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/call-control_GenericErrorResponse' summary: Bridge calls tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/client_state_update: put: description: Updates client state operationId: UpdateClientState parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientStateUpdateRequest' description: Updates client state for every subsequent webhook required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Update client state tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/enqueue: post: description: Put the call in a queue. operationId: EnqueueCall 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/call-control_GenericErrorResponse' summary: Enqueue call tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/fork_start: post: description: "Call forking allows you to stream the media from a call to a specific\ \ target in realtime. \nThis stream can be used to enable realtime audio analysis\ \ to support a \nvariety of use cases, including fraud detection, or the creation\ \ of AI-generated audio responses. \nRequests must specify either the `target`\ \ attribute or the `rx` and `tx` attributes.\n\n**Expected Webhooks (see [callback\ \ schema](https://developers.telnyx.com/api/call-control/start-call-fork#callbacks)\ \ below):**\n\n- `call.fork.started`\n- `call.fork.stopped`\n\n" operationId: StartCallFork 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/call-control_GenericErrorResponse' summary: Forking start tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/fork_stop: post: description: 'Stop forking a call. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/stop-call-fork#callbacks) below):** - `call.fork.stopped` ' operationId: StopCallFork 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/call-control_GenericErrorResponse' summary: Forking stop tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/gather: post: description: 'Gather DTMF signals to build interactive menus. You can pass a list of valid digits. The `Answer` command must be issued before the `gather` command. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/gather-call#callbacks) below):** - `call.dtmf.received` (you may receive many of these webhooks) - `call.gather.ended` ' operationId: GatherCall parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/GatherRequest' description: Gather required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Gather tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/gather_stop: post: description: 'Stop current gather. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/stop-call-gather#callbacks) below):** - `call.gather.ended` ' operationId: StopCallGather 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/call-control_GenericErrorResponse' summary: Gather stop tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/gather_using_ai: post: description: "Gather parameters defined in the request payload using a voice\ \ assistant.\n\n You can pass parameters described as a JSON Schema object\ \ and the voice assistant will attempt to gather these informations. \n\n\ **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/call-gather-using-ai#callbacks)\ \ below):**\n\n- `call.ai_gather.ended`\n- `call.conversation.ended`\n- `call.ai_gather.partial_results`\ \ (if `send_partial_results` is set to `true`)\n- `call.ai_gather.message_history_updated`\ \ (if `send_message_history_updates` is set to `true`)\n" operationId: callGatherUsingAI parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/GatherUsingAIRequest' description: Gather using AI request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponseWithConversationId' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Gather using AI tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/gather_using_audio: post: 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 command must be issued before the `gather_using_audio` command. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/gather-using-audio#callbacks) below):** - `call.playback.started` - `call.playback.ended` - `call.dtmf.received` (you may receive many of these webhooks) - `call.gather.ended` ' operationId: GatherUsingAudio 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/call-control_GenericErrorResponse' summary: Gather using audio tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/gather_using_speak: post: 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` command must be issued before the `gather_using_speak` command. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/gather-using-speak#callbacks) below):** - `call.dtmf.received` (you may receive many of these webhooks) - `call.gather.ended` ' operationId: GatherUsingSpeak 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/call-control_GenericErrorResponse' summary: Gather using speak tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/hangup: post: description: 'Hang up the call. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/hangup-call#callbacks) below):** - `call.hangup` - `call.recording.saved` ' operationId: HangupCall 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/call-control_GenericErrorResponse' summary: Hangup call tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/leave_queue: post: 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/call-control_GenericErrorResponse' summary: Remove call from a queue tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/playback_start: post: 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 (see [callback schema](https://developers.telnyx.com/api/call-control/start-call-playback#callbacks) below):** - `call.playback.started` - `call.playback.ended` ' operationId: StartCallPlayback 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/call-control_GenericErrorResponse' summary: Play audio URL tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/playback_stop: post: description: 'Stop audio being played on the call. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/stop-call-playback#callbacks) below):** - `call.playback.ended` or `call.speak.ended` ' operationId: StopCallPlayback 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/call-control_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: PauseCallRecording 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/call-control_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: ResumeCallRecording 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/call-control_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 (see [callback schema](https://developers.telnyx.com/api/call-control/start-call-record#callbacks) below):** - `call.recording.saved` - `call.recording.transcription.saved` - `call.recording.error` ' operationId: StartCallRecord 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/call-control_GenericErrorResponse' summary: Recording start tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/record_stop: post: description: 'Stop recording the call. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/stop-call-recording#callbacks) below):** - `call.recording.saved` ' operationId: StopCallRecording 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/call-control_GenericErrorResponse' summary: Recording stop tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/refer: post: 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 (see [callback schema](https://developers.telnyx.com/api/call-control/refer-call#callbacks) below):** - `call.refer.started` - `call.refer.completed` - `call.refer.failed` ' operationId: ReferCall 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/call-control_GenericErrorResponse' summary: SIP Refer a call tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/reject: post: description: 'Reject an incoming call. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/reject-call#callbacks) below):** - `call.hangup` ' operationId: RejectCall 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/call-control_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: SendDTMF 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/call-control_GenericErrorResponse' summary: Send DTMF tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/send_sip_info: post: description: 'Sends SIP info from this leg. **Expected Webhooks:** - `call.sip_info.received` (to be received on the target call leg) ' operationId: SendSIPInfo parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SendSIPInfoRequest' description: Send SIP INFO request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Send SIP info tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/siprec_start: post: description: "Start siprec session to configured in SIPREC connector SRS. \n\ \n**Expected Webhooks:**\n\n- `siprec.started`\n- `siprec.stopped`\n- `siprec.failed`\n" operationId: StartSiprecSession parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartSiprecRequest' description: Start siprec session to configured in SIPREC connector SRS. required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: SIPREC start tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/siprec_stop: post: description: 'Stop SIPREC session. **Expected Webhooks:** - `siprec.stopped` ' operationId: StopSiprecSession parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/StopSiprecRequest' description: Stop siprec session required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: SIPREC stop tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/speak: post: 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 (see [callback schema](https://developers.telnyx.com/api/call-control/speak-call#callbacks) below):** - `call.speak.started` - `call.speak.ended` ' operationId: SpeakCall 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/call-control_GenericErrorResponse' summary: Speak text tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/streaming_start: post: description: 'Start streaming the media from a call to a specific WebSocket address or Dialogflow connection in near-realtime. Audio will be delivered as base64-encoded RTP payload (raw audio), wrapped in JSON payloads. Please find more details about media streaming messages specification under the [link](https://developers.telnyx.com/docs/voice/programmable-voice/media-streaming).' operationId: StartCallStreaming parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartStreamingRequest' description: Start streaming media request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Streaming start tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/streaming_stop: post: description: 'Stop streaming a call to a WebSocket. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/stop-call-streaming#callbacks) below):** - `streaming.stopped` ' operationId: StopCallStreaming parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/StopStreamingRequest' description: Stop streaming media request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Streaming stop tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/suppression_start: post: operationId: noiseSuppressionStart parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/NoiseSuppressionStart' description: Start streaming media request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Noise Suppression Start (BETA) tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/suppression_stop: post: operationId: noiseSuppressionStop parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/NoiseSuppressionStop' description: Start streaming media request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Noise Suppression Stop (BETA) tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/switch_supervisor_role: post: description: Switch the supervisor role for a bridged call. This allows switching between different supervisor modes during an active call operationId: SwitchSupervisorRole parameters: - $ref: '#/components/parameters/CallControlId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SwitchSupervisorRoleRequest' description: Switch supervisor role request required: true responses: '200': $ref: '#/components/responses/CallControlCommandResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: Switch supervisor role tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/transcription_start: post: description: 'Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/start-call-transcription#callbacks) below):** - `call.transcription` ' operationId: StartCallTranscription 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/call-control_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: StopCallTranscription 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/call-control_GenericErrorResponse' summary: Transcription stop tags: - Call Commands x-latency-category: interactive /calls/{call_control_id}/actions/transfer: post: 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 (see [callback schema](https://developers.telnyx.com/api/call-control/transfer-call#callbacks) below):** - `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 requested to detect the end of machine greeting - `call.machine.premium.detection.ended` if `answering_machine_detection=premium` was requested - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium` was requested and a beep was detected ' operationId: TransferCall 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/call-control_GenericErrorResponse' summary: Transfer call tags: - Call Commands x-latency-category: interactive /campaign: get: description: Retrieve a list of campaigns associated with a supplied `brandId`. operationId: GetCampaigns parameters: - in: query name: brandId required: true schema: title: Brandid type: string - description: The 1-indexed page number to get. The default value is `1`. in: query name: page required: false schema: default: 1 description: The 1-indexed page number to get. The default value is `1`. title: Page type: integer - description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. in: query name: recordsPerPage required: false schema: default: 10 description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. title: Recordsperpage type: integer - description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. example: -assignedPhoneNumbersCount in: query name: sort required: false schema: default: -createdAt description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - assignedPhoneNumbersCount - -assignedPhoneNumbersCount - campaignId - -campaignId - createdAt - -createdAt - status - -status - tcrCampaignId - -tcrCampaignId title: Sort type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignRecordSet_CSP' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List Campaigns tags: - Campaign x-latency-category: responsive /campaign/acceptSharing/{campaignId}: post: description: Manually accept a campaign shared with Telnyx operationId: AcceptCampaign parameters: - description: TCR's ID for the campaign to import in: path name: campaignId required: true schema: description: TCR's ID for the campaign to import pattern: ^C[A-Z0-9]{5,8}$ title: Campaignid type: string responses: '200': content: application/json: schema: {} description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Accept Shared Campaign tags: - Campaign x-latency-category: responsive /campaign/usecase/cost: get: operationId: GetCampaignCost parameters: - in: query name: usecase required: true schema: title: Usecase type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignCost' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Campaign Cost tags: - Campaign x-latency-category: responsive /campaign/{campaignId}: delete: description: Terminate a campaign. Note that once deactivated, a campaign cannot be restored. operationId: DeactivateCampaign parameters: - in: path name: campaignId required: true schema: title: Campaignid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignDeletionResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Deactivate My Campaign tags: - Campaign x-latency-category: responsive get: description: Retrieve campaign details by `campaignId`. operationId: GetCampaign parameters: - in: path name: campaignId required: true schema: title: Campaignid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelnyxCampaign_CSP' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get My Campaign tags: - Campaign x-latency-category: responsive put: description: Update a campaign's properties by `campaignId`. **Please note:** only sample messages are editable. operationId: UpdateCampaign parameters: - in: path name: campaignId required: true schema: title: Campaignid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCampaignRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelnyxCampaign_CSP' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update My Campaign tags: - Campaign x-latency-category: responsive /campaign/{campaignId}/appeal: post: description: 'Submits an appeal for rejected native campaigns in TELNYX_FAILED or MNO_REJECTED status. The appeal is recorded for manual compliance team review and the campaign status is reset to TCR_ACCEPTED. Note: Appeal forwarding is handled manually to allow proper review before incurring upstream charges.' operationId: AppealCampaign parameters: - description: The Telnyx campaign identifier in: path name: campaignId required: true schema: example: 5eb13888-32b7-4cab-95e6-d834dde21d64 format: uuid type: string requestBody: content: application/json: schema: properties: appeal_reason: description: Detailed explanation of why the campaign should be reconsidered and what changes have been made to address the rejection reason. example: The website has been updated to include the required privacy policy and terms of service. type: string required: - appeal_reason type: object description: Appeal request payload required: true responses: '200': content: application/json: example: appealed_at: '2025-08-06T15:30:45.123456' previous_status: null schema: properties: appealed_at: description: Timestamp when the appeal was submitted format: date-time type: string previous_status: description: Previous campaign status (currently always null) nullable: true type: string type: object description: Appeal recorded successfully. Campaign status updated to TCR_ACCEPTED for manual compliance review. '400': content: application/json: schema: $ref: '#/components/schemas/10dlc_Error' description: Campaign not in appealable status or invalid request '404': content: application/json: schema: $ref: '#/components/schemas/10dlc_Error' description: Campaign not found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Submit campaign appeal for manual review tags: - Campaign x-latency-category: responsive /campaign/{campaignId}/mnoMetadata: get: description: Get the campaign metadata for each MNO it was submitted to. operationId: GetCampaignMnoMetadata parameters: - description: ID of the campaign in question in: path name: campaignId required: true schema: description: ID of the campaign in question title: Campaignid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MnoMetadata' description: Successful Response. It constains a map of usecase metadata for each MNO. The key is the network ID of the MNO (e.g. 10017), the value is the mno metadata for the usecase. The metadata may also include some MNO specific fields. default: content: application/json: schema: $ref: '#/components/schemas/10dlc_Errors' description: Unexpected Error summary: Get Campaign Mno Metadata tags: - Campaign x-latency-category: responsive /campaign/{campaignId}/operationStatus: get: description: Retrieve campaign's operation status at MNO level. operationId: GetCampaignOperationStatus parameters: - in: path name: campaignId required: true schema: title: Campaignid type: string responses: '200': content: application/json: schema: title: Response Get My Campaign Operation Status Public Campaign Campaignid Operationstatus Get type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get My Campaign Operation Status tags: - Campaign x-latency-category: responsive /campaign/{campaignId}/osr/attributes: get: operationId: GetCampaignOsrAttributes parameters: - in: path name: campaignId required: true schema: title: Campaignid type: string responses: '200': content: application/json: schema: title: Response Get My Osr Campaign Attributes Public Campaign Campaignid Osr Attributes Get type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get My Osr Campaign Attributes tags: - Campaign x-latency-category: responsive /campaign/{campaignId}/sharing: get: operationId: GetCampaignSharingStatus parameters: - description: ID of the campaign in question in: path name: campaignId required: true schema: description: ID of the campaign in question title: Campaignid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CampaignSharingChain' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Sharing Status tags: - Campaign x-latency-category: responsive /campaignBuilder: post: description: Before creating a campaign, use the [Qualify By Usecase endpoint](https://developers.telnyx.com/api/messaging/10dlc/get-usecase-qualification) to ensure that the brand you want to assign a new campaign to is qualified for the desired use case of that campaign. **Please note:** After campaign creation, you'll only be able to edit the campaign's sample messages. Creating a campaign will entail an upfront, non-refundable three month's cost that will depend on the campaign's use case ([see 10DLC Costs section for details](https://developers.telnyx.com/docs/messaging/10dlc/concepts#10dlc-costs)). operationId: PostCampaign parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CampaignRequest' required: true responses: '200': content: application/json: schema: anyOf: - type: object - $ref: '#/components/schemas/TelnyxCampaign_CSP' title: Response Submit Campaign Public Campaignbuilder Post description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Submit Campaign tags: - Campaign x-latency-category: responsive /campaignBuilder/brand/{brandId}/usecase/{usecase}: get: description: This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case. operationId: GetUsecaseQualification parameters: - in: path name: usecase required: true schema: title: Usecase type: string - in: path name: brandId required: true schema: title: Brandid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsecaseMetadata' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Qualify By Usecase tags: - Campaign x-latency-category: responsive /channel_zones: get: description: Returns the non-US voice channels for your account. voice channels allow you to use Channel Billing for calls to your Telnyx phone numbers. Please check the <a href="https://support.telnyx.com/en/articles/8428806-global-channel-billing">Telnyx Support Articles</a> section for full information and examples of how to utilize Channel Billing. operationId: GetChannelZones parameters: - $ref: '#/components/parameters/voice-channels_PageConsolidated' responses: '200': $ref: '#/components/responses/GetGcbChannelZonesRequestResponse' summary: List your voice channels for non-US zones tags: - Voice Channels x-latency-category: interactive /channel_zones/{channel_zone_id}: parameters: - $ref: '#/components/parameters/GcbChannelZoneId' put: description: Update the number of Voice Channels for the Non-US Zones. This allows your account to handle multiple simultaneous inbound calls to Non-US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume. operationId: PatchChannelZone requestBody: content: application/json: schema: properties: channels: description: The number of reserved channels format: int64 type: integer required: - channels type: object description: Quantity of reserved channels and organizational update option required: true responses: '200': $ref: '#/components/responses/PatchGcbChannelZoneRequestResponse' default: $ref: '#/components/responses/voice-channels_GenericErrorResponse' summary: Update voice channels for non-US Zones tags: - Voice Channels x-codegen-request-body-name: body x-latency-category: interactive /charges_breakdown: get: description: Retrieve a detailed breakdown of monthly charges for phone numbers in a specified date range. The date range cannot exceed 31 days. parameters: - description: Start date for the charges breakdown in ISO date format (YYYY-MM-DD) in: query name: start_date required: true schema: example: '2025-05-01' format: date type: string - description: End date for the charges breakdown in ISO date format (YYYY-MM-DD). If not provided, defaults to start_date + 1 month. The date is exclusive, data for the end_date itself is not included in the report. The interval between start_date and end_date cannot exceed 31 days. in: query name: end_date required: false schema: example: '2025-06-01' format: date type: string - description: Response format in: query name: format required: false schema: default: json enum: - json - csv example: json type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MonthlyChargesBreakdownResponse' text/csv: schema: description: CSV format of the charges breakdown type: string description: Monthly charges breakdown '400': content: application/json: schema: $ref: '#/components/schemas/charges_Errors' description: Bad request - invalid date range or parameters default: $ref: '#/components/responses/charges_GenericErrorResponse' summary: Get monthly charges breakdown x-latency-category: responsive /charges_summary: get: description: Retrieve a summary of monthly charges for a specified date range. The date range cannot exceed 31 days. parameters: - description: Start date for the charges summary in ISO date format (YYYY-MM-DD) in: query name: start_date required: true schema: example: '2025-05-01' format: date type: string - description: End date for the charges summary in ISO date format (YYYY-MM-DD). The date is exclusive, data for the end_date itself is not included in the report. The interval between start_date and end_date cannot exceed 31 days. in: query name: end_date required: true schema: example: '2025-06-01' format: date type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MonthlyChargesSummaryResponse' description: Monthly charges summary '400': content: application/json: schema: $ref: '#/components/schemas/charges_Errors' description: Bad request - invalid date range or parameters default: $ref: '#/components/responses/charges_GenericErrorResponse' summary: Get monthly charges summary x-latency-category: responsive /comments: get: operationId: ListComments parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[comment_record_type], filter[comment_record_id]' explode: true in: query name: filter schema: properties: comment_record_id: description: ID of the record the comments relate to example: 8ffb3622-7c6b-4ccc-b65f-7a3dc0099576 type: string comment_record_type: description: Record type that the comment relates to enum: - sub_number_order - requirement_group example: sub_number_order type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/listCommentsResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve all comments tags: - Phone 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/numbers_GenericErrorResponse' summary: Create a comment tags: - Phone Number Orders x-latency-category: responsive /comments/{id}: get: operationId: RetrieveComment parameters: - description: The comment ID. in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/CommentResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve a comment tags: - Phone Number Orders x-latency-category: responsive /comments/{id}/read: patch: operationId: MarkCommentRead parameters: - description: The comment ID. in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/ReadCommentResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Mark a comment as read tags: - Phone 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/call-control_FilterConsolidated' - $ref: '#/components/parameters/call-control_PageConsolidated' 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: 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 (see [callback schema](https://developers.telnyx.com/api/call-control/create-conference#callbacks) below):** - `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 - $ref: '#/components/parameters/call-control_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[muted], filter[on_hold], filter[whispering]' explode: true in: query name: filter schema: properties: muted: description: If present, participants will be filtered to those who are/are not muted type: boolean on_hold: description: If present, participants will be filtered to those who are/are not put on hold type: boolean whispering: description: If present, participants will be filtered to those who are whispering or are not type: boolean type: object style: deepObject 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-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/hold: post: description: Hold a list of participants in a conference call operationId: HoldConferenceParticipants 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: 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. The conference\ \ can have up to a certain amount of active participants, as set by the `max_participants`\ \ parameter in conference creation request. \n\n**Expected Webhooks (see [callback\ \ schema](https://developers.telnyx.com/api/call-control/join-conference#callbacks)\ \ below):**\n\n- `conference.participant.joined`\n- `conference.participant.left`\n" operationId: JoinConference 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: description: "Removes a call leg from a conference and moves it back to parked\ \ state. \n\n**Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/leave-conference#callbacks)\ \ below):**\n\n- `conference.participant.left`\n" operationId: LeaveConference 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: MuteConferenceParticipants 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: description: Play audio to all or some participants on a conference call. operationId: PlayConferenceAudio 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_pause: post: description: Pause conference recording. operationId: PauseConferenceRecording 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/PauseConferenceRecordingRequest' 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 pause tags: - Conference Commands x-latency-category: interactive /conferences/{id}/actions/record_resume: post: description: Resume conference recording. operationId: ResumeConferenceRecording 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/ResumeConferenceRecordingRequest' 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 resume 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 (see [callback schema](https://developers.telnyx.com/api/call-control/start-conference-recording#callbacks) below):** - `conference.recording.saved`' operationId: StartConferenceRecording 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/StartConferenceRecordingRequest' 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: description: 'Stop recording the conference. **Expected Webhooks (see [callback schema](https://developers.telnyx.com/api/call-control/stop-conference-recording#callbacks) below):** - `conference.recording.saved` ' operationId: StopConferenceRecording 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: description: Convert text to speech and play it to all or some participants. operationId: SpeakTextToConference 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: description: Stop audio being played to all or some participants on a conference call. operationId: StopConferenceAudio 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: UnholdConferenceParticipants 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: UnmuteConferenceParticipants 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: UpdateConference 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/connections_FilterConsolidated' - $ref: '#/components/parameters/connections_PageConsolidated' - $ref: '#/components/parameters/connections_SortConnection' responses: '200': $ref: '#/components/responses/ListConnectionsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' summary: List connections tags: - Connections x-endpoint-cost: medium x-group-parameters: 'true' x-latency-category: responsive /connections/{connection_id}/active_calls: get: description: 'Lists all active calls for given connection. Acceptable connections are either SIP connections with webhook_url or xml_request_url, call control or texml. Returned results are cursor paginated. ' operationId: ListConnectionActiveCalls parameters: - $ref: '#/components/parameters/ConnectionId' - $ref: '#/components/parameters/call-control_PageConsolidated' responses: '200': $ref: '#/components/responses/ActiveCallsResponse' default: $ref: '#/components/responses/call-control_GenericErrorResponse' summary: List all active calls for given connection tags: - Call Information 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' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' summary: Retrieve a connection tags: - Connections x-latency-category: responsive /country_coverage: get: description: Get country coverage operationId: retreiveCountryCoverage responses: '200': $ref: '#/components/responses/CountryCoverageResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Get country coverage tags: - Country Coverage x-latency-category: responsive /country_coverage/countries/{country_code}: get: description: Get coverage for a specific country operationId: retreiveSpecificCountryCoverage parameters: - description: Country ISO code. in: path name: country_code required: true schema: example: US type: string responses: '200': $ref: '#/components/responses/SpecificCountryResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Get coverage for a specific country tags: - Country Coverage x-latency-category: responsive /credential_connections: get: description: Returns a list of your credential connections. operationId: ListCredentialConnections parameters: - $ref: '#/components/parameters/connections_FilterConsolidated' - $ref: '#/components/parameters/connections_PageConsolidated' - $ref: '#/components/parameters/connections_SortConnection' responses: '200': $ref: '#/components/responses/ListCredentialConnectionsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' 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' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' summary: Update a credential connection tags: - Credential Connections x-latency-category: responsive /credential_connections/{id}/actions/check_registration_status: post: description: Checks the registration_status for a credential connection, (`registration_status`) as well as the timestamp for the last SIP registration event (`registration_status_updated_at`) operationId: CheckRegistrationStatus parameters: - description: Identifies the resource. in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/RegistrationStatusResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' summary: Check a Credential Connection Registration Status tags: - Credential Connections x-latency-category: responsive /custom_storage_credentials/{connection_id}: delete: description: Deletes a stored custom credentials configuration. operationId: DeleteCustomStorageCredentials parameters: - $ref: '#/components/parameters/call-recordings_ConnectionId' responses: '204': description: The credentials configuration for connection_id was deleted successfully. default: $ref: '#/components/responses/GenericErrorResponse' summary: Delete a stored credential tags: - Call Recordings x-latency-category: responsive get: description: Returns the information about custom storage credentials. operationId: GetCustomStorageCredentials parameters: - $ref: '#/components/parameters/call-recordings_ConnectionId' responses: '200': $ref: '#/components/responses/CredentialsResponseBody' default: $ref: '#/components/responses/GenericErrorResponse' summary: Retrieve a stored credential tags: - Call Recordings x-latency-category: responsive post: description: Creates a custom storage credentials configuration. operationId: CreateCustomStorageCredentials parameters: - $ref: '#/components/parameters/call-recordings_ConnectionId' requestBody: $ref: '#/components/requestBodies/CreateCredentialsRequest' responses: '200': $ref: '#/components/responses/CredentialsResponseBody' default: $ref: '#/components/responses/GenericErrorResponse' summary: Create a custom storage credential tags: - Call Recordings x-latency-category: responsive put: description: Updates a stored custom credentials configuration. operationId: UpdateCustomStorageCredentials parameters: - $ref: '#/components/parameters/call-recordings_ConnectionId' requestBody: $ref: '#/components/requestBodies/CreateCredentialsRequest' responses: '200': $ref: '#/components/responses/CredentialsResponseBody' default: $ref: '#/components/responses/GenericErrorResponse' summary: Update a stored credential tags: - Call Recordings x-latency-category: responsive /customer_service_records: get: description: List customer service records. operationId: ListCustomerServiceRecords parameters: - $ref: '#/components/parameters/customer_service_record_PageConsolidated' - $ref: '#/components/parameters/customer_service_record_FilterConsolidated' - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListCustomerServiceRecords' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '422': $ref: '#/components/responses/UnprocessableEntityErrorResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' summary: List customer service records tags: - Customer Service Record x-latency-category: responsive post: description: Create a new customer service record for the provided phone number. operationId: CreateCustomerServiceRecord requestBody: $ref: '#/components/requestBodies/CreateCustomerServiceRecord' responses: '201': $ref: '#/components/responses/CreateCustomerServiceRecord' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '422': $ref: '#/components/responses/UnprocessableEntityErrorResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' summary: Create a customer service record tags: - Customer Service Record x-latency-category: responsive /customer_service_records/phone_number_coverages: post: description: Verify the coverage for a list of phone numbers. operationId: VerifyPhoneNumberCoverage requestBody: $ref: '#/components/requestBodies/VerifyCustomerServiceRecordPhoneNumberCoverage' responses: '201': $ref: '#/components/responses/ListCustomerServiceRecordPhoneNumberCoverage' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '422': $ref: '#/components/responses/UnprocessableEntityErrorResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' summary: Verify CSR phone number coverage tags: - Customer Service Record x-latency-category: responsive /customer_service_records/{customer_service_record_id}: get: description: Get a specific customer service record. operationId: GetCustomerServiceRecord parameters: - $ref: '#/components/parameters/PathCustomerServiceRecordId' responses: '201': $ref: '#/components/responses/ShowCustomerServiceRecord' '401': $ref: '#/components/responses/UnauthorizedErrorResponse' '403': $ref: '#/components/responses/ForbiddenErrorResponse' '404': $ref: '#/components/responses/ResourceNotFoundErrorResponse' '500': $ref: '#/components/responses/UnexpectedErrorResponse' summary: Get a customer service record tags: - Customer Service Record x-latency-category: responsive /detail_records: get: description: Search for any detail record across the Telnyx Platform operationId: SearchDetailRecords parameters: - description: 'Filter records on a given record attribute and value. <br/>Example: filter[status]=delivered. <br/>Required: filter[record_type] must be specified.' 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[date_range]=last_month: summary: Searches for records with timestamp starting at `00:00:00` on the first day of the month value: last_month filter[date_range]=today: summary: Searches for records with timestamp starting at `00:00:00` of the current day value: today filter[date_range]=yesterday: summary: Searches for records with timestamp starting at `00:00:00` of yesterday value: yesterday filter[direction]=inbound: summary: Searches for records which have the property `direction` equal to `inbound` value: inbound filter[record_type]=messaging: summary: Searches for messaging detail records value: messaging filter[record_type]=verify: summary: Searches for verify detail records value: verify explode: true in: query name: filter required: false schema: additionalProperties: true properties: date_range: description: 'Filter by the given user-friendly date range. You can specify one of the following enum values, or a dynamic one using this format: last_N_days.' enum: - yesterday - today - tomorrow - last_week - this_week - next_week - last_month - this_month - next_month type: string record_type: description: Filter by the given record type. enum: - ai-voice-assistant - amd - call-control - conference - conference-participant - embedding - fax - inference - inference-speech-to-text - media_storage - media-streaming - messaging - noise-suppression - recording - sip-trunking - siprec-client - stt - tts - verify - webrtc - wireless type: string required: - record_type type: object style: deepObject - description: 'Specifies the sort order for results. <br/>Example: sort=-created_at' 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 - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' examples: page[number]=1&page[size]=20: summary: Default pagination with first page and 20 items per page value: number: 1 size: 20 page[number]=1&page[size]=50: summary: First page with maximum 50 items per page value: number: 1 size: 50 page[number]=2&page[size]=20: summary: Second page with 20 items per page value: number: 2 size: 20 explode: true in: query name: page schema: properties: number: default: 1 description: Page number format: int32 minimum: 1 type: integer size: default: 20 description: Page size format: int32 maximum: 50 minimum: 1 type: integer type: object style: deepObject 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 /dialogflow_connections/{connection_id}: delete: description: Deletes a stored Dialogflow Connection. operationId: DeleteDialogflowConnection parameters: - $ref: '#/components/parameters/media-streaming_ConnectionId' responses: '204': description: The Dialogflow Connection for connection_id was deleted successfully. default: $ref: '#/components/responses/media-streaming_GenericErrorResponse' summary: Delete stored Dialogflow Connection tags: - Dialogflow Integration x-latency-category: responsive get: description: Return details of the Dialogflow connection associated with the given CallControl connection. operationId: GetDialogflowConnection parameters: - $ref: '#/components/parameters/media-streaming_ConnectionId' responses: '200': $ref: '#/components/responses/DialogflowConnectionResponseBody' default: $ref: '#/components/responses/media-streaming_GenericErrorResponse' summary: Retrieve stored Dialogflow Connection tags: - Dialogflow Integration x-latency-category: responsive post: description: Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services. operationId: CreateDialogflowConnection parameters: - $ref: '#/components/parameters/media-streaming_ConnectionId' requestBody: $ref: '#/components/requestBodies/DialogflowConnectionRequest' responses: '201': $ref: '#/components/responses/DialogflowConnectionResponseBody' default: $ref: '#/components/responses/media-streaming_GenericErrorResponse' summary: Create a Dialogflow Connection tags: - Dialogflow Integration x-latency-category: responsive put: description: Updates a stored Dialogflow Connection. operationId: UpdateDialogflowConnection parameters: - $ref: '#/components/parameters/media-streaming_ConnectionId' requestBody: $ref: '#/components/requestBodies/DialogflowConnectionRequest' responses: '200': $ref: '#/components/responses/DialogflowConnectionResponseBody' default: $ref: '#/components/responses/media-streaming_GenericErrorResponse' summary: Update stored Dialogflow Connection tags: - Dialogflow Integration x-latency-category: responsive /document_links: get: description: List all documents links ordered by created_at descending. operationId: ListDocumentLinks parameters: - $ref: '#/components/parameters/FilterDocumentLinksConsolidated' - $ref: '#/components/parameters/documents_PageConsolidated' responses: '200': $ref: '#/components/responses/ListDocServiceDocumentLinksResponse' default: $ref: '#/components/responses/documents_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/FilterDocumentsConsolidated' - $ref: '#/components/parameters/SortDocumentsConsolidated' - $ref: '#/components/parameters/documents_PageConsolidated' responses: '200': $ref: '#/components/responses/ListDocServiceDocumentsResponse' default: $ref: '#/components/responses/documents_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/documents_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/documents_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/documents_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/documents_GenericErrorResponse' summary: Update a document tags: - Documents x-latency-category: responsive /documents/{id}/download: get: description: Download a document. operationId: DownloadDocument parameters: - $ref: '#/components/parameters/Id' responses: '200': $ref: '#/components/responses/DownloadDocServiceDocumentResponse' default: $ref: '#/components/responses/documents_GenericErrorResponse' summary: Download a document tags: - Documents x-latency-category: responsive /documents/{id}/download_link: get: description: Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication. operationId: getDocumentDownloadLink parameters: - description: Uniquely identifies the document in: path name: id required: true schema: example: 550e8400-e29b-41d4-a716-446655440000 format: uuid type: string responses: '200': content: application/json: schema: properties: data: properties: url: description: Pre-signed temporary URL for downloading the document example: https://s3.amazonaws.com/bucket/path/to/document?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=... format: uri type: string required: - url type: object required: - data type: object description: Successfully generated download link '404': $ref: '#/components/responses/ResourceNotFound' '422': $ref: '#/components/responses/UnprocessableEntity' default: $ref: '#/components/responses/documents_GenericErrorResponse' summary: Generate a temporary download link for a document tags: - Documents x-latency-category: responsive /dynamic_emergency_addresses: get: description: Returns the dynamic emergency addresses according to filters operationId: ListDynamicEmergencyAddresses parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[status], filter[country_code]' explode: true in: query name: filter schema: properties: country_code: description: Filter by country code. type: string status: description: Filter by status. enum: - pending - activated - rejected type: string type: object style: deepObject - $ref: '#/components/parameters/emergency_PageConsolidated' responses: '200': $ref: '#/components/responses/listDynamicEmergencyAddresses' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: List dynamic emergency addresses tags: - Dynamic Emergency Addresses x-latency-category: responsive post: description: Creates a dynamic emergency address. operationId: CreateDynamicEmergencyAddress requestBody: content: application/json: schema: $ref: '#/components/schemas/DynamicEmergencyAddress' required: true responses: '201': $ref: '#/components/responses/DynamicEmergencyAddressResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a dynamic emergency address. tags: - Dynamic Emergency Addresses x-latency-category: responsive /dynamic_emergency_addresses/{id}: delete: description: Deletes the dynamic emergency address based on the ID provided operationId: DeleteDynamicEmergencyAddress parameters: - description: Dynamic Emergency Address id in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/DynamicEmergencyAddressResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Delete a dynamic emergency address tags: - Dynamic Emergency Addresses x-latency-category: responsive get: description: Returns the dynamic emergency address based on the ID provided operationId: GetDynamicEmergencyAddress parameters: - description: Dynamic Emergency Address id in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/DynamicEmergencyAddressResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Get a dynamic emergency address tags: - Dynamic Emergency Addresses x-latency-category: responsive /dynamic_emergency_endpoints: get: description: Returns the dynamic emergency endpoints according to filters operationId: ListDynamicEmergencyEndpoints parameters: - $ref: '#/components/parameters/emergency_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[status], filter[country_code]' explode: true in: query name: filter schema: properties: country_code: description: Filter by country code. type: string status: description: Filter by status. enum: - pending - activated - rejected type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/listDynamicEmergencyEndpoints' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: List dynamic emergency endpoints tags: - Dynamic Emergency Endpoints x-latency-category: responsive post: description: Creates a dynamic emergency endpoints. operationId: CreateDynamicEmergencyEndpoint requestBody: content: application/json: schema: $ref: '#/components/schemas/DynamicEmergencyEndpoint' required: true responses: '201': $ref: '#/components/responses/DynamicEmergencyEndpointResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a dynamic emergency endpoint. tags: - Dynamic Emergency Endpoints x-latency-category: responsive /dynamic_emergency_endpoints/{id}: delete: description: Deletes the dynamic emergency endpoint based on the ID provided operationId: DeleteDynamicEmergencyEndpoint parameters: - description: Dynamic Emergency Endpoint id in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/DynamicEmergencyEndpointResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Delete a dynamic emergency endpoint tags: - Dynamic Emergency Endpoints x-latency-category: responsive get: description: Returns the dynamic emergency endpoint based on the ID provided operationId: GetDynamicEmergencyEndpoint parameters: - description: Dynamic Emergency Endpoint id in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/DynamicEmergencyEndpointResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Get a dynamic emergency endpoint tags: - Dynamic Emergency Endpoints x-latency-category: responsive /enum/{endpoint}: get: operationId: GetEnumEndpoint parameters: - in: path name: endpoint required: true schema: enum: - mno - optionalAttributes - usecase - vertical - altBusinessIdType - brandIdentityStatus - brandRelationship - campaignStatus - entityType - extVettingProvider - vettingStatus - brandStatus - operationStatus - approvedPublicCompany - stockExchange - vettingClass title: Endpoint type: string responses: '200': content: application/json: schema: oneOf: - $ref: '#/components/schemas/EnumListResponse' - $ref: '#/components/schemas/EnumObjectResponse' - $ref: '#/components/schemas/EnumPaginatedResponse' description: Successful Response '404': content: application/json: schema: $ref: '#/components/schemas/10dlc_Errors' description: Resource not found summary: Get Enum tags: - Enum x-latency-category: responsive /external_connections: get: description: This endpoint returns a list of your External Connections inside the 'data' attribute of the response. External Connections are used by Telnyx customers to seamless configure SIP trunking integrations with Telnyx Partners, through External Voice Integrations in Mission Control Portal. operationId: ListExternalConnections parameters: - $ref: '#/components/parameters/FilterConnectionsConsolidated' - $ref: '#/components/parameters/external-voice-integrations_PageConsolidated' responses: '200': $ref: '#/components/responses/GetAllExternalConnectionResponse' '400': description: Bad request '401': description: Unauthorized '404': description: Resource not found summary: List all External Connections tags: - External Connections x-endpoint-cost: medium x-latency-category: responsive post: description: Creates a new External Connection based on the parameters sent in the request. The external_sip_connection and outbound voice profile id are required. Once created, you can assign phone numbers to your application using the `/phone_numbers` endpoint. operationId: CreateExternalConnection parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalConnectionRequest' description: Parameters that can be set when creating a External Connection required: true responses: '201': $ref: '#/components/responses/ExternalConnectionResponse' '422': description: Bad request summary: Creates an External Connection tags: - External Connections x-endpoint-cost: medium x-latency-category: responsive /external_connections/log_messages: get: description: Retrieve a list of log messages for all external connections associated with your account. operationId: ListExternalConnectionLogMessages parameters: - $ref: '#/components/parameters/FilterLogMessagesConsolidated' - $ref: '#/components/parameters/external-voice-integrations_PageConsolidated' responses: '200': $ref: '#/components/responses/ListLogMessagesResponse' '401': description: Unauthorized '422': description: Bad request summary: List all log messages tags: - External Connections x-latency-category: responsive /external_connections/log_messages/{id}: delete: description: Dismiss a log message for an external connection associated with your account. operationId: DeleteExternalConnectionLogMessage parameters: - $ref: '#/components/parameters/external-voice-integrations_id' responses: '200': content: application/json: schema: properties: success: description: Describes wether or not the operation was successful type: boolean title: Dismiss request was successful type: object description: Successful response '401': description: Unauthorized '404': description: Resource not found summary: Dismiss a log message tags: - External Connections x-latency-category: responsive get: description: Retrieve a log message for an external connection associated with your account. operationId: GetExternalConnectionLogMessage parameters: - $ref: '#/components/parameters/external-voice-integrations_id' responses: '200': $ref: '#/components/responses/GetLogMessageResponse' '401': description: Unauthorized '404': description: Resource not found summary: Retrieve a log message tags: - External Connections x-latency-category: responsive /external_connections/{id}: delete: description: Permanently deletes an External Connection. Deletion may be prevented if the application is in use by phone numbers, is active, or if it is an Operator Connect connection. To remove an Operator Connect integration please contact Telnyx support. operationId: DeleteExternalConnection parameters: - $ref: '#/components/parameters/external-voice-integrations_id' responses: '200': $ref: '#/components/responses/ExternalConnectionResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Bad request summary: Deletes an External Connection tags: - External Connections x-latency-category: responsive get: description: Return the details of an existing External Connection inside the 'data' attribute of the response. operationId: GetExternalConnection parameters: - $ref: '#/components/parameters/external-voice-integrations_id' responses: '200': $ref: '#/components/responses/ExternalConnectionResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Bad request summary: Retrieve an External Connection tags: - External Connections x-latency-category: responsive patch: description: Updates settings of an existing External Connection based on the parameters of the request. operationId: UpdateExternalConnection parameters: - $ref: '#/components/parameters/external-voice-integrations_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExternalConnectionRequest' description: Parameters to be updated for the External Connection required: true responses: '200': $ref: '#/components/responses/ExternalConnectionResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Bad request summary: Update an External Connection tags: - External Connections x-latency-category: responsive /external_connections/{id}/civic_addresses: get: description: Returns the civic addresses and locations from Microsoft Teams. operationId: ListCivicAddresses parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/FilterCivicAddressesConsolidated' responses: '200': $ref: '#/components/responses/GetAllCivicAddressesResponse' '401': description: Unauthorized '404': description: Not found '500': description: Unexpected Error '502': description: Bad Gateway summary: List all civic addresses and locations tags: - External Connections x-latency-category: responsive /external_connections/{id}/civic_addresses/{address_id}: get: description: Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response. operationId: GetExternalConnectionCivicAddress parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/address_id' responses: '200': $ref: '#/components/responses/GetCivicAddressResponse' '401': description: Unauthorized '404': description: Not found '500': description: Unexpected Error '502': description: Bad Gateway summary: Retrieve a Civic Address tags: - External Connections x-latency-category: responsive /external_connections/{id}/locations/{location_id}: patch: operationId: updateLocation parameters: - description: The ID of the external connection in: path name: id required: true schema: format: uuid type: string - description: The ID of the location to update in: path name: location_id required: true schema: format: uuid type: string requestBody: content: application/json: schema: properties: static_emergency_address_id: description: A new static emergency address ID to update the location with format: uuid type: string required: - static_emergency_address_id type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LocationResponse' description: Location successfully updated with no associated orders to process '202': content: application/json: schema: $ref: '#/components/schemas/LocationResponse' description: Location update accepted; associated orders being processed '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Location or external connection not found '422': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Unprocessable Entity - Location already has an accepted emergency address summary: Update a location's static emergency address tags: - External Connections x-latency-category: responsive /external_connections/{id}/phone_numbers: get: description: Returns a list of all active phone numbers associated with the given external connection. operationId: ListExternalConnectionPhoneNumbers parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/FilterPhoneNumbersConsolidated' - $ref: '#/components/parameters/external-voice-integrations_PageConsolidated' responses: '200': $ref: '#/components/responses/ListExternalConnectionPhoneNumbersResponse' '401': description: Unauthorized '404': description: Not found '422': description: Bad request summary: List all phone numbers tags: - External Connections x-latency-category: responsive /external_connections/{id}/phone_numbers/{phone_number_id}: get: description: Return the details of a phone number associated with the given external connection. operationId: GetExternalConnectionPhoneNumber parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/phone_number_id' responses: '200': $ref: '#/components/responses/GetExternalConnectionPhoneNumberResponse' '401': description: Unauthorized '404': description: Not found summary: Retrieve a phone number tags: - External Connections x-latency-category: responsive patch: description: Asynchronously update settings of the phone number associated with the given external connection. operationId: UpdateExternalConnectionPhoneNumber parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/phone_number_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExternalConnectionPhoneNumberRequest' description: Values that can be set when updating a phone number required: true responses: '200': $ref: '#/components/responses/GetExternalConnectionPhoneNumberResponse' '401': description: Unauthorized '404': description: Not found '422': description: Bad request summary: Update a phone number tags: - External Connections x-latency-category: responsive /external_connections/{id}/releases: get: description: Returns a list of your Releases for the given external connection. These are automatically created when you change the `connection_id` of a phone number that is currently on Microsoft Teams. operationId: ListExternalConnectionReleases parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/FilterReleasesConsolidated' - $ref: '#/components/parameters/external-voice-integrations_PageConsolidated' responses: '200': $ref: '#/components/responses/ListReleasesResponse' '401': description: Unauthorized '404': description: Not found '422': description: Bad request summary: List all Releases tags: - External Connections x-latency-category: responsive /external_connections/{id}/releases/{release_id}: get: description: Return the details of a Release request and its phone numbers. operationId: GetExternalConnectionRelease parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/release_id' responses: '200': $ref: '#/components/responses/GetReleaseResponse' '401': description: Unauthorized '404': description: Not found summary: Retrieve a Release request tags: - External Connections x-latency-category: responsive /external_connections/{id}/uploads: get: description: Returns a list of your Upload requests for the given external connection. operationId: ListExternalConnectionUploads parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/FilterUploadsConsolidated' - $ref: '#/components/parameters/external-voice-integrations_PageConsolidated' responses: '200': $ref: '#/components/responses/ListUploadsResponse' '401': description: Unauthorized '404': description: Not found '422': description: Bad request summary: List all Upload requests tags: - External Connections x-latency-category: responsive post: description: Creates a new Upload request to Microsoft teams with the included phone numbers. Only one of civic_address_id or location_id must be provided, not both. The maximum allowed phone numbers for the numbers_ids array is 1000. operationId: CreateExternalConnectionUpload parameters: - $ref: '#/components/parameters/external-voice-integrations_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalConnectionUploadRequest' description: Parameters that can be set when creating an Upload request. required: true responses: '202': content: application/json: schema: properties: success: description: Describes wether or not the operation was successful type: boolean ticket_id: description: Ticket id of the upload request format: uuid type: string title: Create Upload request Response type: object description: Successful response '401': description: Unauthorized '404': description: Not found '413': description: Payload too large. The maximum allowed phone numbers for the numbers_ids array is 1000. '422': description: Unprocessable Entity '504': description: Gateway Timeout summary: Creates an Upload request tags: - External Connections x-latency-category: responsive /external_connections/{id}/uploads/refresh: post: description: Forces a recheck of the status of all pending Upload requests for the given external connection in the background. operationId: RefreshExternalConnectionUploads parameters: - $ref: '#/components/parameters/external-voice-integrations_id' responses: '200': content: application/json: schema: properties: success: description: Describes wether or not the operation was successful type: boolean title: Create Upload request Response type: object description: Successful response '401': description: Unauthorized '404': description: Not found '409': description: Status refresh is still in progress, please wait before calling again summary: Refresh the status of all Upload requests tags: - External Connections x-latency-category: responsive /external_connections/{id}/uploads/status: get: description: Returns the count of all pending upload requests for the given external connection. operationId: GetExternalConnectionUploadsStatus parameters: - $ref: '#/components/parameters/external-voice-integrations_id' responses: '200': $ref: '#/components/responses/GetUploadsStatusResponse' '401': description: Unauthorized '404': description: Not found summary: Get the count of pending upload requests tags: - External Connections x-latency-category: responsive /external_connections/{id}/uploads/{ticket_id}: get: description: Return the details of an Upload request and its phone numbers. operationId: GetExternalConnectionUpload parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/ticket_id' responses: '200': $ref: '#/components/responses/GetUploadResponse' '401': description: Unauthorized '404': description: Not found summary: Retrieve an Upload request tags: - External Connections x-latency-category: responsive /external_connections/{id}/uploads/{ticket_id}/retry: post: description: If there were any errors during the upload process, this endpoint will retry the upload request. In some cases this will reattempt the existing upload request, in other cases it may create a new upload request. Please check the ticket_id in the response to determine if a new upload request was created. operationId: RetryUpload parameters: - $ref: '#/components/parameters/external-voice-integrations_id' - $ref: '#/components/parameters/ticket_id' responses: '202': $ref: '#/components/responses/GetUploadResponse' '401': description: Unauthorized '404': description: Not found '409': description: Order is still in progress, please wait before retrying '422': description: Unprocessable Entity summary: Retry an Upload request tags: - External Connections 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/PageConsolidated' - $ref: '#/components/parameters/programmable-fax_FilterConsolidated' - $ref: '#/components/parameters/programmable-fax_SortApplication' responses: '200': $ref: '#/components/responses/GetAllFaxApplicationsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '422': $ref: '#/components/responses/UnprocessableEntityResponse' 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' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/programmable-fax_NotFoundResponse' 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' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/programmable-fax_NotFoundResponse' 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': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/programmable-fax_NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableEntityResponse' summary: Update a Fax Application tags: - Programmable Fax Applications x-latency-category: responsive /faxes: get: description: '' operationId: ListFaxes parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[created_at][gte], filter[created_at][gt], filter[created_at][lte], filter[created_at][lt], filter[direction][eq], filter[from][eq], filter[to][eq]' explode: true in: query name: filter schema: properties: created_at: description: Date range filtering operations for fax creation timestamp properties: gt: description: ISO 8601 date time for filtering faxes created after that date example: '2020-02-02T22:25:27.521992Z' format: date-time type: string gte: description: ISO 8601 date time for filtering faxes created after or on that date example: '2020-02-02T22:25:27.521992Z' format: date-time type: string lt: description: ISO 8601 formatted date time for filtering faxes created before that date example: '2020-02-02T22:25:27.521992Z' format: date-time type: string lte: description: ISO 8601 formatted date time for filtering faxes created on or before that date example: '2020-02-02T22:25:27.521992Z' format: date-time type: string type: object direction: description: Direction filtering operations properties: eq: description: The direction, inbound or outbound, for filtering faxes sent from this account example: inbound type: string type: object from: description: From number filtering operations properties: eq: description: The phone number, in E.164 format for filtering faxes sent from this number example: '+13127367276' type: string type: object to: description: To number filtering operations properties: eq: description: The phone number, in E.164 format for filtering faxes sent to this number example: '+13127367276' type: string type: object type: object style: deepObject - description: 'Consolidated pagination parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: description: Number of the page to be retrieved example: 2 type: integer size: description: Number of fax resources for the single page returned example: 2 type: integer type: object style: deepObject responses: '200': $ref: '#/components/responses/ListFaxesResponse' default: $ref: '#/components/responses/programmable-fax_GenericErrorResponse' summary: View a list of faxes tags: - Programmable Fax Commands x-latency-category: background post: description: "Send a fax. Files have size limits and page count limit validations.\ \ If a file is bigger than 50MB or has more than 350 pages it will fail with\ \ `file_size_limit_exceeded` and `page_count_limit_exceeded` respectively.\ \ \n\n**Expected Webhooks:**\n\n- `fax.queued`\n- `fax.media.processed`\n\ - `fax.sending.started`\n- `fax.delivered`\n- `fax.failed`\n" 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/programmable-fax_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/programmable-fax_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/programmable-fax_GenericErrorResponse' summary: View a fax tags: - Programmable Fax Commands x-latency-category: responsive /faxes/{id}/actions/cancel: post: description: 'Cancel the outbound fax that is in one of the following states: `queued`, `media.processed`, `originated` or `sending` ' operationId: CancelFax parameters: - description: The unique identifier of a fax. in: path name: id required: true schema: format: uuid type: string responses: '202': $ref: '#/components/responses/CancelFaxResponse' '404': $ref: '#/components/responses/programmable-fax_NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableEntityResponse' default: $ref: '#/components/responses/programmable-fax_GenericErrorResponse' summary: Cancel 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/programmable-fax_NotFoundResponse' default: $ref: '#/components/responses/programmable-fax_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/connections_FilterConsolidated' - $ref: '#/components/parameters/connections_PageConsolidated' - $ref: '#/components/parameters/connections_SortConnection' responses: '200': $ref: '#/components/responses/ListFqdnConnectionsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' 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: - $ref: '#/components/parameters/connections_id' responses: '200': $ref: '#/components/responses/FqdnConnectionResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' 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: - $ref: '#/components/parameters/connections_id' responses: '200': $ref: '#/components/responses/FqdnConnectionResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' summary: Retrieve an FQDN connection tags: - FQDN Connections x-latency-category: responsive patch: description: Updates settings of an existing FQDN connection. operationId: UpdateFqdnConnection parameters: - $ref: '#/components/parameters/connections_id' 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': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' 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/connections_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[connection_id], filter[fqdn], filter[port], filter[dns_record_type]' explode: true in: query name: filter schema: properties: connection_id: description: ID of the FQDN connection to which the FQDN belongs. type: string dns_record_type: description: DNS record type used by the FQDN. example: a type: string fqdn: description: FQDN represented by the resource. example: example.com type: string port: description: Port to use when connecting to the FQDN. example: 5060 type: integer type: object style: deepObject responses: '200': $ref: '#/components/responses/ListFqdnsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' 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': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' summary: Update an FQDN tags: - FQDNs x-latency-category: responsive /global_ip_allowed_ports: get: description: List all Global IP Allowed Ports operationId: ListGlobalIpAllowedPorts responses: '200': $ref: '#/components/responses/GlobalIpAllowedPortListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Global IP Allowed Ports tags: - Global IPs x-latency-category: responsive /global_ip_assignment_health: description: Global IP Assignment Health Check Metrics over time get: operationId: GetGlobalIpAssignmentHealth parameters: - $ref: '#/components/parameters/netapps_FilterConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in], filter[global_ip_assignment_id][in]' explode: true in: query name: filter schema: additionalProperties: false properties: global_ip_assignment_id: oneOf: - description: Filter by exact Global IP Assignment ID type: string - additionalProperties: false description: Filtering operations properties: in: description: Filter by Global IP Assignment ID(s) separated by commas type: string type: object global_ip_id: oneOf: - description: Filter by exact Global IP ID type: string - additionalProperties: false description: Filtering operations properties: in: description: Filter by Global IP ID(s) separated by commas type: string type: object type: object style: deepObject responses: '200': $ref: '#/components/responses/GlobalIpHealthResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Global IP Assignment Health Check Metrics tags: - Global IPs x-latency-category: responsive /global_ip_assignments: get: description: List all Global IP assignments. operationId: ListGlobalIpAssignments parameters: - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/GlobalIpAssignmentListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Global IP assignments tags: - Global IPs x-latency-category: responsive post: description: Create a Global IP assignment. operationId: CreateGlobalIpAssignment requestBody: content: application/json: schema: $ref: '#/components/schemas/GlobalIpAssignment' required: true responses: '202': $ref: '#/components/responses/GlobalIpAssignmentResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create a Global IP assignment tags: - Global IPs x-latency-category: responsive /global_ip_assignments/{id}: delete: description: Delete a Global IP assignment. operationId: DeleteGlobalIpAssignment parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GlobalIpAssignmentResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete a Global IP assignment tags: - Global IPs x-latency-category: responsive get: description: Retrieve a Global IP assignment. operationId: GetGlobalIpAssignment parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GlobalIpAssignmentResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve a Global IP tags: - Global IPs x-latency-category: responsive patch: description: Update a Global IP assignment. operationId: UpdateGlobalIpAssignment parameters: - $ref: '#/components/parameters/ResourceId' requestBody: content: application/json: schema: $ref: '#/components/schemas/GlobalIpAssignmentUpdate' required: true responses: '200': $ref: '#/components/responses/GlobalIpAssignmentResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Update a Global IP assignment tags: - Global IPs x-latency-category: responsive /global_ip_assignments_usage: description: Global IP Assignment Usage Metrics over time get: operationId: GetGlobalIpAssignmentUsage parameters: - $ref: '#/components/parameters/netapps_FilterConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[global_ip_assignment_id][in], filter[global_ip_id][in]' explode: true in: query name: filter schema: additionalProperties: false properties: global_ip_assignment_id: oneOf: - description: Filter by exact Global IP Assignment ID type: string - additionalProperties: false description: Filtering operations properties: in: description: Filter by Global IP Assignment ID(s) separated by commas type: string type: object global_ip_id: oneOf: - description: Filter by exact Global IP ID type: string - additionalProperties: false description: Filtering operations properties: in: description: Filter by Global IP ID(s) separated by commas type: string type: object type: object style: deepObject responses: '200': $ref: '#/components/responses/GlobalIpAssignmentUsageResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Global IP Assignment Usage Metrics tags: - Global IPs x-latency-category: responsive /global_ip_health_check_types: get: description: List all Global IP Health check types. operationId: ListGlobalIpHealthCheckTypes responses: '200': $ref: '#/components/responses/GlobalIpHealthCheckTypesResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Global IP Health check types tags: - Global IPs x-latency-category: responsive /global_ip_health_checks: get: description: List all Global IP health checks. operationId: ListGlobalIpHealthChecks parameters: - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/GlobalIpHealthCheckListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Global IP health checks tags: - Global IPs x-latency-category: responsive post: description: Create a Global IP health check. operationId: CreateGlobalIpHealthCheck requestBody: content: application/json: schema: $ref: '#/components/schemas/GlobalIPHealthCheck' required: true responses: '202': $ref: '#/components/responses/GlobalIpHealthCheckResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create a Global IP health check tags: - Global IPs x-latency-category: responsive /global_ip_health_checks/{id}: delete: description: Delete a Global IP health check. operationId: DeleteGlobalIpHealthCheck parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GlobalIpHealthCheckResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete a Global IP health check tags: - Global IPs x-latency-category: responsive get: description: Retrieve a Global IP health check. operationId: GetGlobalIpHealthCheck parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GlobalIpHealthCheckResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve a Global IP health check tags: - Global IPs x-latency-category: responsive /global_ip_latency: description: Global IP Latency Metrics over time get: operationId: GetGlobalIpLatency parameters: - $ref: '#/components/parameters/netapps_FilterConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in]' explode: true in: query name: filter schema: additionalProperties: false properties: global_ip_id: oneOf: - description: Filter by exact Global IP ID type: string - additionalProperties: false description: Filtering operations properties: in: description: Filter by Global IP ID(s) separated by commas type: string type: object type: object style: deepObject responses: '200': $ref: '#/components/responses/GlobalIpLatencyResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Global IP Latency Metrics tags: - Global IPs x-latency-category: responsive /global_ip_protocols: get: description: List all Global IP Protocols operationId: ListGlobalIpProtocols responses: '200': $ref: '#/components/responses/GlobalIpProtocolListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Global IP Protocols tags: - Global IPs x-latency-category: responsive /global_ip_usage: description: Global IP Usage Metrics over time get: operationId: GetGlobalIpUsage parameters: - $ref: '#/components/parameters/netapps_FilterConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in]' explode: true in: query name: filter schema: additionalProperties: false properties: global_ip_id: oneOf: - description: Filter by exact Global IP ID type: string - additionalProperties: false description: Filtering operations properties: in: description: Filter by Global IP ID(s) separated by commas type: string type: object type: object style: deepObject responses: '200': $ref: '#/components/responses/GlobalIpUsageResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Global IP Usage Metrics tags: - Global IPs x-latency-category: responsive /global_ips: get: description: List all Global IPs. operationId: ListGlobalIps parameters: - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/GlobalIpListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Global IPs tags: - Global IPs x-latency-category: responsive post: description: Create a Global IP. operationId: CreateGlobalIp requestBody: content: application/json: schema: $ref: '#/components/schemas/GlobalIP' required: true responses: '202': $ref: '#/components/responses/GlobalIpResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create a Global IP tags: - Global IPs x-latency-category: responsive /global_ips/{id}: delete: description: Delete a Global IP. operationId: DeleteGlobalIp parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GlobalIpResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete a Global IP tags: - Global IPs x-latency-category: responsive get: description: Retrieve a Global IP. operationId: GetGlobalIp parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GlobalIpResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve a Global IP tags: - Global IPs x-latency-category: responsive /inbound_channels: get: description: Returns the US Zone voice channels for your account. voice channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the <a href="https://support.telnyx.com/en/articles/8428806-global-channel-billing">Telnyx Support Articles</a> section for full information and examples of how to utilize Channel Billing. operationId: ListInboundChannels 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: voice channels Response '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: List your voice channels for US Zone tags: - Voice Channels x-endpoint-cost: medium x-latency-category: interactive patch: description: Update the number of Voice Channels for the US Zone. This allows your account to handle multiple simultaneous inbound calls to US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume. 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: Voice 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: 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. type: string type: object title: type: string required: - code - title type: array description: Unexpected error summary: Update voice channels for US Zone tags: - Voice Channels x-endpoint-cost: medium x-latency-category: interactive /integration_secrets: get: description: Retrieve a list of all integration secrets configured by the user. operationId: list_integration_secrets parameters: - description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' examples: page[number]=1&page[size]=20: summary: First page with 20 results per page value: number: 1 size: 20 page[number]=1&page[size]=50: summary: First page with 50 results per page value: number: 1 size: 50 page[number]=2&page[size]=20: summary: Second page with 20 results per page value: number: 2 size: 20 explode: true in: query name: page schema: properties: number: example: 1 title: Page Number type: integer size: example: 25 title: Page Size type: integer type: object style: deepObject - description: 'Consolidated filter parameter (deepObject style). Originally: filter[type]' examples: filter[type]=basic: summary: Filter results to only show basic authentication type secrets value: type: basic filter[type]=bearer: summary: Filter results to only show bearer type secrets value: type: bearer explode: true in: query name: filter schema: properties: type: enum: - bearer - basic example: bearer title: Filter by type type: string type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntegrationSecretsListData' description: Successful Response summary: List integration secrets tags: - Integration Secrets x-latency-category: responsive post: description: Create a new secret with an associated identifier that can be used to securely integrate with other services. operationId: create_integration_secret requestBody: content: application/json: examples: basic: value: identifier: my_secret password: my_password type: basic username: my_username bearer: value: identifier: my_secret token: my_secret_value type: bearer schema: $ref: '#/components/schemas/CreateIntegrationSecretRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/IntegrationSecretCreatedResponse' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/integration-secrets_ErrorResponse' description: Validation Error summary: Create a secret tags: - Integration Secrets x-latency-category: responsive /integration_secrets/{id}: delete: description: Delete an integration secret given its ID. operationId: delete_integration_secret parameters: - in: path name: id required: true schema: title: Secret Id type: string responses: '204': description: The resource was deleted successfully. '404': content: application/json: schema: $ref: '#/components/schemas/integration-secrets_ErrorResponse' description: Secret Not found summary: Delete an integration secret tags: - Integration Secrets 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: CreateInventoryCoverage parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[npa], filter[nxx], filter[administrative_area], filter[phone_number_type], filter[country_code], filter[count], filter[features], filter[groupBy]' explode: true in: query name: filter schema: properties: administrative_area: description: Filter by administrative area type: string count: description: Include count in the result type: boolean country_code: description: Filter by country. Defaults to US enum: - AT - AU - BE - BG - CA - CH - CN - CY - CZ - DE - DK - EE - ES - FI - FR - GB - GR - HU - HR - IE - IT - LT - LU - LV - NL - NZ - MX - 'NO' - PL - PT - RO - SE - SG - SI - SK - US type: string features: description: Filter if the phone number should be used for voice, fax, mms, sms, emergency. Returns features in the response when used. example: voice,sms items: enum: - sms - mms - voice - fax - emergency type: string type: array groupBy: description: Filter to group results enum: - locality - npa - national_destination_code type: string npa: description: Filter by npa type: integer nxx: description: Filter by nxx type: integer phone_number_type: description: Filter by phone number type enum: - local - toll_free - national - mobile - landline - shared_cost type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/InventoryCoverageResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Create an inventory coverage request tags: - Inventory Level x-latency-category: responsive /invoices: get: description: Retrieve a paginated list of invoices. parameters: - description: Specifies the sort order for results. in: query name: sort required: false schema: enum: - period_start - -period_start example: period_start type: string - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 20 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/Invoice' type: array meta: properties: page_number: example: 1 type: integer page_size: example: 20 type: integer total_pages: example: 1 type: integer total_results: example: 20 type: integer type: object type: object description: List of invoices default: $ref: '#/components/responses/invoice_GenericErrorResponse' summary: List invoices x-latency-category: responsive /invoices/{id}: get: description: Retrieve a single invoice by its unique identifier. parameters: - description: Invoice UUID in: path name: id required: true schema: format: uuid type: string - description: Invoice action in: query name: action required: false schema: enum: - json - link example: json type: string responses: '200': $ref: '#/components/responses/InvoiceDetailResponse' default: $ref: '#/components/responses/invoice_GenericErrorResponse' summary: Get invoice by ID x-latency-category: responsive /ip_connections: get: description: Returns a list of your IP connections. operationId: ListIpConnections parameters: - $ref: '#/components/parameters/connections_FilterConsolidated' - $ref: '#/components/parameters/connections_PageConsolidated' - $ref: '#/components/parameters/connections_SortConnection' responses: '200': $ref: '#/components/responses/ListIpConnectionsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' 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' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' 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/connections_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[connection_id], filter[ip_address], filter[port]' explode: true in: query name: filter schema: 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: description: Port to use when connecting to this IP. example: 5060 type: integer type: object style: deepObject responses: '200': $ref: '#/components/responses/ListIpsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' 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': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/connections_UnauthorizedResponse' '404': $ref: '#/components/responses/connections_NotFoundResponse' '422': $ref: '#/components/responses/connections_UnprocessableEntityResponse' summary: Update an Ip tags: - IPs x-latency-category: responsive /ledger_billing_group_reports: post: deprecated: false description: '' operationId: CreateBillingGroupReport parameters: [] requestBody: content: application/json: example: month: 10 year: 2019 schema: $ref: '#/components/schemas/NewLedgerBillingGroupReport' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/LedgerBillingGroupReport' type: object description: Expected ledger billing group report response to a valid request headers: {} '500': content: application/json: schema: $ref: '#/components/schemas/billing-group_Errors' description: Unexpected error headers: {} summary: Create a ledger billing group report tags: - Reports x-latency-category: responsive /ledger_billing_group_reports/{id}: get: deprecated: false description: '' operationId: GetBillingGroupReport parameters: - description: The id of the ledger billing group report example: f5586561-8ff0-4291-a0ac-84fe544797bd in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/LedgerBillingGroupReport' type: object description: Expected ledger billing group report response to a valid request headers: {} '500': content: application/json: schema: $ref: '#/components/schemas/billing-group_Errors' description: Unexpected error headers: {} summary: Get a ledger billing group report tags: - Reports x-latency-category: responsive /list: get: description: Retrieve a list of all phone numbers using Channel Billing, grouped by Zone. operationId: GetAllNumbersChannelZones responses: '200': $ref: '#/components/responses/GetGcbNumbersResponse' summary: List All Numbers using Channel Billing tags: - Voice Channels x-latency-category: interactive /list/{channel_zone_id}: get: description: Retrieve a list of phone numbers using Channel Billing for a specific Zone. operationId: GetNumbersChannelZones parameters: - $ref: '#/components/parameters/GcbChannelNumberZoneId' responses: '200': $ref: '#/components/responses/GetGcbNumbersResponse' summary: List Numbers using Channel Billing for a specific Zone tags: - Voice Channels x-latency-category: interactive /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/managed-accounts_FilterConsolidated' - $ref: '#/components/parameters/PageConsolidated' - $ref: '#/components/parameters/managed-accounts_Sort' - $ref: '#/components/parameters/IncludeCancelledAccounts' responses: '200': $ref: '#/components/responses/ListManagedAccountsResponse' '401': $ref: '#/components/responses/managed-accounts_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/managed-accounts_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/allocatable_global_outbound_channels: get: description: Display information about allocatable global outbound channels for the current user. Only usable by account managers. operationId: ListAllocatableGlobalOutboundChannels responses: '200': $ref: '#/components/responses/ListManagedAccountsAllocatableGlobalOutboundChannelsResponse' '401': $ref: '#/components/responses/managed-accounts_UnauthorizedResponse' '403': $ref: '#/components/responses/ForbiddenResponse' summary: Display information about allocatable global outbound channels for the current user. 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/managed-accounts_UnauthorizedResponse' '404': description: Resource not found summary: Retrieve a managed account tags: - Managed Accounts x-latency-category: responsive patch: description: Update a single managed account. operationId: UpdateManagedAccount parameters: - description: Managed Account User ID in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateManagedAccountRequest' description: Parameters that define the updates to the managed account required: true responses: '200': $ref: '#/components/responses/ManagedAccountResponse' '401': $ref: '#/components/responses/managed-accounts_UnauthorizedResponse' '404': description: Resource not found '422': $ref: '#/components/responses/UnprocessableManagedAccountEntity' summary: Update 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 no longer 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/managed-accounts_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 requestBody: content: application/json: schema: properties: reenable_all_connections: default: false description: 'When true, all connections owned by this managed account will automatically be re-enabled. Note: Any connections that do not pass validations will not be re-enabled.' example: true type: boolean type: object description: Additional parameters for what to do when enabling the managed account required: false responses: '200': $ref: '#/components/responses/ManagedAccountResponse' '401': $ref: '#/components/responses/managed-accounts_UnauthorizedResponse' '404': description: Resource not found '422': $ref: '#/components/responses/UnprocessableManagedAccountEntity' summary: Enables a managed account tags: - Managed Accounts x-latency-category: responsive /managed_accounts/{id}/update_global_channel_limit: patch: description: Update the amount of allocatable global outbound channels allocated to a specific managed account. operationId: UpdateManagedAccountGlobalChannelLimit parameters: - description: Managed Account User ID in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateManagedAccountGlobalChannelLimitRequest' description: Parameters that define the changes to the global outbounds channels for the managed account required: true responses: '200': $ref: '#/components/responses/UpdateManagedAccountGlobalChannelLimitResponse' '401': $ref: '#/components/responses/managed-accounts_UnauthorizedResponse' '404': description: Resource not found '422': $ref: '#/components/responses/UnprocessableManagedAccountEntity' summary: Update the amount of allocatable global outbound channels allocated to a specific managed account. tags: - Managed Accounts x-latency-category: responsive /media: get: description: Returns a list of stored media files. operationId: ListMediaStorage parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[content_type][]' explode: true in: query name: filter schema: properties: content_type: description: Filters files by given content types items: example: application_xml type: string type: array type: object style: deepObject responses: '200': $ref: '#/components/responses/ListMediaResponse' default: $ref: '#/components/responses/media-storage_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: CreateMediaStorage 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/media-storage_GenericErrorResponse' summary: Upload media tags: - Media Storage API x-latency-category: interactive /media/{media_name}: delete: description: Deletes a stored media file. operationId: DeleteMediaStorage parameters: - $ref: '#/components/parameters/MediaName' responses: '204': description: The media was deleted successfully. default: $ref: '#/components/responses/media-storage_GenericErrorResponse' summary: Deletes stored media tags: - Media Storage API x-latency-category: interactive get: description: Returns the information about a stored media file. operationId: GetMediaStorage parameters: - $ref: '#/components/parameters/MediaName' responses: '200': $ref: '#/components/responses/MediaResponse' default: $ref: '#/components/responses/media-storage_GenericErrorResponse' summary: Retrieve stored media tags: - Media Storage API x-latency-category: interactive put: description: Updates a stored media file. operationId: UpdateMediaStorage 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/media-storage_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/media-storage_GenericErrorResponse' summary: Download stored media tags: - Media Storage API x-latency-category: interactive /messages: post: 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: SendMessage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMessageRequest' description: Message payload responses: '200': $ref: '#/components/responses/MessageResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Send a message tags: - Messages x-latency-category: responsive /messages/group_mms: post: operationId: CreateGroupMmsMessage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateGroupMMSMessageRequest' description: Message payload responses: '200': $ref: '#/components/responses/MessageResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Send a group MMS message tags: - Messages x-latency-category: responsive /messages/long_code: post: operationId: CreateLongCodeMessage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLongCodeMessageRequest' description: Message payload responses: '200': $ref: '#/components/responses/MessageResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Send a long code message tags: - Messages x-latency-category: responsive /messages/number_pool: post: operationId: CreateNumberPoolMessage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNumberPoolMessageRequest' description: Message payload responses: '200': $ref: '#/components/responses/MessageResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Send a message using number pool tags: - Messages x-latency-category: responsive /messages/rcs/deeplinks/{agent_id}: get: description: Generate a deeplink URL that can be used to start an RCS conversation with a specific agent. parameters: - description: RCS agent ID in: path name: agent_id required: true schema: type: string - description: Phone number in E164 format (URL encoded) example: '%2B18445550001' in: query name: phone_number required: false schema: type: string - description: Pre-filled message body (URL encoded) example: hello%20world in: query name: body required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RCSDeeplinkResponse' description: Successful response with deeplink URL default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Generate RCS deeplink tags: - RCS messaging x-latency-category: responsive /messages/schedule: post: description: 'Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool. This endpoint allows you to schedule a message with any messaging resource. Current messaging resources include: long-code, short-code, number-pool, and alphanumeric-sender-id. ' operationId: ScheduleMessage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateScheduledMessageRequest' description: Message payload with send_at set responses: '200': $ref: '#/components/responses/MessageResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Schedule a message tags: - Messages x-latency-category: responsive /messages/short_code: post: operationId: CreateShortCodeMessage requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateShortCodeMessageRequest' description: Message payload responses: '200': $ref: '#/components/responses/MessageResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Send a short code message tags: - Messages x-latency-category: responsive /messages/{id}: delete: description: Cancel a scheduled message that has not yet been sent. Only messages with `status=scheduled` and `send_at` more than a minute from now can be cancelled. operationId: CancelMessage parameters: - description: The id of the message to cancel in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/OutboundMessagePayloadCancelled' description: Successful response '403': content: application/json: schema: $ref: '#/components/schemas/messaging_Error' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/messaging_Error' description: Not found. default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Cancel a scheduled message tags: - Messages x-latency-category: responsive 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/api/v1/mission-control/add-mdr-request)' operationId: GetMessage parameters: - description: The id of the message in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: oneOf: - $ref: '#/components/schemas/OutboundMessagePayload' - $ref: '#/components/schemas/InboundMessagePayload' type: object description: Successful response with details of a message. default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Retrieve a message tags: - Messages x-latency-category: responsive /messaging/rcs/agents: get: parameters: - $ref: '#/components/parameters/PageConsolidated' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RCSAgentsResponse' description: Successful reponse with the list of RCS agents default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: List all RCS agents tags: - RCS messaging x-latency-category: responsive /messaging/rcs/agents/{id}: get: parameters: - description: RCS agent ID in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RCSAgentResponse' description: Successful response with the RCS agent default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Retrieve an RCS agent tags: - RCS messaging x-latency-category: responsive patch: parameters: - description: RCS agent ID in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RCSAgentUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RCSAgentResponse' description: Successful response with the updated RCS agent default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Modify an RCS agent tags: - RCS messaging x-latency-category: responsive /messaging/rcs/bulk_capabilities: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/RCSCapabilityListRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RCSCapabilitiesBulk' description: Successful response default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: List RCS capabilities of a given batch of phone numbers tags: - RCS messaging x-latency-category: responsive /messaging/rcs/capabilities/{agent_id}/{phone_number}: get: parameters: - description: RCS agent ID in: path name: agent_id required: true schema: type: string - description: Phone number in E164 format in: path name: phone_number required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RCSCapabilitiesSingle' description: Successful response default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: List RCS capabilities of a phone number tags: - RCS messaging x-latency-category: responsive /messaging/rcs/test_number_invite/{id}/{phone_number}: put: description: Adds a test phone number to an RCS agent for testing purposes. parameters: - description: RCS agent ID in: path name: id required: true schema: type: string - description: Phone number in E164 format to invite for testing in: path name: phone_number required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RCSTestNumberInviteResponse' description: Test number successfully invited to RCS agent default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Invite a test number to an RCS agent tags: - RCS messaging x-latency-category: responsive /messaging_hosted_number_orders: get: operationId: ListMessagingHostedNumberOrders parameters: - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/ListMessagingHostedNumberOrdersResponse' default: $ref: '#/components/responses/messaging_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/messaging_GenericErrorResponse' summary: Create a messaging hosted number order tags: - Messaging Hosted Number x-latency-category: responsive /messaging_hosted_number_orders/eligibility_numbers_check: post: operationId: CheckEligibilityNumbers requestBody: content: application/json: schema: $ref: '#/components/schemas/EligibilityNumbersRequest' description: Phone numbers to check eligibility required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EligibilityNumbersResponse' description: Successful response '400': content: application/json: schema: $ref: '#/components/schemas/messaging_Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/messaging_Error' description: Unauthorized summary: Check eligibility of phone numbers for hosted messaging tags: - Messaging Hosted Number x-latency-category: responsive /messaging_hosted_number_orders/{id}: delete: description: Delete a messaging hosted number order and all associated phone numbers. operationId: DeleteMessagingHostedNumberOrder parameters: - description: Identifies the messaging hosted number order to delete. in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/MessagingHostedNumberOrderResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Delete a messaging hosted number order tags: - Messaging Hosted Number x-latency-category: responsive get: operationId: GetMessagingHostedNumberOrder 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/messaging_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: UploadMessagingHostedNumberOrderFile 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/messaging_GenericErrorResponse' summary: Upload file required for a messaging hosted number order tags: - Messaging Hosted Number x-latency-category: responsive /messaging_hosted_number_orders/{id}/validation_codes: post: description: Validate the verification codes sent to the numbers of the hosted order. The verification codes must be created in the verification codes endpoint. operationId: ValidateVerificationCodesForMessagingHostedNumberOrder parameters: - description: Order ID related to the validation codes. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidationCodesRequest' description: Message payload responses: '200': $ref: '#/components/responses/ValidationCodesResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Validate the verification codes for the hosted numbers order tags: - Messaging Hosted Number x-latency-category: responsive /messaging_hosted_number_orders/{id}/verification_codes: post: description: Create verification codes to validate numbers of the hosted order. The verification codes will be sent to the numbers of the hosted order. operationId: CreateVerificationCodesForMessagingHostedNumberOrder parameters: - description: Order ID to have a verification code created. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/VerificationCodesRequest' description: Message payload responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreatedVerificationCodesResponse' description: Verification codes created and sent to the phone numbers of the hosted order. default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Create verification codes for the hosted numbers 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/MessagingHostedNumberOrderResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Delete a messaging hosted number tags: - Messaging Hosted Number x-latency-category: responsive /messaging_numbers_bulk_updates: post: operationId: BulkUpdateMessagingSettingsOnPhoneNumbers requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkMessagingSettingsUpdatePhoneNumbersRequest' required: true responses: '200': $ref: '#/components/responses/BulkMessagingSettingsUpdatePhoneNumbersResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Update the messaging profile of multiple phone numbers tags: - Number Configurations x-latency-category: responsive /messaging_numbers_bulk_updates/{order_id}: get: operationId: GetBulkUpdateMessagingSettingsOnPhoneNumbersStatus parameters: - description: Order ID to verify bulk update status. in: path name: order_id required: true schema: type: string responses: '200': $ref: '#/components/responses/BulkMessagingSettingsUpdatePhoneNumbersResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Retrieve bulk update status tags: - Number Configurations x-latency-category: responsive /messaging_optouts: get: description: Retrieve a list of opt-out blocks. operationId: ListOptOuts parameters: - description: If receiving address (+E.164 formatted phone number) should be redacted example: +447766**** in: query name: redaction_enabled required: false schema: format: boolean type: string - description: 'Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id], filter[from]' explode: true in: query name: filter schema: properties: from: description: The sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code) to retrieve opt-outs for type: string messaging_profile_id: description: The ID of the messaging profile to retrieve opt-outs for type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' - description: 'Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]' explode: true in: query name: created_at schema: properties: gte: description: Filter opt-outs created after this date (ISO-8601 format) format: date-time type: string lte: description: Filter opt-outs created before this date (ISO-8601 format) format: date-time type: string type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/OptOutListResponse' description: Successful response with opt-out list data '400': content: application/json: schema: $ref: '#/components/schemas/messaging_Error' description: Bad request '401': content: application/json: schema: $ref: '#/components/schemas/messaging_Error' description: Unauthorized summary: List opt-outs tags: - Advanced OptIn/OptOut x-latency-category: responsive /messaging_profiles: get: operationId: ListMessagingProfiles parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[name]' explode: true in: query name: filter schema: properties: name: description: Filter by name type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/ListMessagingProfilesResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: List messaging profiles tags: - Messaging Profiles x-endpoint-cost: medium x-group-parameters: 'true' x-latency-category: responsive post: 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/messaging_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/messaging_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/messaging_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/messaging_GenericErrorResponse' summary: Update a messaging profile tags: - Messaging Profiles x-latency-category: responsive /messaging_profiles/{id}/phone_numbers: get: operationId: ListProfilePhoneNumbers parameters: - $ref: '#/components/parameters/MessagingProfileId' - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/ListMessagingProfilePhoneNumbersResponse' default: $ref: '#/components/responses/messaging_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: ListProfileShortCodes parameters: - $ref: '#/components/parameters/MessagingProfileId' - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/ListMessagingProfileShortCodesResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: List short codes associated with a messaging profile tags: - Messaging Profiles x-group-parameters: 'true' x-latency-category: responsive /messaging_profiles/{profile_id}/autoresp_configs: get: operationId: GetAutorespConfigs parameters: - in: path name: profile_id required: true schema: format: uuid title: Profile Id type: string - in: query name: country_code required: false schema: title: Country Code type: string - description: 'Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]' explode: true in: query name: created_at schema: properties: gte: title: Created At[Gte] type: string lte: title: Created At[Lte] type: string type: object style: deepObject - description: 'Consolidated updated_at parameter (deepObject style). Originally: updated_at[gte], updated_at[lte]' explode: true in: query name: updated_at schema: properties: gte: title: Updated At[Gte] type: string lte: title: Updated At[Lte] type: string type: object style: deepObject responses: '200': content: application/json: example: data: - country_code: US created_at: '2023-03-21T23:37:45.858535+00:00' id: 677ec1cb-949e-4aeb-a1c3-6d9ddffc1409 keywords: - START - BEGIN op: start resp_text: Thank you for subscribing US customer. updated_at: '2023-03-21T23:37:45.858535+00:00' - country_code: US created_at: '2023-03-10T21:54:46.293380+00:00' id: 54b7e19f-98a8-416f-81d1-a2782eade48b keywords: - END - STOP op: stop resp_text: You have unsubscribed. updated_at: '2023-03-10T21:54:46.293380+00:00' - country_code: '*' created_at: '2023-03-14T14:46:21.097735+00:00' id: cfe07be1-2369-433f-be00-eb176008e834 keywords: - START op: start resp_text: Thank you for subscribing. updated_at: '2023-03-14T14:46:21.097735+00:00' meta: page_number: 1 page_size: 5 total_pages: 1 total_results: 3 schema: $ref: '#/components/schemas/AutorespConfigsResponseSchema' description: Successful Response default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: List Auto-Response Settings tags: - Advanced OptIn/OptOut x-latency-category: responsive post: operationId: CreateAutorespConfig parameters: - in: path name: profile_id required: true schema: title: Profile Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AutoRespConfigCreateSchema' required: true responses: '200': content: application/json: example: data: country_code: US created_at: '2023-03-22T00:06:49.068817+00:00' id: c2298f86-a4dc-4cac-b6b6-4a3d01c290fa keywords: - START op: start resp_text: Hello there! updated_at: '2023-03-22T00:06:49.068817+00:00' schema: $ref: '#/components/schemas/AutorespConfigResponseSchema' description: Successful Response default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Create Auto-Reponse Setting tags: - Advanced OptIn/OptOut x-latency-category: responsive /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}: delete: operationId: DeleteAutorespConfig parameters: - in: path name: profile_id required: true schema: format: uuid title: Profile Id type: string - in: path name: autoresp_cfg_id required: true schema: format: uuid title: Autoresp Cfg Id type: string responses: '200': content: application/json: schema: {} description: Successful Response default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Delete Auto-Response Setting tags: - Advanced OptIn/OptOut x-latency-category: responsive get: operationId: GetAutorespConfig parameters: - in: path name: profile_id required: true schema: format: uuid title: Profile Id type: string - in: path name: autoresp_cfg_id required: true schema: format: uuid title: Autoresp Cfg Id type: string responses: '200': content: application/json: example: data: country_code: US created_at: '2023-03-13T17:51:03.826453+00:00' id: adc37adf-d110-4355-9e9a-262847e68e89 keywords: - UNSTOP op: start resp_text: Hello there! updated_at: '2023-03-13T17:51:03.826453+00:00' schema: $ref: '#/components/schemas/AutorespConfigResponseSchema' description: Successful Response default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Get Auto-Response Setting tags: - Advanced OptIn/OptOut x-latency-category: responsive put: operationId: UpdateAutoRespConfig parameters: - in: path name: profile_id required: true schema: format: uuid title: Profile Id type: string - in: path name: autoresp_cfg_id required: true schema: format: uuid title: Autoresp Cfg Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AutoRespConfigCreateSchema' required: true responses: '200': content: application/json: example: data: country_code: '*' created_at: '2023-03-10T21:54:46.293380+00:00' id: 54b7e19f-98a8-416f-81d1-a2782eade48b keywords: - START - BEGIN op: start resp_text: Hello there! updated_at: '2023-03-10T21:54:46.293380+00:00' schema: $ref: '#/components/schemas/AutorespConfigResponseSchema' description: Successful Response default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Update Auto-Response Setting tags: - Advanced OptIn/OptOut x-latency-category: responsive /messaging_tollfree/verification/requests: get: description: Get a list of previously-submitted tollfree verification requests operationId: ListVerificationRequests parameters: - in: query name: page required: true schema: minimum: 1 title: Page type: integer - description: "\n Request this many records per page\n\n This\ \ value is automatically clamped if the provided value is too large.\n \ \ " in: query name: page_size required: true schema: description: "\n Request this many records per page\n\n This\ \ value is automatically clamped if the provided value is too large.\n\ \ " minimum: 1 title: Page Size type: integer - in: query name: date_start required: false schema: format: date-time title: Date Start type: string - in: query name: date_end required: false schema: format: date-time title: Date End type: string - in: query name: status required: false schema: $ref: '#/components/schemas/TFVerificationStatus' - in: query name: phone_number required: false schema: title: Phone Number type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Paginated_VerificationRequestStatus_' description: Successful Response default: $ref: '#/components/responses/toll-free-verification_GenericErrorResponse' summary: List Verification Requests tags: - Messaging Tollfree Verification x-latency-category: responsive post: description: Submit a new tollfree verification request operationId: SubmitVerificationRequest parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/TFVerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationRequestEgress' description: Successful Response default: $ref: '#/components/responses/toll-free-verification_GenericErrorResponse' summary: Submit Verification Request tags: - Messaging Tollfree Verification x-latency-category: responsive /messaging_tollfree/verification/requests/{id}: delete: description: 'Delete a verification request A request may only be deleted when when the request is in the "rejected" state. * `HTTP 200`: request successfully deleted * `HTTP 400`: request exists but can''t be deleted (i.e. not rejected) * `HTTP 404`: request unknown or already deleted' operationId: DeleteVerificationRequest parameters: - in: path name: id required: true schema: format: uuid title: Id type: string responses: '200': content: application/json: schema: {} description: Successful Response default: $ref: '#/components/responses/toll-free-verification_GenericErrorResponse' summary: Delete Verification Request tags: - Messaging Tollfree Verification x-latency-category: responsive get: description: Get a single verification request by its ID. operationId: GetVerificationRequest parameters: - in: path name: id required: true schema: format: uuid title: Id type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationRequestStatus' description: Successful Response default: $ref: '#/components/responses/toll-free-verification_GenericErrorResponse' summary: Get Verification Request tags: - Messaging Tollfree Verification x-latency-category: responsive patch: description: Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken. operationId: UpdateVerificationRequest parameters: - in: path name: id required: true schema: format: uuid title: Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TFVerificationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerificationRequestEgress' description: Successful Response default: $ref: '#/components/responses/toll-free-verification_GenericErrorResponse' summary: Update Verification Request tags: - Messaging Tollfree Verification x-latency-category: responsive /messaging_url_domains: get: operationId: ListMessagingUrlDomains parameters: - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/ListMessagingUrlDomains' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: List messaging URL domains tags: - Messaging URL Domains x-group-parameters: 'true' x-latency-category: responsive /messsages/rcs: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/RCSMessage' description: RCS message body required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RCSResponse' description: Successful operation default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Send an RCS message tags: - RCS messaging x-latency-category: responsive /mobile_network_operators: 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: GetMobileNetworkOperators parameters: - $ref: '#/components/parameters/FilterMobileNetworkOperatorsConsolidated' - $ref: '#/components/parameters/wireless_PageConsolidated' responses: '200': $ref: '#/components/responses/SearchMobileNetworkOperatorsResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: List mobile network operators tags: - Mobile Network Operators x-latency-category: responsive /mobile_push_credentials: get: description: List mobile push credentials operationId: ListPushCredentials parameters: - $ref: '#/components/parameters/push-notifications_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[type], filter[alias]' explode: true in: query name: filter schema: properties: alias: description: Unique mobile push credential alias example: LucyCredential type: string type: description: type of mobile push credentials enum: - ios - android example: ios type: string type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListPushCredentialsResponse' description: Mobile mobile push credentials '401': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Unauthorized request summary: List mobile push credentials tags: - Push Credentials x-latency-category: responsive post: description: Creates a new mobile push credential operationId: CreatePushCredential parameters: [] requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/CreateIosPushCredentialRequest' - $ref: '#/components/schemas/CreateAndroidPushCredentialRequest' description: Mobile push credential parameters that need to be sent in the request required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PushCredentialResponse' description: Mobile push credential created '401': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Unauthorized request '422': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Unable to process request summary: Creates a new mobile push credential tags: - Push Credentials x-latency-category: responsive /mobile_push_credentials/{push_credential_id}: delete: description: Deletes a mobile push credential based on the given `push_credential_id` operationId: DeletePushCredentialById parameters: - description: The unique identifier of a mobile push credential in: path name: push_credential_id required: true schema: example: 0ccc7b76-4df3-4bca-a05a-3da1ecc389f0 format: uuid type: string responses: '204': description: The mobile push credential was deleted successfully '401': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Unauthorized request '404': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Resource not found '422': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Unable to process request summary: Deletes a mobile push credential tags: - Push Credentials x-latency-category: responsive get: description: Retrieves mobile push credential based on the given `push_credential_id` operationId: GetPushCredentialById parameters: - description: The unique identifier of a mobile push credential in: path name: push_credential_id required: true schema: example: 0ccc7b76-4df3-4bca-a05a-3da1ecc389f0 format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PushCredentialResponse' description: Successful get mobile push credential response '401': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Unauthorized request '404': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Resource not found '422': content: application/json: schema: $ref: '#/components/schemas/push-notifications_Errors' description: Unable to process request summary: Retrieves a mobile push credential tags: - Push Credentials x-latency-category: responsive /network_coverage: get: description: List all locations and the interfaces that region supports operationId: ListNetworkCoverage parameters: - description: 'Consolidated filters parameter (deepObject style). Originally: filters[available_services][contains]' explode: true in: query name: filters schema: additionalProperties: false properties: available_services: oneOf: - $ref: '#/components/schemas/AvailableService' description: Filter by exact available service match - additionalProperties: false description: Available service filtering operations properties: contains: $ref: '#/components/schemas/AvailableService' description: Filter by available services containing the specified service type: object type: object style: deepObject - description: 'Consolidated filter parameter (deepObject style). Originally: filter[location.region], filter[location.site], filter[location.pop], filter[location.code]' explode: true in: query name: filter schema: properties: location.code: description: The code of associated location to filter on. example: silicon_valley-ca type: string location.pop: description: The POP of associated location to filter on. example: SV1 type: string location.region: description: The region of associated location to filter on. example: AMER type: string location.site: description: The site of associated location to filter on. example: SJC type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/NetworkCoverageListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List network coverage locations tags: - Coverage x-latency-category: responsive /networks: get: description: List all Networks. operationId: ListNetworks parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[name]' explode: true in: query name: filter schema: properties: name: description: The network name to filter on. example: test network type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/NetworkListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Networks tags: - Networks x-latency-category: responsive post: description: Create a new Network. operationId: CreateNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkCreate' required: true responses: '200': $ref: '#/components/responses/NetworkResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create a Network tags: - Networks x-latency-category: responsive /networks/{id}: delete: description: Delete a Network. operationId: DeleteNetwork parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/NetworkResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete a Network tags: - Networks x-latency-category: responsive get: description: Retrieve a Network. operationId: GetNetwork parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/NetworkResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve a Network tags: - Networks x-latency-category: responsive patch: description: Update a Network. operationId: UpdateNetwork parameters: - $ref: '#/components/parameters/ResourceId' requestBody: content: application/json: schema: $ref: '#/components/schemas/NetworkCreate' required: true responses: '200': $ref: '#/components/responses/NetworkResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Update a Network tags: - Networks x-latency-category: responsive /networks/{id}/default_gateway: delete: description: Delete Default Gateway. operationId: DeleteDefaultGateway parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/DefaultGatewayResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete Default Gateway. tags: - Networks x-latency-category: responsive get: description: Get Default Gateway status. operationId: GetDefaultGateway parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/DefaultGatewayResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Get Default Gateway status. tags: - Networks x-latency-category: responsive post: description: Create Default Gateway. operationId: CreateDefaultGateway parameters: - $ref: '#/components/parameters/ResourceId' requestBody: content: application/json: schema: $ref: '#/components/schemas/DefaultGateway' required: true responses: '200': $ref: '#/components/responses/DefaultGatewayResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create Default Gateway. tags: - Networks x-latency-category: responsive /networks/{id}/network_interfaces: get: description: List all Interfaces for a Network. operationId: ListNetworkInterfaces parameters: - $ref: '#/components/parameters/ResourceId' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[name], filter[type], filter[status]' explode: true in: query name: filter schema: properties: name: description: The interface name to filter on. example: test interface type: string status: $ref: '#/components/schemas/InterfaceStatus' description: The interface status to filter on. type: description: The interface type to filter on. example: wireguard_interface type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/NetworkInterfaceListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Interfaces for a Network. tags: - Networks x-latency-category: responsive /notification_channels: get: description: List notification channels. operationId: ListNotificationChannels parameters: - $ref: '#/components/parameters/PageConsolidated' - $ref: '#/components/parameters/notifications_FilterConsolidated' 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/notifications_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/notifications_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/notifications_Id' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/NotificationChannel' type: object description: A Notification Channel response default: $ref: '#/components/responses/notifications_GenericErrorResponse' summary: Delete a notification channel tags: - Notifications x-latency-category: responsive get: description: Get a notification channel. operationId: GetNotificationChannel parameters: - $ref: '#/components/parameters/notifications_Id' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/NotificationChannel' type: object description: A Notification Channel response default: $ref: '#/components/responses/notifications_GenericErrorResponse' summary: Get a notification channel tags: - Notifications x-latency-category: responsive patch: description: Update a notification channel. operationId: UpdateNotificationChannel parameters: - $ref: '#/components/parameters/notifications_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/notifications_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/PageConsolidated' - $ref: '#/components/parameters/notifications_FilterConsolidated' 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/notifications_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/PageConsolidated' 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/notifications_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/PageConsolidated' 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/notifications_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/notifications_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/notifications_Id' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/NotificationProfile' type: object description: A Notification Profile response default: $ref: '#/components/responses/notifications_GenericErrorResponse' summary: Delete a notification profile tags: - Notifications x-latency-category: responsive get: description: Get a notification profile. operationId: GetNotificationProfile parameters: - $ref: '#/components/parameters/notifications_Id' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/NotificationProfile' type: object description: A Notification Profile response default: $ref: '#/components/responses/notifications_GenericErrorResponse' summary: Get a notification profile tags: - Notifications x-latency-category: responsive patch: description: Update a notification profile. operationId: UpdateNotificationProfile parameters: - $ref: '#/components/parameters/notifications_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/notifications_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/PageConsolidated' - $ref: '#/components/parameters/notifications_FilterConsolidated' 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/notifications_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/notifications_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/notifications_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/notifications_GenericErrorResponse' summary: Delete a notification setting tags: - Notifications x-latency-category: responsive get: description: Get a notification setting. operationId: GetNotificationSetting parameters: - $ref: '#/components/parameters/notifications_Id' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/NotificationSetting' type: object description: A Notification Setting response default: $ref: '#/components/responses/notifications_GenericErrorResponse' summary: Get 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: - $ref: '#/components/parameters/numbers_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers.starting_number]' explode: true in: query name: filter schema: properties: created_at: additionalProperties: false description: Filter number block orders by date range. properties: gt: description: Filter number block orders later than this value. example: '2018-01-01T00:00:00.000000Z' type: string lt: description: Filter number block orders earlier than this value. example: '2018-01-01T00:00:00.000000Z' type: string type: object phone_numbers.starting_number: description: Filter number block orders having these phone numbers. example: '+19705555000' type: string status: description: Filter number block orders by status. example: pending type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListNumberBlockOrdersResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List number block orders tags: - Phone Number Block Orders x-latency-category: responsive post: 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/numbers_GenericErrorResponse' summary: Create a number block order tags: - Phone 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/numbers_GenericErrorResponse' summary: Retrieve a number block order tags: - Phone Number Block Orders x-latency-category: responsive /number_lookup/{phone_number}: get: description: Returns information about the provided phone number. operationId: LookupNumber parameters: - $ref: '#/components/parameters/PhoneNumber' - $ref: '#/components/parameters/NumberLookupType' responses: '200': $ref: '#/components/responses/NumberLookupResponse' '422': $ref: '#/components/responses/number-lookup_UnprocessableEntity' default: $ref: '#/components/responses/number-lookup_GenericErrorResponse' summary: Lookup phone number data tags: - Number Lookup x-latency-category: responsive /number_order_phone_numbers: get: description: Get a list of phone numbers associated to orders. operationId: RetrieveOrderPhoneNumbers parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[country_code]' explode: true in: query name: filter schema: properties: country_code: description: Country code of the order phone number. example: US type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListNumberOrderPhoneNumbersResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve a list of phone numbers associated to orders tags: - Phone Number Orders x-latency-category: responsive /number_order_phone_numbers/{id}/requirement_group: post: operationId: updateNumberOrderPhoneNumberRequirementGroup parameters: - description: The unique identifier of the number order phone number in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: properties: requirement_group_id: description: The ID of the requirement group to associate format: uuid type: string required: - requirement_group_id type: object required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/NumberOrderPhoneNumberRequirementGroupResponse' type: object description: Successful response with updated phone number order details default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Update requirement group for a phone number order tags: - Requirement Groups x-latency-category: responsive /number_order_phone_numbers/{number_order_phone_number_id}: get: description: Get an existing phone number in number order. operationId: GetNumberOrderPhoneNumber 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/numbers_GenericErrorResponse' summary: Retrieve a single phone number within a number order. tags: - Phone Number Orders x-latency-category: responsive patch: description: Updates requirements for a single phone number within a number order. 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/numbers_GenericErrorResponse' summary: Update requirements for a single phone number within a number order. tags: - Phone Number Orders x-latency-category: responsive /number_orders: get: description: Get a paginated list of number orders. operationId: ListNumberOrders parameters: - $ref: '#/components/parameters/numbers_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers_count], filter[customer_reference], filter[requirements_met]' explode: true in: query name: filter schema: properties: created_at: additionalProperties: false description: Filter number orders by date range. properties: gt: description: Filter number orders later than this value. type: string lt: description: Filter number orders earlier than this value. type: string type: object customer_reference: description: Filter number orders via the customer reference set. type: string phone_numbers_count: description: Filter number order with this amount of numbers type: string requirements_met: description: Filter number orders by requirements met. type: boolean status: description: Filter number orders by status. type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListNumberOrdersResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List number orders tags: - Phone Number Orders x-endpoint-cost: medium x-group-parameters: 'true' x-latency-category: responsive post: 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/numbers_GenericErrorResponse' summary: Create a number order tags: - Phone 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/numbers_GenericErrorResponse' summary: Retrieve a number order tags: - Phone 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/numbers_GenericErrorResponse' summary: Update a number order tags: - Phone Number Orders x-latency-category: responsive /number_reservations: get: description: Gets a paginated list of phone number reservations. operationId: ListNumberReservations parameters: - $ref: '#/components/parameters/numbers_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers.phone_number], filter[customer_reference]' explode: true in: query name: filter schema: properties: created_at: additionalProperties: false description: Filter number reservations by date range. properties: gt: description: Filter number reservations later than this value. type: string lt: description: Filter number reservations earlier than this value. type: string type: object customer_reference: description: Filter number reservations via the customer reference set. type: string phone_numbers.phone_number: description: Filter number reservations having these phone numbers. type: string status: description: Filter number reservations by status. type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListNumberReservationsResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List number reservations tags: - Phone 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/numbers_GenericErrorResponse' summary: Create a number reservation tags: - Phone 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/numbers_GenericErrorResponse' summary: Retrieve a number reservation tags: - Phone 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/numbers_GenericErrorResponse' summary: Extend a number reservation tags: - Phone Number Reservations x-latency-category: responsive /numbers_features: post: description: Retrieve the features for a list of numbers operationId: PostNumbersFeatures requestBody: content: application/json: schema: properties: phone_numbers: items: type: string type: array required: - phone_numbers type: object required: true responses: '200': content: application/json: schema: properties: data: items: properties: features: items: type: string type: array phone_number: type: string required: - phone_number - features type: object type: array type: object description: Successful response security: - bearerAuth: [] summary: Retrieve the features for a list of numbers tags: - numbers features x-latency-category: responsive /oauth/authorize: get: description: OAuth 2.0 authorization endpoint for the authorization code flow parameters: - description: OAuth response type in: query name: response_type required: true schema: enum: - code type: string - description: OAuth client identifier in: query name: client_id required: true schema: type: string - description: Redirect URI in: query name: redirect_uri required: true schema: format: uri type: string - description: Space-separated list of requested scopes example: admin in: query name: scope schema: type: string - description: State parameter for CSRF protection in: query name: state schema: type: string - description: PKCE code challenge in: query name: code_challenge schema: type: string - description: PKCE code challenge method in: query name: code_challenge_method schema: enum: - plain - S256 type: string responses: '302': description: Redirect to consent page or client with authorization code/error '400': content: text/html: schema: type: string description: Invalid request '404': content: text/html: schema: type: string description: Client not found '422': content: text/html: schema: type: string description: Invalid redirect URI security: [] summary: OAuth authorization endpoint tags: - OAuth Protocol x-latency-category: responsive /oauth/consent/{consent_token}: get: description: Retrieve details about an OAuth consent token parameters: - description: OAuth consent token in: path name: consent_token required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsentTokenResponse' description: Consent token details '422': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: Invalid consent token security: - bearerAuth: [] summary: Get OAuth consent token tags: - OAuth Protocol x-latency-category: responsive /oauth/grants: post: description: Create an OAuth authorization grant requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOAuthGrantRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateGrantResponse' description: Grant created successfully '422': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: Invalid consent token security: - bearerAuth: [] summary: Create OAuth grant tags: - OAuth Protocol x-latency-category: responsive /oauth/introspect: post: description: Introspect an OAuth access token to check its validity and metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/IntrospectRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/IntrospectRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/IntrospectResponse' description: Introspection response '400': content: application/json: example: error: invalid_request schema: $ref: '#/components/schemas/oauth_Error' description: Invalid request '401': content: application/json: example: error: invalid_client schema: $ref: '#/components/schemas/oauth_Error' description: Invalid client credentials security: - oauthClientAuth: [] summary: Token introspection tags: - OAuth Protocol x-latency-category: responsive /oauth/jwks: get: description: Retrieve the JSON Web Key Set for token verification responses: '200': content: application/json: schema: $ref: '#/components/schemas/JWKSet' description: JSON Web Key Set security: [] summary: JSON Web Key Set tags: - OAuth Protocol x-latency-category: responsive /oauth/register: post: description: Register a new OAuth client dynamically (RFC 7591) requestBody: content: application/json: schema: $ref: '#/components/schemas/OAuthDynamicRegistrationRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/OAuthDynamicRegistrationResponse' description: Client registered successfully '400': content: application/json: schema: properties: error: example: invalid_client_metadata type: string error_description: example: The client metadata was invalid type: string invalid_fields: additionalProperties: items: type: string type: array type: object type: object description: Invalid client metadata security: [] summary: Dynamic client registration tags: - OAuth Protocol x-latency-category: responsive /oauth/token: post: description: Exchange authorization code, client credentials, or refresh token for access token requestBody: content: application/json: schema: $ref: '#/components/schemas/TokenRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TokenResponse' description: Token response '400': content: application/json: examples: invalid_grant: value: error: invalid_grant invalid_request: value: error: invalid_request invalid_scope: value: error: invalid_scope unsupported_grant_type: value: error: unsupported_grant_type schema: $ref: '#/components/schemas/oauth_Error' description: Invalid request '401': content: application/json: example: error: invalid_client schema: $ref: '#/components/schemas/oauth_Error' description: Invalid client credentials security: - oauthClientAuth: [] - {} summary: OAuth token endpoint tags: - OAuth Protocol x-latency-category: responsive /oauth_clients: get: description: Retrieve a paginated list of OAuth clients for the authenticated user parameters: - description: Number of results per page in: query name: page[size] schema: default: 20 maximum: 100 minimum: 1 type: integer - description: Page number in: query name: page[number] schema: default: 1 minimum: 1 type: integer - description: Filter by client type in: query name: filter[client_type] schema: enum: - confidential - public type: string - description: Filter by verification status in: query name: filter[verified] schema: type: boolean - description: Filter by allowed grant type in: query name: filter[allowed_grant_types][contains] schema: enum: - client_credentials - authorization_code - refresh_token type: string - description: Filter by exact client name in: query name: filter[name] schema: type: string - description: Filter by client name containing text in: query name: filter[name][contains] schema: type: string - description: Filter by client ID in: query name: filter[client_id] schema: type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/OAuthClient' type: array meta: $ref: '#/components/schemas/oauth_PaginationMeta' type: object description: List of OAuth clients '401': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: Unauthorized security: - bearerAuth: [] summary: List OAuth clients tags: - OAuth Clients x-latency-category: responsive post: description: Create a new OAuth client requestBody: content: application/json: schema: $ref: '#/components/schemas/OAuthClientCreateRequest' required: true responses: '201': content: application/json: schema: properties: data: $ref: '#/components/schemas/OAuthClient' type: object description: OAuth client created successfully '400': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: Invalid request '401': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: Unauthorized '422': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: Validation error security: - bearerAuth: [] summary: Create OAuth client tags: - OAuth Clients x-latency-category: responsive /oauth_clients/{id}: delete: description: Delete an OAuth client parameters: - description: OAuth client ID in: path name: id required: true schema: format: uuid type: string responses: '204': description: OAuth client deleted successfully '404': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: OAuth client not found security: - bearerAuth: [] summary: Delete OAuth client tags: - OAuth Clients x-latency-category: responsive get: description: Retrieve a single OAuth client by ID parameters: - description: OAuth client ID in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/OAuthClient' type: object description: OAuth client details '404': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: OAuth client not found security: - bearerAuth: [] summary: Get OAuth client tags: - OAuth Clients x-latency-category: responsive put: description: Update an existing OAuth client parameters: - description: OAuth client ID in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/OAuthClientUpdateRequest' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/OAuthClient' type: object description: OAuth client updated successfully '404': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: OAuth client not found '422': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: Validation error security: - bearerAuth: [] summary: Update OAuth client tags: - OAuth Clients x-latency-category: responsive /oauth_grants: get: description: Retrieve a paginated list of OAuth grants for the authenticated user parameters: - description: Number of results per page in: query name: page[size] schema: default: 20 maximum: 100 minimum: 1 type: integer - description: Page number in: query name: page[number] schema: default: 1 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/OAuthGrant' type: array meta: $ref: '#/components/schemas/oauth_PaginationMeta' type: object description: List of OAuth grants security: - bearerAuth: [] summary: List OAuth grants tags: - OAuth Grants x-latency-category: responsive /oauth_grants/{id}: delete: description: Revoke an OAuth grant parameters: - description: OAuth grant ID in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/OAuthGrant' type: object description: OAuth grant revoked successfully '404': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: OAuth grant not found security: - bearerAuth: [] summary: Revoke OAuth grant tags: - OAuth Grants x-latency-category: responsive get: description: Retrieve a single OAuth grant by ID parameters: - description: OAuth grant ID in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/OAuthGrant' type: object description: OAuth grant details '404': content: application/json: schema: $ref: '#/components/schemas/oauth_Error' description: OAuth grant not found security: - bearerAuth: [] summary: Get OAuth grant tags: - OAuth Grants x-latency-category: responsive /operator_connect/actions/refresh: post: description: This endpoint will make an asynchronous request to refresh the Operator Connect integration with Microsoft Teams for the current user. This will create new external connections on the user's account if needed, and/or report the integration results as [log messages](https://developers.telnyx.com/api/external-voice-integrations/list-external-connection-log-messages). operationId: OperatorConnectRefresh responses: '200': content: application/json: schema: properties: message: description: A message describing the result of the operation example: Operator connect refresh already in progress type: string success: description: Describes wether or not the operation was successful example: true type: boolean title: Operator Connect Refresh Response type: object description: Successful response '202': content: application/json: schema: properties: message: description: A message describing the result of the operation example: Operator connect refresh started type: string success: description: Describes wether or not the operation was successful example: true type: boolean title: Operator Connect Refresh Response type: object description: Successful response '401': description: Unauthorized summary: Refresh Operator Connect integration tags: - External Connections x-latency-category: responsive /ota_updates: get: operationId: ListOtaUpdates parameters: - $ref: '#/components/parameters/FilterOTAUpdatesConsolidated' - $ref: '#/components/parameters/wireless_PageConsolidated' responses: '200': $ref: '#/components/responses/SearchOTAUpdateResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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: GetOtaUpdate parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/OTAUpdateResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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/outbound-voice-profiles_PageConsolidated' - $ref: '#/components/parameters/outbound-voice-profiles_FilterConsolidated' - $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: CreateVoiceProfile 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: GetOutboundVoiceProfile 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 /partnerCampaign/sharedByMe: get: description: 'Get all partner campaigns you have shared to Telnyx in a paginated fashion This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted. In other words, shared but pending campaigns are currently omitted from the response from this endpoint.' operationId: GetPartnerCampaignsSharedByUser parameters: - description: The 1-indexed page number to get. The default value is `1`. in: query name: page required: false schema: default: 1 description: The 1-indexed page number to get. The default value is `1`. title: Page type: integer - description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. in: query name: recordsPerPage required: false schema: default: 10 description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. title: Recordsperpage type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharedCampaignRecordSet' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Partner Campaigns Shared By User tags: - Shared Campaigns x-latency-category: responsive /partnerCampaign/{campaignId}/sharing: get: operationId: GetPartnerCampaignSharingStatus parameters: - description: ID of the campaign in question in: path name: campaignId required: true schema: description: ID of the campaign in question title: Campaignid type: string responses: '200': content: application/json: schema: additionalProperties: $ref: '#/components/schemas/CampaignSharingStatus' title: Response Get Sharing Status Public Partnercampaign Campaignid Sharing Get type: object description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Sharing Status tags: - Shared Campaigns x-latency-category: responsive /partner_campaigns: get: description: 'Retrieve all partner campaigns you have shared to Telnyx in a paginated fashion. This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted. In other words, shared but pending campaigns are currently omitted from the response from this endpoint.' operationId: GetSharedCampaigns parameters: - description: The 1-indexed page number to get. The default value is `1`. in: query name: page required: false schema: default: 1 description: The 1-indexed page number to get. The default value is `1`. title: Page type: integer - description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. in: query name: recordsPerPage required: false schema: default: 10 description: The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`. title: Recordsperpage type: integer - description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. example: -assignedPhoneNumbersCount in: query name: sort required: false schema: default: -createdAt description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - assignedPhoneNumbersCount - -assignedPhoneNumbersCount - brandDisplayName - -brandDisplayName - tcrBrandId - -tcrBranId - tcrCampaignId - -tcrCampaignId - createdAt - -createdAt - campaignStatus - -campaignStatus title: Sort type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelnyxDownstreamCampaignRecordSet' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: List Shared Campaigns tags: - Shared Campaigns x-latency-category: responsive /partner_campaigns/{campaignId}: get: description: Retrieve campaign details by `campaignId`. operationId: GetSharedCampaign parameters: - in: path name: campaignId required: true schema: title: Campaignid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelnyxDownstreamCampaign' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Get Single Shared Campaign tags: - Shared Campaigns x-latency-category: responsive patch: description: Update campaign details by `campaignId`. **Please note:** Only webhook urls are editable. operationId: UpdateSharedCampaign parameters: - in: path name: campaignId required: true schema: title: Campaignid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePartnerCampaignRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TelnyxDownstreamCampaign' description: Successful Response '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error summary: Update Single Shared Campaign tags: - Shared Campaigns x-latency-category: responsive /payment/auto_recharge_prefs: get: description: Returns the payment auto recharge preferences. operationId: GetAutoRechargePrefs responses: '200': $ref: '#/components/responses/AutoRechargePrefResponse' '400': description: Bad request '401': description: Unauthorized '404': description: Resource not found summary: List auto recharge preferences tags: - AutoRechargePreferences x-endpoint-cost: medium x-latency-category: responsive patch: description: Update payment auto recharge preferences. operationId: UpdateAutoRechargePrefs requestBody: content: application/json: schema: $ref: '#/components/schemas/AutoRechargePrefRequest' description: Details to update auto recharge preferences required: true responses: '200': $ref: '#/components/responses/AutoRechargePrefResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Bad request summary: Update auto recharge preferences tags: - AutoRechargePreferences x-endpoint-cost: medium x-latency-category: responsive /phoneNumberAssignmentByProfile: post: description: This endpoint allows you to link all phone numbers associated with a Messaging Profile to a campaign. **Please note:** if you want to assign phone numbers to a campaign that you did not create with Telnyx 10DLC services, this endpoint allows that provided that you've shared the campaign with Telnyx. In this case, only provide the parameter, `tcrCampaignId`, and not `campaignId`. In all other cases (where the campaign you're assigning was created with Telnyx 10DLC services), only provide `campaignId`, not `tcrCampaignId`. operationId: PostAssignMessagingProfileToCampaign parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignProfileToCampaignRequest' required: true responses: '202': content: application/json: schema: anyOf: - $ref: '#/components/schemas/AssignProfileToCampaignResponse' - $ref: '#/components/schemas/SettingsDataErrorMessage' title: Response Assign Messaging Profile To Campaign Public Phonenumberassignmentbyprofile Post description: Successful Response default: $ref: '#/components/responses/10dlc_GenericErrorResponse' summary: Assign Messaging Profile To Campaign tags: - Bulk Phone Number Campaigns x-latency-category: responsive /phoneNumberAssignmentByProfile/{taskId}: get: description: Check the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by `taskId`. operationId: GetAssignmentTaskStatus parameters: - in: path name: taskId required: true schema: title: Taskid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/AssignmentTaskStatusResponse' description: Successful Response default: $ref: '#/components/responses/10dlc_GenericErrorResponse' summary: Get Assignment Task Status tags: - Bulk Phone Number Campaigns x-latency-category: responsive /phoneNumberAssignmentByProfile/{taskId}/phoneNumbers: get: description: Check the status of the individual phone number/campaign assignments associated with the supplied `taskId`. operationId: GetPhoneNumberStatus parameters: - in: path name: taskId required: true schema: title: Taskid type: string - in: query name: recordsPerPage required: false schema: default: 20 title: Recordsperpage type: integer - in: query name: page required: false schema: default: 1 title: Page type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhoneNumberStatusResponsePaginated' description: Successful Response default: $ref: '#/components/responses/10dlc_GenericErrorResponse' summary: Get Phone Number Status tags: - Bulk Phone Number Campaigns x-latency-category: responsive /phone_number_blocks/jobs: get: operationId: ListPhoneNumberBlocksJobs parameters: - $ref: '#/components/parameters/numbers_PageConsolidated' - 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 - description: 'Consolidated filter parameter (deepObject style). Originally: filter[type], filter[status]' explode: true in: query name: filter schema: properties: status: description: Identifies the status of the background job. enum: - pending - in_progress - completed - failed example: in_progress type: string type: description: Identifies the type of the background job. enum: - delete_phone_number_block example: delete_phone_number_block type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPhoneNumberBlocksJobsResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Lists the phone number blocks jobs tags: - Phone 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: CreatePhoneNumberBlockDeletionJob 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/numbers_GenericErrorResponse' summary: Deletes all numbers associated with a phone number block tags: - Phone Number Blocks Background Jobs x-group-parameters: 'true' x-latency-category: background /phone_number_blocks/jobs/{id}: get: operationId: GetPhoneNumberBlocksJob 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/numbers_GenericErrorResponse' summary: Retrieves a phone number blocks job tags: - Phone Number Blocks Background Jobs x-group-parameters: 'true' x-latency-category: responsive /phone_number_campaigns: get: operationId: GetAllPhoneNumberCampaigns parameters: - in: query name: recordsPerPage required: false schema: default: 20 title: Recordsperpage type: integer - in: query name: page required: false schema: default: 1 title: Page type: integer - $ref: '#/components/parameters/10dlc_FilterConsolidated' - description: Specifies the sort order for results. If not given, results are sorted by createdAt in descending order. example: -phoneNumber in: query name: sort required: false schema: default: -createdAt description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - assignmentStatus - -assignmentStatus - createdAt - -createdAt - phoneNumber - -phoneNumber title: Sort type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhoneNumberCampaignPaginated' description: Successful Response default: $ref: '#/components/responses/10dlc_GenericErrorResponse' summary: Retrieve All Phone Number Campaigns tags: - Phone Number Campaigns x-latency-category: responsive post: operationId: CreatePhoneNumberCampaign parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PhoneNumberCampaignCreate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhoneNumberCampaign' description: Successful Response default: $ref: '#/components/responses/10dlc_GenericErrorResponse' summary: Create New Phone Number Campaign tags: - Phone Number Campaigns x-latency-category: responsive /phone_number_campaigns/{phoneNumber}: delete: description: This endpoint allows you to remove a campaign assignment from the supplied `phoneNumber`. operationId: DeletePhoneNumberCampaign parameters: - in: path name: phoneNumber required: true schema: title: Phonenumber type: string responses: '200': $ref: '#/components/responses/SinglePhoneNumberCampaign' default: $ref: '#/components/responses/10dlc_GenericErrorResponse' summary: Delete Phone Number Campaign tags: - Phone Number Campaigns x-latency-category: responsive get: description: Retrieve an individual phone number/campaign assignment by `phoneNumber`. operationId: GetSinglePhoneNumberCampaign parameters: - in: path name: phoneNumber required: true schema: title: Phonenumber type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhoneNumberCampaign' description: Successful Response default: $ref: '#/components/responses/10dlc_GenericErrorResponse' summary: Get Single Phone Number Campaign tags: - Phone Number Campaigns x-latency-category: responsive put: operationId: PutPhoneNumberCampaign parameters: - in: path name: phoneNumber required: true schema: title: Phonenumber type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PhoneNumberCampaignCreate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PhoneNumberCampaign' description: Successful Response default: $ref: '#/components/responses/10dlc_GenericErrorResponse' summary: Create New Phone Number Campaign tags: - Phone Number Campaigns x-latency-category: responsive /phone_numbers: get: operationId: ListPhoneNumbers parameters: - $ref: '#/components/parameters/numbers_PageConsolidated' - 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 - description: 'Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[phone_number], filter[status], filter[country_iso_alpha2], filter[connection_id], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference], filter[number_type], filter[source]' explode: true in: query name: filter schema: properties: billing_group_id: 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'. example: 62e4bf2e-c278-4282-b524-488d9c9c43b2 type: string connection_id: description: Filter by connection_id. example: '1521916448077776306' type: string country_iso_alpha2: description: Filter by phone number country ISO alpha-2 code. Can be a single value or an array of values. oneOf: - example: US type: string - example: - US - CA items: type: string type: array customer_reference: description: Filter numbers via the customer_reference set. type: string emergency_address_id: 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'. example: '9102160989215728032' type: string number_type: additionalProperties: false description: Filter phone numbers by phone number type. properties: eq: description: Filter phone numbers by phone number type. enum: - local - national - toll_free - mobile - shared_cost type: string type: object phone_number: description: "Filter by phone number. Requires at least three digits.\n\ \ Non-numerical characters will result in no values being\ \ returned." type: string source: description: Filter phone numbers by their source. Use 'ported' for numbers ported from other carriers, or 'purchased' for numbers bought directly from Telnyx. enum: - ported - purchased type: string status: description: Filter by phone number status. enum: - purchase-pending - purchase-failed - port-pending - active - deleted - port-failed - emergency-only - ported-out - port-out-pending example: active type: string tag: description: Filter by phone number tags. type: string voice.connection_name: additionalProperties: false description: Filter by voice connection name pattern matching. properties: contains: description: Filter contains connection name. Requires at least three characters. example: test type: string ends_with: description: Filter ends with connection name. Requires at least three characters. example: test type: string eq: description: Filter by connection name. example: test type: string starts_with: description: Filter starts with connection name. Requires at least three characters. example: test type: string type: object voice.usage_payment_method: description: Filter by usage_payment_method. enum: - pay-per-minute - channel example: channel type: string without_tags: description: When set to 'true', filters for phone numbers that do not have any tags applied. All other values are ignored. enum: - 'true' - 'false' type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPhoneNumbersResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List phone numbers tags: - Phone Number Configurations x-endpoint-cost: medium x-group-parameters: 'true' x-latency-category: responsive /phone_numbers/actions/verify_ownership: post: description: Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account. operationId: VerifyPhoneNumberOwnership requestBody: content: application/json: schema: $ref: '#/components/schemas/PhoneNumberVerifyOwnershipRequest' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/PhoneNumberVerifyOwnershipResponse' title: Phone Number Verify Ownership Response type: object description: Phone number ownership verification completed. '422': content: application/json: schema: $ref: '#/components/schemas/numbers_Errors' description: Unprocessable Entity default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Verify ownership of phone numbers tags: - Phone Number Configurations x-endpoint-cost: light x-latency-category: responsive /phone_numbers/csv_downloads: get: operationId: ListCsvDownloads parameters: - $ref: '#/components/parameters/numbers_PageConsolidated' responses: '200': $ref: '#/components/responses/ListCsvDownloadsResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List CSV downloads tags: - CSV Downloads x-endpoint-cost: medium x-group-parameters: 'true' x-latency-category: responsive post: operationId: CreateCsvDownload parameters: - description: Which format to use when generating the CSV file. The default for backwards compatibility is 'V1' in: query name: csv_format required: false schema: default: V1 enum: - V1 - V2 example: V2 type: string - description: 'Consolidated filter parameter (deepObject style). Originally: filter[has_bundle], filter[tag], filter[connection_id], filter[phone_number], filter[status], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference]' explode: true in: query name: filter schema: properties: billing_group_id: 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'. example: 62e4bf2e-c278-4282-b524-488d9c9c43b2 type: string connection_id: description: Filter by connection_id. example: '1521916448077776306' type: string customer_reference: description: Filter numbers via the customer_reference set. type: string emergency_address_id: 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'. example: '9102160989215728032' type: string has_bundle: description: Filter by phone number that have bundles. type: string phone_number: description: "Filter by phone number. Requires at least three digits.\n\ \ Non-numerical characters will result in no values being\ \ returned." type: string status: description: Filter by phone number status. enum: - purchase-pending - purchase-failed - port-pending - active - deleted - port-failed - emergency-only - ported-out - port-out-pending example: active type: string tag: description: Filter by phone number tags. type: string voice.connection_name: additionalProperties: false description: Filter by voice connection name pattern matching. properties: contains: description: Filter contains connection name. Requires at least three characters. example: test type: string ends_with: description: Filter ends with connection name. Requires at least three characters. example: test type: string eq: description: Filter by connection name. example: test type: string starts_with: description: Filter starts with connection name. Requires at least three characters. example: test type: string type: object voice.usage_payment_method: description: Filter by usage_payment_method. enum: - pay-per-minute - channel example: channel type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/CsvDownloadResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Create a CSV download tags: - CSV Downloads x-endpoint-cost: medium x-latency-category: background /phone_numbers/csv_downloads/{id}: get: operationId: GetCsvDownload 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/numbers_GenericErrorResponse' summary: Retrieve a CSV download tags: - CSV Downloads x-endpoint-cost: medium x-latency-category: background /phone_numbers/jobs: get: operationId: ListPhoneNumbersJobs parameters: - $ref: '#/components/parameters/numbers_PageConsolidated' - 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 - description: 'Consolidated filter parameter (deepObject style). Originally: filter[type]' explode: true in: query name: filter schema: properties: type: description: Identifies the type of the background job. enum: - update_emergency_settings - delete_phone_numbers - update_phone_numbers example: update_emergency_settings type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPhoneNumbersJobsResponse' '401': $ref: '#/components/responses/numbers_UnauthorizedResponse' '422': content: application/json: examples: Invalid page number: value: errors: - code: '10015' detail: The provided 'page' parameter is invalid. It must be an object with 'size' and/or 'number' with numeric values. meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: page/number title: Invalid pagination Invalid page size: value: errors: - code: '10015' detail: The provided 'page' parameter is invalid. It must be an object with 'size' and/or 'number' with numeric values. meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: page/size title: Invalid pagination Invalid sorting value: value: errors: - code: '10015' detail: The value provided for sorting is not valid. Check the value used and try again. meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /sort title: Invalid sorting value schema: $ref: '#/components/schemas/numbers_Errors' description: Unprocessable Entity default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Lists the phone numbers jobs tags: - Bulk Phone Number Operations 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: CreateDeletePhoneNumbersJob 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. '401': $ref: '#/components/responses/numbers_UnauthorizedResponse' '403': $ref: '#/components/responses/numbers_ForbiddenResponse' '422': content: application/json: examples: Maximum allowed phone numbers: $ref: '#/components/examples/MaximumAllowedPhoneNumbers' Maximum jobs allowed: $ref: '#/components/examples/Maximum20JobsAllowed' Minimum allowed phone numbers: $ref: '#/components/examples/MinimumAllowedPhoneNumbers' Mixed IDs and E164 values: $ref: '#/components/examples/MixedIdsAndE164Values' Phone number ownership: $ref: '#/components/examples/PhoneNumberOwnership' Phone numbers must be present: $ref: '#/components/examples/PhoneNumbersMustBePresent' schema: $ref: '#/components/schemas/numbers_Errors' description: Unprocessable Entity default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Delete a batch of numbers tags: - Bulk Phone Number Operations 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. '401': $ref: '#/components/responses/numbers_UnauthorizedResponse' '403': $ref: '#/components/responses/numbers_ForbiddenResponse' '422': content: application/json: examples: Maximum allowed phone numbers: $ref: '#/components/examples/MaximumAllowedPhoneNumbers' Maximum jobs allowed: value: errors: - code: '10015' detail: You can have at most 500 pending or in progress jobs meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /base title: Bad Request Minimum allowed phone numbers: $ref: '#/components/examples/MinimumAllowedPhoneNumbers' Mixed IDs and E164 values: $ref: '#/components/examples/MixedIdsAndE164Values' Phone number ownership: $ref: '#/components/examples/PhoneNumberOwnership' Phone numbers must be present: $ref: '#/components/examples/PhoneNumbersMustBePresent' schema: $ref: '#/components/schemas/numbers_Errors' description: Unprocessable Entity default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Update the emergency settings from a batch of numbers tags: - Bulk Phone Number Operations 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. IMPORTANT: You must either specify filters (using the filter parameters) or specific phone numbers (using the phone_numbers parameter in the request body). If you specify filters, ALL phone numbers that match the given filters (up to 1000 at a time) will be updated. If you want to update only specific numbers, you must use the phone_numbers parameter in the request body. When using the phone_numbers parameter, ensure you follow the correct format as shown in the example (either phone number IDs or phone numbers in E164 format).' operationId: CreateUpdatePhoneNumbersJob parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[has_bundle], filter[tag], filter[connection_id], filter[phone_number], filter[status], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference]' explode: true in: query name: filter schema: properties: billing_group_id: 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'. example: 62e4bf2e-c278-4282-b524-488d9c9c43b2 type: string connection_id: description: Filter by connection_id. example: '1521916448077776306' type: string customer_reference: description: Filter numbers via the customer_reference set. type: string emergency_address_id: 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'. example: '9102160989215728032' type: string has_bundle: description: Filter by phone number that have bundles. type: string phone_number: description: "Filter by phone number. Requires at least three digits.\n\ \ Non-numerical characters will result in no values being\ \ returned." type: string status: description: Filter by phone number status. enum: - purchase-pending - purchase-failed - port-pending - active - deleted - port-failed - emergency-only - ported-out - port-out-pending example: active type: string tag: description: Filter by phone number tags. type: string voice.connection_name: additionalProperties: false description: Filter by voice connection name pattern matching. properties: contains: description: Filter contains connection name. Requires at least three characters. example: test type: string ends_with: description: Filter ends with connection name. Requires at least three characters. example: test type: string eq: description: Filter by connection name. example: test type: string starts_with: description: Filter starts with connection name. Requires at least three characters. example: test type: string type: object voice.usage_payment_method: description: Filter by usage_payment_method. enum: - pay-per-minute - channel example: channel type: string type: object style: deepObject 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. '401': $ref: '#/components/responses/numbers_UnauthorizedResponse' '403': content: application/json: examples: Billing group not authorized: value: errors: - code: '10010' detail: The specified billing group either does not exist or is not part of your account meta: url: https://developers.telnyx.com/docs/overview/errors/10010 source: pointer: /billing_group_id title: Authorization Failed Not authorized: $ref: '#/components/examples/NotAuthorized' schema: $ref: '#/components/schemas/numbers_Errors' description: Forbidden '422': content: application/json: examples: Maximum allowed phone numbers: $ref: '#/components/examples/MaximumAllowedPhoneNumbers' Maximum jobs allowed: $ref: '#/components/examples/Maximum20JobsAllowed' Minimum allowed phone numbers: $ref: '#/components/examples/MinimumAllowedPhoneNumbers' Minimum updateable field: value: errors: - code: '10015' detail: You must provide at least 1 updateable field. meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /updateable_fields title: Bad Request Mixed IDs and E164 values: $ref: '#/components/examples/MixedIdsAndE164Values' Phone number ownership: $ref: '#/components/examples/PhoneNumberOwnership' Phone numbers must be present: $ref: '#/components/examples/PhoneNumbersMustBePresent' schema: $ref: '#/components/schemas/numbers_Errors' description: Unprocessable Entity default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Update a batch of numbers tags: - Bulk Phone Number Operations 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. '401': $ref: '#/components/responses/numbers_UnauthorizedResponse' '404': content: application/json: examples: Resource not found: value: errors: - code: '10005' detail: The requested resource or URL could not be found. meta: url: https://developers.telnyx.com/docs/overview/errors/10005 source: pointer: /base title: Resource not found schema: $ref: '#/components/schemas/numbers_Errors' description: Not Found default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve a phone numbers job tags: - Bulk Phone Number Operations x-group-parameters: 'true' x-latency-category: responsive /phone_numbers/messaging: get: operationId: ListPhoneNumbersWithMessagingSettings parameters: - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/ListPhoneNumbersWithMessagingSettingsResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: List phone numbers with messaging settings tags: - Number Configurations x-group-parameters: 'true' x-latency-category: responsive /phone_numbers/slim: get: description: List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit. operationId: SlimListPhoneNumbers parameters: - $ref: '#/components/parameters/numbers_PageConsolidated' - description: Include the connection associated with the phone number. in: query name: include_connection required: false schema: default: false type: boolean - description: Include the tags associated with the phone number. in: query name: include_tags required: false schema: default: false type: boolean - 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 - description: 'Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[phone_number], filter[status], filter[country_iso_alpha2], filter[connection_id], filter[voice.connection_name], filter[voice.usage_payment_method], filter[billing_group_id], filter[emergency_address_id], filter[customer_reference], filter[number_type], filter[source]' explode: true in: query name: filter schema: properties: billing_group_id: 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'. example: 62e4bf2e-c278-4282-b524-488d9c9c43b2 type: string connection_id: description: Filter by connection_id. example: '1521916448077776306' type: string country_iso_alpha2: description: Filter by phone number country ISO alpha-2 code. Can be a single value or an array of values. oneOf: - example: US type: string - example: - US - CA items: type: string type: array customer_reference: description: Filter numbers via the customer_reference set. type: string emergency_address_id: 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'. example: '9102160989215728032' type: string number_type: additionalProperties: false description: Filter phone numbers by phone number type. properties: eq: description: Filter phone numbers by phone number type. enum: - local - national - toll_free - mobile - shared_cost type: string type: object phone_number: description: "Filter by phone number. Requires at least three digits.\n\ \ Non-numerical characters will result in no values being\ \ returned." type: string source: description: Filter phone numbers by their source. Use 'ported' for numbers ported from other carriers, or 'purchased' for numbers bought directly from Telnyx. enum: - ported - purchased type: string status: description: Filter by phone number status. enum: - purchase-pending - purchase-failed - port_pending - active - deleted - port-failed - emergency-only - ported-out - port-out-pending example: active type: string tag: description: Filter by phone number tags. (This requires the include_tags param) type: string voice.connection_name: additionalProperties: false description: Filter by voice connection name pattern matching (requires include_connection param). properties: contains: description: Filter contains connection name. Requires at least three characters and the include_connection param. example: test type: string ends_with: description: Filter ends with connection name. Requires at least three characters and the include_connection param. example: test type: string eq: description: Filter by connection name. example: test type: string starts_with: description: Filter starts with connection name. Requires at least three characters and the include_connection param. example: test type: string type: object voice.usage_payment_method: description: Filter by usage_payment_method. enum: - pay-per-minute - channel example: channel type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/SlimListPhoneNumbersResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Slim List phone numbers tags: - Phone Number Configurations x-endpoint-cost: medium x-group-parameters: 'true' x-latency-category: responsive /phone_numbers/voice: get: operationId: ListPhoneNumbersWithVoiceSettings parameters: - $ref: '#/components/parameters/numbers_PageConsolidated' - 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 - description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[connection_name], filter[customer_reference], filter[voice.usage_payment_method]' explode: true in: query name: filter schema: properties: connection_name: additionalProperties: false description: Filter by connection name pattern matching. properties: contains: description: Filter contains connection name. Requires at least three characters. example: test type: string type: object customer_reference: description: Filter numbers via the customer_reference set. type: string phone_number: description: "Filter by phone number. Requires at least three digits.\n\ \ Non-numerical characters will result in no values being\ \ returned." type: string voice.usage_payment_method: description: Filter by usage_payment_method. enum: - pay-per-minute - channel example: channel type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPhoneNumbersWithVoiceSettingsResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List phone numbers with voice settings tags: - Phone 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/numbers_GenericErrorResponse' summary: Delete a phone number tags: - Phone 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/numbers_GenericErrorResponse' summary: Retrieve a phone number tags: - Phone 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/numbers_GenericErrorResponse' summary: Update a phone number tags: - Phone Number Configurations x-endpoint-cost: medium x-latency-category: responsive /phone_numbers/{id}/actions/bundle_status_change: patch: operationId: PhoneNumberBundleStatusChange parameters: - $ref: '#/components/parameters/IntId' requestBody: content: application/json: schema: $ref: '#/components/schemas/PhoneNumberBundleStatusChangeRequest' required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/PhoneNumberWithVoiceSettings' title: Phone Number Bundle Status Change type: object description: Phone number bundle status change success default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Change the bundle status for a phone number (set to being in a bundle or remove from a bundle) tags: - Phone Number Configurations x-endpoint-cost: medium x-latency-category: responsive /phone_numbers/{id}/actions/enable_emergency: post: operationId: EnablePhoneNumberEmergency 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/numbers_GenericErrorResponse' summary: Enable emergency for a phone number tags: - Phone Number Configurations x-endpoint-cost: medium x-latency-category: responsive /phone_numbers/{id}/messaging: get: operationId: GetPhoneNumberMessagingSettings 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/messaging_GenericErrorResponse' summary: Retrieve a phone number with messaging settings tags: - Number Configurations x-latency-category: responsive patch: operationId: UpdatePhoneNumberMessagingSettings parameters: - description: The phone number to update. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePhoneNumberMessagingSettingsRequest' description: 'The new configuration to set for this phone number. To avoid modifying a value, either omit the field or set its value to `null`.' required: true responses: '200': $ref: '#/components/responses/PhoneNumberWithMessagingSettingsResponse' default: $ref: '#/components/responses/messaging_GenericErrorResponse' summary: Update the messaging profile and/or messaging product of a phone number tags: - Number Configurations x-latency-category: responsive /phone_numbers/{id}/voice: get: operationId: GetPhoneNumberVoiceSettings parameters: - $ref: '#/components/parameters/IntId' responses: '200': $ref: '#/components/responses/PhoneNumberWithVoiceSettingsResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve a phone number with voice settings tags: - Phone Number Configurations x-endpoint-cost: medium x-latency-category: responsive patch: operationId: UpdatePhoneNumberVoiceSettings 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/numbers_GenericErrorResponse' summary: Update a phone number with voice settings tags: - Phone Number Configurations x-endpoint-cost: medium x-latency-category: responsive /phone_numbers/{phone_number_id}/voicemail: get: description: Returns the voicemail settings for a phone number operationId: GetVoicemail responses: '200': $ref: '#/components/responses/VoicemailResponse' '400': description: Bad request '401': description: Unauthorized '404': description: Resource not found summary: Get voicemail tags: - Voicemail x-latency-category: responsive parameters: - description: The ID of the phone number. example: '123455678900' in: path name: phone_number_id required: true schema: type: string patch: description: Update voicemail settings for a phone number operationId: UpdateVoicemail requestBody: content: application/json: schema: $ref: '#/components/schemas/VoicemailRequest' description: Details to update required: true responses: '200': $ref: '#/components/responses/VoicemailResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Bad request summary: Update voicemail tags: - Voicemail x-latency-category: responsive post: description: Create voicemail settings for a phone number operationId: CreateVoicemail requestBody: content: application/json: schema: $ref: '#/components/schemas/VoicemailRequest' description: Details to create required: true responses: '200': $ref: '#/components/responses/VoicemailResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Bad request summary: Create voicemail tags: - Voicemail x-latency-category: responsive /phone_numbers_regulatory_requirements: get: operationId: ListRegulatoryRequirementsPhoneNumbers parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number]' explode: true in: query name: filter schema: properties: phone_number: description: Record type phone number/ phone numbers example: +41215470622,+41215470633 type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/listRegulatoryRequirementsPhoneNumbers' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve regulatory requirements for a list of phone numbers tags: - Regulatory Requirements 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/events: get: description: Returns a list of all porting events. operationId: listPortingEvents parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[type], filter[porting_order_id], filter[created_at][gte], filter[created_at][lte]' explode: true in: query name: filter schema: properties: created_at: description: Created at date range filtering operations properties: gte: description: Filter by created at greater than or equal to. example: '2021-01-01T00:00:00Z' format: date-time type: string lte: description: Filter by created at less than or equal to. example: '2021-01-01T00:00:00Z' format: date-time type: string type: object porting_order_id: description: Filter by porting order ID. example: 34dc46a9-53ed-4e01-9454-26227ea13326 format: uuid type: string type: description: Filter by event type. enum: - porting_order.deleted - porting_order.loa_updated - porting_order.messaging_changed - porting_order.status_changed - porting_order.sharing_token_expired - porting_order.new_comment - porting_order.split example: porting_order.deleted type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingEventsResponse' '500': description: Internal server error summary: List all porting events tags: - Porting Orders x-latency-category: responsive /porting/events/{id}: get: description: Show a specific porting event. operationId: showPortingEvent parameters: - description: Identifies the porting event. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingEventResponse' '404': description: Not found '500': description: Internal server error summary: Show a porting event tags: - Porting Orders x-latency-category: responsive /porting/events/{id}/republish: post: description: Republish a specific porting event. operationId: republishPortingEvent parameters: - description: Identifies the porting event. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No content '404': description: Not found '500': description: Internal server error summary: Republish a porting event tags: - Porting Orders x-latency-category: responsive /porting/loa_configuration/preview: post: description: Preview the LOA template that would be generated without need to create LOA configuration. operationId: PreviewLoaConfigurationParams requestBody: $ref: '#/components/requestBodies/CreatePortingLOAConfiguration' responses: '200': $ref: '#/components/responses/DownloadLOATemplate' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Preview the LOA configuration parameters tags: - Porting Orders x-latency-category: responsive /porting/loa_configurations: get: description: List the LOA configurations. operationId: ListLoaConfigurations parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' responses: '200': $ref: '#/components/responses/ListPortingLOAConfigurations' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: List LOA configurations tags: - Porting Orders x-latency-category: responsive post: description: Create a LOA configuration. operationId: CreateLoaConfiguration requestBody: $ref: '#/components/requestBodies/CreatePortingLOAConfiguration' responses: '201': $ref: '#/components/responses/CreatePortingLOAConfiguration' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Create a LOA configuration tags: - Porting Orders x-latency-category: responsive /porting/loa_configurations/{id}: delete: description: Delete a specific LOA configuration. operationId: DeleteLoaConfiguration parameters: - description: Identifies a LOA configuration. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No content '404': description: Resource not found '500': description: Internal server error summary: Delete a LOA configuration tags: - Porting Orders x-latency-category: responsive get: description: Retrieve a specific LOA configuration. operationId: GetLoaConfiguration parameters: - description: Identifies a LOA configuration. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingLOAConfiguration' '404': description: Resource not found '500': description: Internal server error summary: Retrieve a LOA configuration tags: - Porting Orders x-latency-category: responsive patch: description: Update a specific LOA configuration. operationId: UpdateLoaConfiguration parameters: - description: Identifies a LOA configuration. in: path name: id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreatePortingLOAConfiguration' responses: '200': $ref: '#/components/responses/UpdatePortingLOAConfiguration' '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Update a LOA configuration tags: - Porting Orders x-latency-category: responsive /porting/loa_configurations/{id}/preview: get: description: Preview a specific LOA configuration. operationId: PreviewLoaConfiguration parameters: - description: Identifies a LOA configuration. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/DownloadLOATemplate' '404': description: Resource not found '500': description: Internal server error summary: Preview a LOA configuration tags: - Porting Orders x-latency-category: responsive /porting/reports: get: description: List the reports generated about porting operations. operationId: ListPortingReports parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]' explode: true in: query name: filter schema: properties: report_type: description: Filter reports of a specific type enum: - export_porting_orders_csv example: export_porting_orders_csv type: string status: description: Filter reports of a specific status enum: - pending - completed example: completed type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingReports' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: List porting related reports tags: - Porting Orders x-latency-category: responsive post: description: Generate reports about porting operations. operationId: CreatePortingReport requestBody: $ref: '#/components/requestBodies/CreatePortingReport' responses: '201': $ref: '#/components/responses/CreatePortingReport' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Create a porting related report tags: - Porting Orders x-latency-category: responsive /porting/reports/{id}: get: description: Retrieve a specific report generated. operationId: GetPortingReport parameters: - description: Identifies a report. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingReport' '404': description: Resource not found '500': description: Internal server error summary: Retrieve a report tags: - Porting Orders x-latency-category: responsive /porting/uk_carriers: get: description: List available carriers in the UK. operationId: listPortingUKCarriers responses: '200': $ref: '#/components/responses/ListPortingUKCarriersResponse' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: List available carriers in the UK tags: - Porting Orders x-latency-category: responsive /porting_orders: get: description: Returns a list of your porting order. operationId: ListPortingOrders parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - $ref: '#/components/parameters/QueryIncludePhoneNumbers' - $ref: '#/components/parameters/porting-order_FilterConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[customer_reference], filter[parent_support_key], filter[phone_numbers.country_code], filter[phone_numbers.carrier_name], filter[misc.type], filter[end_user.admin.entity_name], filter[end_user.admin.auth_person_name], filter[activation_settings.fast_port_eligible], filter[activation_settings.foc_datetime_requested][gt], filter[activation_settings.foc_datetime_requested][lt], filter[phone_numbers.phone_number][contains]' explode: true in: query name: filter schema: properties: activation_settings.fast_port_eligible: description: Filter results by fast port eligible type: boolean activation_settings.foc_datetime_requested: description: FOC datetime range filtering operations properties: gt: description: Filter results by foc date later than this value example: '2021-03-25T10:00:00.000Z' type: string lt: description: Filter results by foc date earlier than this value example: '2021-03-25T10:00:00.000Z' type: string type: object customer_reference: description: Filter results by customer_reference type: string end_user.admin.auth_person_name: description: Filter results by authorized person type: string end_user.admin.entity_name: description: Filter results by person or company name type: string misc.type: $ref: '#/components/schemas/PortingOrderType' description: Filter results by porting order type parent_support_key: description: Filter results by parent_support_key type: string phone_numbers.carrier_name: description: Filter results by old service provider type: string phone_numbers.country_code: description: Filter results by country ISO 3166-1 alpha-2 code type: string phone_numbers.phone_number: description: Phone number filtering operations properties: contains: description: Filter results by full or partial phone_number type: string type: object type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at - activation_settings.foc_datetime_requested - -activation_settings.foc_datetime_requested example: created_at type: string type: object style: deepObject 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 Orders 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/ListDraftPortingOrdersWithoutPagination' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Create a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/exception_types: get: description: Returns a list of all possible exception types for a porting order. operationId: ListExceptionTypes 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 Orders x-latency-category: responsive /porting_orders/phone_number_configurations: get: description: Returns a list of phone number configurations paginated. operationId: ListPhoneNumberConfigurations parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - $ref: '#/components/parameters/porting-order_FilterConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order.status][in][], filter[porting_phone_number][in][], filter[user_bundle_id][in][]' explode: true in: query name: filter schema: properties: porting_order.status: description: Filter results by specific porting order statuses items: enum: - activation-in-progress - cancel-pending - cancelled - draft - exception - foc-date-confirmed - in-process - ported - submitted example: - in-process - submitted type: string type: array porting_phone_number: description: Filter results by a list of porting phone number IDs items: example: 5d6f7ede-1961-4717-bfb5-db392c5efc2d format: uuid type: string type: array user_bundle_id: description: Filter results by a list of user bundle IDs items: example: 5d6f7ede-1961-4717-bfb5-db392c5efc2d format: uuid type: string type: array type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingPhoneNumberConfigurations' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List all phone number configurations tags: - Porting Orders x-latency-category: responsive post: description: Creates a list of phone number configurations. operationId: CreatePhoneNumberConfigurations requestBody: $ref: '#/components/requestBodies/CreatePortingPhoneNumberConfigurations' responses: '201': $ref: '#/components/responses/CreatePortingPhoneNumberConfigurations' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Create a list of phone number configurations tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}: delete: description: Deletes an existing porting order. This operation is restrict to porting orders in draft state. operationId: DeletePortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '204': description: No content '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Delete a porting order tags: - Porting Orders 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 Orders x-latency-category: responsive patch: description: 'Edits the details of an existing porting order. Any or all of a porting orders 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/UpdatePortingOrderResponse' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Edit a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/actions/activate: post: description: Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only. 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: Activate every number in a porting order asynchronously. tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/actions/cancel: post: description: Cancel a porting order operationId: CancelPortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '200': $ref: '#/components/responses/CancelPortingOrderResponse' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Cancel a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/actions/confirm: post: description: Confirm and submit your porting order. operationId: ConfirmPortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '200': $ref: '#/components/responses/ConfirmPortingOrderResponse' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: Submit a porting order. tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/actions/share: post: description: Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users. operationId: SharePortingOrder parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: $ref: '#/components/requestBodies/SharePortingOrder' responses: '201': $ref: '#/components/responses/SharePortingOrder' '401': description: Unauthorized '404': description: Porting Order not found summary: Share a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/activation_jobs: get: description: Returns a list of your porting activation jobs. operationId: ListPortingOrderActivationJobs parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' 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 Orders 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 Orders x-latency-category: responsive patch: description: Updates the activation time of a porting activation job. operationId: UpdatePortingOrdersActivationJob parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/PathPortingOrdersActivationJobID' requestBody: $ref: '#/components/requestBodies/UpdatePortingOrdersActivationJob' responses: '200': $ref: '#/components/responses/ShowPortingOrdersActivationJob' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Update a porting activation job tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/additional_documents: get: description: Returns a list of additional documents for a porting order. operationId: ListAdditionalDocuments parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[document_type]' explode: true in: query name: filter schema: properties: document_type: description: Filter additional documents by a list of document types items: enum: - loa - invoice - csr - other example: loa type: string type: array type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingAdditionalDocuments' '401': description: Unauthorized '404': description: Resource not found summary: List additional documents tags: - Porting Orders x-latency-category: responsive post: description: Creates a list of additional documents for a porting order. operationId: CreateAdditionalDocuments parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: $ref: '#/components/requestBodies/CreatePortingAdditionalDocuments' responses: '201': $ref: '#/components/responses/CreatePortingAdditionalDocuments' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a list of additional documents tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/additional_documents/{additional_document_id}: delete: description: Deletes an additional document for a porting order. operationId: DeleteAdditionalDocument parameters: - $ref: '#/components/parameters/PathPortingOrderID' - description: Additional document identification. in: path name: additional_document_id required: true schema: format: uuid type: string responses: '204': description: No content '401': description: Unauthorized '404': description: Resource not found summary: Delete an additional document tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/allowed_foc_windows: get: description: Returns a list of allowed FOC dates for a porting order. operationId: ListAllowedFocWindows parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '200': $ref: '#/components/responses/ListAllowedFocWindows' '401': description: Unauthorized summary: List allowed FOC dates tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/comments: get: description: Returns a list of all comments of a porting order. operationId: ListPortingOrderComments parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' 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 Orders 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 Orders x-latency-category: responsive /porting_orders/{id}/loa_template: get: description: Download a porting order loa template operationId: GetPortingOrderLoaTemplate parameters: - $ref: '#/components/parameters/PathPortingOrderID' - description: The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration will be used. example: a36c2277-446b-4d11-b4ea-322e02a5c08d in: query name: loa_configuration_id required: false schema: format: uuid type: string responses: '200': $ref: '#/components/responses/DownloadLOATemplate' '401': description: Unauthorized summary: Download a porting order loa template tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/requirements: get: description: Returns a list of all requirements based on country/number type for this porting order. operationId: ListPortingOrderRequirements parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' responses: '200': $ref: '#/components/responses/ListPortingOrderRequirements' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List porting order requirements tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/sub_request: get: description: Retrieve the associated V1 sub_request_id and port_request_id operationId: GetPortingOrderSubRequest parameters: - $ref: '#/components/parameters/PathPortingOrderID' responses: '200': $ref: '#/components/responses/SubRequestByPortingOrder' '401': description: Unauthorized '404': description: Porting Order not found summary: Retrieve the associated V1 sub_request_id and port_request_id tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/verification_codes: get: description: Returns a list of verification codes for a porting order. operationId: ListVerificationCodes parameters: - $ref: '#/components/parameters/PathPortingOrderID' - $ref: '#/components/parameters/porting-order_PageConsolidated' - $ref: '#/components/parameters/porting-order_FilterConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[verified]' explode: true in: query name: filter schema: properties: verified: description: Filter verification codes that have been verified or not example: true type: boolean type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingVerificationCodes' '401': description: Unauthorized '404': description: Resource not found summary: List verification codes tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/verification_codes/send: post: description: Send the verification code for all porting phone numbers. operationId: SendPortingVerificationCodes parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: $ref: '#/components/requestBodies/SendPortingVerificationCodes' responses: '204': description: No content '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Send the verification codes tags: - Porting Orders x-latency-category: responsive /porting_orders/{id}/verification_codes/verify: post: description: Verifies the verification code for a list of phone numbers. operationId: VerifyPortingVerificationCodes parameters: - $ref: '#/components/parameters/PathPortingOrderID' requestBody: $ref: '#/components/requestBodies/VerifyPortingVerificationCodes' responses: '200': $ref: '#/components/responses/VerifyPortingVerificationCodes' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Verify the verification code for a list of phone numbers tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/action_requirements: get: description: Returns a list of action requirements for a specific porting order. operationId: listPortingActionRequirements parameters: - description: The ID of the porting order in: path name: porting_order_id required: true schema: type: string - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[id][in][], filter[requirement_type_id], filter[action_type], filter[status]' explode: true in: query name: filter schema: properties: action_type: description: Filter action requirements by action type enum: - au_id_verification type: string id: description: Filter action requirements by a list of IDs items: format: uuid type: string type: array requirement_type_id: description: Filter action requirements by requirement type ID format: uuid type: string status: description: Filter action requirements by status enum: - created - pending - completed - cancelled - failed type: string type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order. enum: - created_at - -created_at - updated_at - -updated_at example: created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingActionRequirements' '401': description: Unauthorized '404': description: Porting order not found '500': description: Internal server error summary: List action requirements for a porting order tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/action_requirements/{id}/initiate: post: description: Initiates a specific action requirement for a porting order. operationId: initiatePortingActionRequirement parameters: - description: The ID of the porting order in: path name: porting_order_id required: true schema: type: string - description: The ID of the action requirement in: path name: id required: true schema: type: string requestBody: $ref: '#/components/requestBodies/InitiatePortingActionRequirement' responses: '200': $ref: '#/components/responses/ShowPortingActionRequirement' '400': description: Bad request '401': description: Unauthorized '404': description: Porting order or action requirement not found '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Initiate an action requirement tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/associated_phone_numbers: get: description: Returns a list of all associated phone numbers for a porting order. Associated phone numbers are used for partial porting in GB to specify which phone numbers should be kept or disconnected. operationId: listPortingAssociatedPhoneNumbers parameters: - description: Identifies the Porting Order associated with the phone numbers in: path name: porting_order_id required: true schema: format: uuid type: string - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[action]' explode: true in: query name: filter schema: properties: action: description: Filter results by action type enum: - keep - disconnect example: keep type: string phone_number: description: Filter results by a phone number. It should be in E.164 format. example: '+441234567890' type: string type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: default: -created_at description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order enum: - -created_at - created_at example: -created_at type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingAssociatedPhoneNumbers' '401': description: Unauthorized '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: List all associated phone numbers tags: - Porting Orders x-latency-category: responsive post: description: Creates a new associated phone number for a porting order. This is used for partial porting in GB to specify which phone numbers should be kept or disconnected. operationId: createPortingAssociatedPhoneNumber parameters: - description: Identifies the Porting Order associated with the phone number in: path name: porting_order_id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreatePortingAssociatedPhoneNumber' responses: '201': $ref: '#/components/responses/ShowPortingAssociatedPhoneNumber' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create an associated phone number tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/associated_phone_numbers/{id}: delete: description: Deletes an associated phone number from a porting order. operationId: deletePortingAssociatedPhoneNumber parameters: - description: Identifies the Porting Order associated with the phone number in: path name: porting_order_id required: true schema: format: uuid type: string - description: Identifies the associated phone number to be deleted in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingAssociatedPhoneNumber' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Delete an associated phone number tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/phone_number_blocks: get: description: Returns a list of all phone number blocks of a porting order. operationId: listPortingPhoneNumberBlocks parameters: - description: Identifies the Porting Order associated with the phone number blocks in: path name: porting_order_id required: true schema: format: uuid type: string - $ref: '#/components/parameters/porting-order_FilterConsolidated' - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order enum: - -created_at - created_at example: false type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingPhoneNumberBlocks' '401': description: Unauthorized '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: List all phone number blocks tags: - Porting Orders x-latency-category: responsive post: description: Creates a new phone number block. operationId: createPortingPhoneNumberBlock parameters: - description: Identifies the Porting Order associated with the phone number block in: path name: porting_order_id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreatePortingPhoneNumberBlock' responses: '201': $ref: '#/components/responses/ShowPortingPhoneNumberBlock' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a phone number block tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/phone_number_blocks/{id}: delete: description: Deletes a phone number block. operationId: deletePortingPhoneNumberBlock parameters: - description: Identifies the Porting Order associated with the phone number block in: path name: porting_order_id required: true schema: format: uuid type: string - description: Identifies the phone number block to be deleted in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingPhoneNumberBlock' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Delete a phone number block tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/phone_number_extensions: get: description: Returns a list of all phone number extensions of a porting order. operationId: listPortingPhoneNumberExtensions parameters: - description: Identifies the Porting Order associated with the phone number extensions in: path name: porting_order_id required: true schema: format: uuid type: string - $ref: '#/components/parameters/porting-order_FilterConsolidated' - $ref: '#/components/parameters/porting-order_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_phone_number_id]' explode: true in: query name: filter schema: properties: porting_phone_number_id: description: Filter results by porting phone number id example: 04f8f1b9-310c-4a3c-963e-7dfc54765140 format: uuid type: string type: object style: deepObject - description: 'Consolidated sort parameter (deepObject style). Originally: sort[value]' explode: true in: query name: sort schema: properties: value: description: Specifies the sort order for results. If not given, results are sorted by created_at in descending order enum: - -created_at - created_at example: false type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingPhoneNumberExtensions' '401': description: Unauthorized '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: List all phone number extensions tags: - Porting Orders x-latency-category: responsive post: description: Creates a new phone number extension. operationId: createPortingPhoneNumberExtension parameters: - description: Identifies the Porting Order associated with the phone number extension in: path name: porting_order_id required: true schema: format: uuid type: string requestBody: $ref: '#/components/requestBodies/CreatePortingPhoneNumberExtension' responses: '201': $ref: '#/components/responses/ShowPortingPhoneNumberExtension' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a phone number extension tags: - Porting Orders x-latency-category: responsive /porting_orders/{porting_order_id}/phone_number_extensions/{id}: delete: description: Deletes a phone number extension. operationId: deletePortingPhoneNumberExtension parameters: - description: Identifies the Porting Order associated with the phone number extension in: path name: porting_order_id required: true schema: format: uuid type: string - description: Identifies the phone number extension to be deleted in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortingPhoneNumberExtension' '404': description: Not found '422': description: Unprocessable entity. Check message field in response for details. summary: Delete a phone number extension tags: - Porting Orders x-latency-category: responsive /porting_phone_numbers: get: description: Returns a list of your porting phone numbers. operationId: ListPortingPhoneNumbers parameters: - $ref: '#/components/parameters/porting-order_PageConsolidated' - $ref: '#/components/parameters/porting-order_FilterConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]' explode: true in: query name: filter schema: properties: porting_order_status: description: Filter results by porting order status enum: - draft - in-process - submitted - exception - foc-date-confirmed - cancel-pending - ported - cancelled example: in-process type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortingPhoneNumbers' '401': description: Unauthorized '422': description: Unprocessable entity. Check message field in response for details. summary: List all porting phone numbers tags: - Porting Orders x-latency-category: responsive /portouts: get: description: Returns the portout requests according to filters operationId: ListPortoutRequest parameters: - $ref: '#/components/parameters/PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[carrier_name], filter[country_code], filter[country_code_in], filter[foc_date], filter[inserted_at], filter[phone_number], filter[pon], filter[ported_out_at], filter[spid], filter[status], filter[status_in], filter[support_key]' explode: true in: query name: filter schema: properties: carrier_name: description: Filter by new carrier name. type: string country_code: description: Filter by 2-letter country code example: US type: string country_code_in: description: Filter by a list of 2-letter country codes example: - CA - US items: type: string type: array foc_date: description: Filter by foc_date. Matches all portouts with the same date example: '2024-09-04T00:00:00.000Z' format: date-time type: string inserted_at: description: Filter by inserted_at date range using nested operations properties: gte: description: Filter by inserted_at date greater than or equal. example: '2024-09-04T00:00:00.000Z' format: date-time type: string lte: description: Filter by inserted_at date less than or equal. example: '2024-09-04T00:00:00.000Z' format: date-time type: string type: object phone_number: description: Filter by a phone number on the portout. Matches all portouts with the phone number example: '+13035551212' type: string pon: description: Filter by Port Order Number (PON). type: string ported_out_at: description: Filter by ported_out_at date range using nested operations properties: gte: description: Filter by ported_out_at date greater than or equal. example: '2024-09-04T00:00:00.000Z' format: date-time type: string lte: description: Filter by ported_out_at date less than or equal. example: '2024-09-04T00:00:00.000Z' format: date-time type: string type: object spid: description: Filter by new carrier spid. type: string status: description: Filter by portout status. enum: - pending - authorized - ported - rejected - rejected-pending - canceled type: string status_in: description: Filter by a list of portout statuses items: enum: - pending - authorized - ported - rejected - rejected-pending - canceled type: string type: array support_key: description: Filter by the portout's support_key example: PO_abc123 type: string type: object style: deepObject 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: List portout requests tags: - Number Portout x-latency-category: responsive /portouts/events: get: description: Returns a list of all port-out events. operationId: listPortoutEvents parameters: - $ref: '#/components/parameters/PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[event_type], filter[portout_id], filter[created_at]' explode: true in: query name: filter schema: properties: created_at: description: Filter by created_at date range using nested operations properties: gte: description: Filter by created at greater than or equal to. example: '2021-01-01T00:00:00Z' format: date-time type: string lte: description: Filter by created at less than or equal to. example: '2021-01-01T00:00:00Z' format: date-time type: string type: object event_type: description: Filter by event type. enum: - portout.status_changed - portout.new_comment - portout.foc_date_changed example: portout.status_changed type: string portout_id: description: Filter by port-out order ID. example: 34dc46a9-53ed-4e01-9454-26227ea13326 format: uuid type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortoutEventsResponse' '500': description: Internal server error summary: List all port-out events tags: - Number Portout x-latency-category: responsive /portouts/events/{id}: get: description: Show a specific port-out event. operationId: showPortoutEvent parameters: - description: Identifies the port-out event. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortoutEventResponse' '404': description: Not found '500': description: Internal server error summary: Show a port-out event tags: - Number Portout x-latency-category: responsive /portouts/events/{id}/republish: post: description: Republish a specific port-out event. operationId: republishPortoutEvent parameters: - description: Identifies the port-out event. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No content '404': description: Not found '500': description: Internal server error summary: Republish a port-out event tags: - Number Portout x-latency-category: responsive /portouts/rejections/{portout_id}: get: description: Given a port-out ID, list rejection codes that are eligible for that port-out operationId: ListPortoutRejections parameters: - description: Identifies a port out order. in: path name: portout_id required: true schema: example: 329d6658-8f93-405d-862f-648776e8afd7 type: string - description: 'Consolidated filter parameter (deepObject style). Originally: filter[code], filter[code][in]' explode: true in: query name: filter schema: properties: code: oneOf: - description: Filter rejections of a specific code example: 1002 type: integer - description: Filter rejections in a list of codes example: - 1002 - 1003 items: type: integer type: array type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortoutRejections' '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: List eligible port-out rejection codes for a specific order tags: - Number Portout x-latency-category: responsive /portouts/reports: get: description: List the reports generated about port-out operations. operationId: ListPortoutReports parameters: - $ref: '#/components/parameters/PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]' explode: true in: query name: filter schema: properties: report_type: description: Filter reports of a specific type enum: - export_portouts_csv example: export_portouts_csv type: string status: description: Filter reports of a specific status enum: - pending - completed example: completed type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListPortoutReports' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: List port-out related reports tags: - Number Portout x-latency-category: responsive post: description: Generate reports about port-out operations. operationId: CreatePortoutReport requestBody: $ref: '#/components/requestBodies/CreatePortoutReport' responses: '201': $ref: '#/components/responses/CreatePortoutReport' '422': description: Unprocessable entity. Check message field in response for details. '500': description: Internal server error summary: Create a port-out related report tags: - Number Portout x-latency-category: responsive /portouts/reports/{id}: get: description: Retrieve a specific report generated. operationId: GetPortoutReport parameters: - description: Identifies a report. in: path name: id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/ShowPortoutReport' '404': description: Resource not found '500': description: Internal server error summary: Retrieve a report 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: Get 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}/supporting_documents: get: description: List every supporting documents for a portout request. operationId: GetPortRequestSupportingDocuments parameters: - description: Portout id in: path name: id required: true schema: format: uuid type: string responses: '201': $ref: '#/components/responses/PortOutListSupportingDocumentsResponse' '401': description: Unauthorized '404': description: Resource not found summary: List supporting documents on a portout request tags: - Number Portout x-latency-category: responsive post: description: Creates a list of supporting documents on a portout request. operationId: PostPortRequestSupportingDocuments parameters: - description: Portout id in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: properties: documents: description: List of supporting documents parameters items: properties: document_id: description: Identifies the associated document example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string type: description: Identifies the type of the document enum: - loa - invoice example: loa type: string required: - type - document_id type: object maxItems: 10 minItems: 1 type: array type: object required: true responses: '201': $ref: '#/components/responses/CreatePortOutSupportingDocumentsResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Unprocessable entity. Check message field in response for details. summary: Create a list of supporting documents on a portout request tags: - Number Portout x-latency-category: responsive /portouts/{id}/{status}: patch: description: Authorize or reject portout request operationId: UpdatePortoutStatus 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-pending type: string requestBody: content: application/json: schema: properties: host_messaging: default: false description: Indicates whether messaging services should be maintained with Telnyx after the port out completes example: false type: boolean reason: description: Provide a reason if rejecting the port out request example: I do not recognize this transaction type: string required: - reason type: object required: true 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/wireless_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: dc2 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' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get all Private Wireless Gateways tags: - Private Wireless Gateways x-latency-category: responsive post: description: Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. This operation may take several minutes so you can check the Private Wireless Gateway status at the section Get a Private Wireless Gateway. 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 region_code: description: The code of the region where the private wireless gateway will be assigned. A list of available regions can be found at the regions endpoint example: dc2 type: string required: - network_id - name type: object required: true responses: '202': $ref: '#/components/responses/CreatePrivateWirelessGatewayResponse' '422': $ref: '#/components/responses/wireless_UnprocessableEntity' default: $ref: '#/components/responses/wireless_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: DeleteWirelessGateway parameters: - $ref: '#/components/parameters/PrivateWirelessGatewayId' responses: '200': $ref: '#/components/responses/DeletePrivateWirelessGatewayResponse' '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_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/PrivateWirelessGatewayId' responses: '200': $ref: '#/components/responses/GetPrivateWirelessGatewayResponse' '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get a Private Wireless Gateway tags: - Private Wireless Gateways x-latency-category: responsive /public_internet_gateways: get: description: List all Public Internet Gateways. operationId: ListPublicInternetGateways parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[network_id]' explode: true in: query name: filter schema: properties: network_id: description: The associated network id to filter on. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/PublicInternetGatewayListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Public Internet Gateways tags: - Public Internet Gateways x-latency-category: responsive post: description: Create a new Public Internet Gateway. operationId: CreatePublicInternetGateway requestBody: content: application/json: schema: $ref: '#/components/schemas/PublicInternetGatewayCreate' required: true responses: '202': $ref: '#/components/responses/PublicInternetGatewayResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create a Public Internet Gateway tags: - Public Internet Gateways x-latency-category: responsive /public_internet_gateways/{id}: delete: description: Delete a Public Internet Gateway. operationId: DeletePublicInternetGateway parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/PublicInternetGatewayResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete a Public Internet Gateway tags: - Public Internet Gateways x-latency-category: responsive get: description: Retrieve a Public Internet Gateway. operationId: GetPublicInternetGateway parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/PublicInternetGatewayResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve a Public Internet Gateway tags: - Public Internet 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/call-control_PageConsolidated' 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 /recording_transcriptions: get: description: Returns a list of your recording transcriptions. operationId: getRecordingTranscriptions responses: '200': $ref: '#/components/responses/ListRecordingTranscriptionsResponse' default: $ref: '#/components/responses/GenericErrorResponse' summary: List all recording transcriptions tags: - Call Recordings x-latency-category: responsive /recording_transcriptions/{recording_transcription_id}: delete: description: Permanently deletes a recording transcription. operationId: deleteRecordingTranscription parameters: - $ref: '#/components/parameters/RecordingTranscriptionId' responses: '200': $ref: '#/components/responses/RecordingTranscriptionResponse' default: $ref: '#/components/responses/GenericErrorResponse' summary: Delete a recording transcription tags: - Call Recordings x-latency-category: responsive get: description: Retrieves the details of an existing recording transcription. operationId: getRecordingTranscription parameters: - $ref: '#/components/parameters/RecordingTranscriptionId' responses: '200': $ref: '#/components/responses/RecordingTranscriptionResponse' default: $ref: '#/components/responses/GenericErrorResponse' summary: Retrieve a recording transcription tags: - Call Recordings x-latency-category: responsive /recordings: get: description: Returns a list of your call recordings. operationId: GetRecordings parameters: - $ref: '#/components/parameters/call-recordings_PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[conference_id], filter[created_at][gte], filter[created_at][lte], filter[call_leg_id], filter[call_session_id], filter[from], filter[to], filter[connection_id]' explode: true in: query name: filter schema: properties: call_leg_id: description: If present, recordings will be filtered to those with a matching call_leg_id. example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 format: uuid type: string call_session_id: description: If present, recordings will be filtered to those with a matching call_session_id. example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 format: uuid type: string conference_id: description: Returns only recordings associated with a given conference. example: 428c31b6-7af4-4bcb-b7f5-5013ef9657c1 type: string connection_id: description: If present, recordings will be filtered to those with a matching `connection_id` attribute (case-sensitive). example: '175237942907135762' type: string created_at: additionalProperties: false properties: gte: description: Returns only recordings created later than or at given ISO 8601 datetime. example: '2019-03-29T11:10:00Z' type: string lte: description: Returns only recordings created earlier than or at given ISO 8601 datetime. example: '2019-03-29T11:10:00Z' type: string type: object from: description: If present, recordings will be filtered to those with a matching `from` attribute (case-sensitive). example: '1234567890' type: string to: description: If present, recordings will be filtered to those with a matching `to` attribute (case-sensitive). example: '1234567890' type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/RecordingsResponseBody' default: $ref: '#/components/responses/GenericErrorResponse' summary: List all call recordings tags: - Call Recordings x-latency-category: responsive /recordings/actions/delete: post: description: Permanently deletes a list of call recordings. operationId: DeleteRecordings requestBody: $ref: '#/components/requestBodies/DeleteRecordingsRequest' responses: '204': description: The recordings have been successfully deleted. default: $ref: '#/components/responses/GenericErrorResponse' summary: Delete a list of call recordings tags: - Call Recordings x-latency-category: responsive /recordings/{recording_id}: delete: description: Permanently deletes a call recording. operationId: DeleteRecording parameters: - $ref: '#/components/parameters/RecordingId' responses: '200': $ref: '#/components/responses/RecordingResponseBody' default: $ref: '#/components/responses/GenericErrorResponse' summary: Delete a call recording tags: - Call Recordings x-latency-category: responsive get: description: Retrieves the details of an existing call recording. operationId: GetRecording parameters: - $ref: '#/components/parameters/RecordingId' responses: '200': $ref: '#/components/responses/RecordingResponseBody' default: $ref: '#/components/responses/GenericErrorResponse' summary: Retrieve a call recording tags: - Call Recordings x-latency-category: responsive /regions: get: description: List all regions and the interfaces that region supports operationId: ListRegions responses: '200': $ref: '#/components/responses/RegionListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Regions tags: - Regions x-latency-category: responsive /regulatory_requirements: get: operationId: ListRegulatoryRequirements parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[requirement_group_id], filter[country_code], filter[phone_number_type], filter[action]' explode: true in: query name: filter schema: properties: action: description: Action to check requirements for enum: - ordering - porting - action type: string country_code: description: Country code(iso2) to check requirements for example: DE type: string phone_number: description: Phone number to check requirements for example: '+41215470622' type: string phone_number_type: description: Phone number type to check requirements for enum: - local - toll_free - mobile - national - shared_cost type: string requirement_group_id: description: ID of requirement group to check requirements for example: d4c0b4a6-7bd2-40c5-a3b9-2acd99e212b2 type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/listRegulatoryRequirements' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve regulatory requirements tags: - Regulatory Requirements x-latency-category: responsive /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: GetCDRUsageReportSync 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: [] summary: Generates and fetches CDR Usage Reports 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: GetMdrUsageReports parameters: - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' examples: page[number]=1&page[size]=20: summary: Default pagination with first page and 20 records per page value: number: 1 size: 20 page[number]=1&page[size]=50: summary: First page with 50 records per page value: number: 1 size: 50 page[number]=2&page[size]=20: summary: Second page with 20 records per page value: number: 2 size: 20 page[number]=5&page[size]=100: summary: Fifth page with 100 records per page value: number: 5 size: 100 explode: true in: query name: page schema: properties: number: default: 1 description: Page number format: int32 type: integer size: default: 20 description: Size of the page format: int32 type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/MdrGetUsageReportsResponse' description: Successful security: - bearerAuth: [] summary: Fetch all Messaging usage reports 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: [] summary: Create MDR Usage Report 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: GetMDRUsageReportSync 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: [] summary: Generate and fetch MDR Usage Report tags: - MDR Usage Reports x-latency-category: background /reports/mdr_usage_reports/{id}: delete: description: Delete messaging usage report by id operationId: DeleteUsageReport parameters: - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MdrDeleteUsageReportsResponse' description: Successful security: - bearerAuth: [] summary: Delete MDR Usage Report tags: - MDR Usage Reports x-latency-category: interactive get: description: Fetch a single messaging usage report by id operationId: GetUsageReport parameters: - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/MdrGetUsageReportsByIdResponse' description: Successful security: - bearerAuth: [] summary: Retrieve messaging report tags: - MDR Usage Reports x-latency-category: interactive /reports/mdrs: get: description: 'Fetch all Mdr records ' operationId: GetPaginatedMdrs 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: [] summary: Fetch all Mdr records 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 - 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 - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' explode: true in: query name: page schema: properties: number: default: 1 description: Page number format: int32 type: integer size: default: 20 description: Size of the page format: int32 type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExternalWdrGetDetailResponse' description: Successful summary: Fetches all Wdr records tags: - WDR Detail Reports x-latency-category: interactive /requirement_groups: get: operationId: GetRequirementGroups parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[country_code], filter[phone_number_type], filter[action], filter[status], filter[customer_reference]' explode: true in: query name: filter schema: properties: action: description: Filter requirement groups by action type enum: - ordering - porting - action type: string country_code: description: Filter requirement groups by country code (iso alpha 2) type: string customer_reference: description: Filter requirement groups by customer reference type: string phone_number_type: description: Filter requirement groups by phone number type. enum: - local - toll_free - mobile - national - shared_cost type: string status: description: Filter requirement groups by status enum: - approved - unapproved - pending-approval - declined type: string type: object style: deepObject responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/RequirementGroup' type: array description: List requirement groups summary: List requirement groups tags: - Requirement Groups x-latency-category: responsive post: operationId: CreateRequirementGroup requestBody: content: application/json: schema: properties: action: enum: - ordering - porting example: ordering type: string country_code: description: ISO alpha 2 country code example: US type: string customer_reference: example: My Requirement Group type: string phone_number_type: enum: - local - toll_free - mobile - national - shared_cost example: local type: string regulatory_requirements: items: properties: field_value: type: string requirement_id: type: string type: object type: array required: - country_code - phone_number_type - action type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequirementGroup' description: Requirement group created summary: Create a new requirement group tags: - Requirement Groups x-latency-category: responsive /requirement_groups/{id}: delete: operationId: DeleteRequirementGroup parameters: - description: ID of the requirement group in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequirementGroup' description: Deleted requirement group summary: Delete a requirement group by ID tags: - Requirement Groups x-latency-category: responsive get: operationId: GetRequirementGroup parameters: - description: ID of the requirement group to retrieve in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequirementGroup' description: A single requirement group summary: Get a single requirement group by ID tags: - Requirement Groups x-latency-category: responsive patch: operationId: UpdateRequirementGroup parameters: - description: ID of the requirement group in: path name: id required: true schema: type: string requestBody: content: application/json: schema: properties: customer_reference: description: Reference for the customer example: '0002' type: string regulatory_requirements: items: properties: field_value: description: New value for the regulatory requirement example: new requirement value type: string requirement_id: description: Unique identifier for the regulatory requirement example: 53970723-fbff-4f46-a975-f62be6c1a585 type: string type: object type: array type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequirementGroup' description: Updated requirement group summary: Update requirement values in requirement group tags: - Requirement Groups x-latency-category: responsive /requirement_groups/{id}/submit_for_approval: post: operationId: SubmitRequirementGroup parameters: - description: ID of the requirement group to submit in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RequirementGroup' description: A single requirement group summary: Submit a Requirement Group for Approval tags: - Requirement Groups x-latency-category: responsive /requirement_types: get: description: List all requirement types ordered by created_at descending operationId: ListRequirementTypes parameters: - $ref: '#/components/parameters/FilterRequirementTypesConsolidated' - $ref: '#/components/parameters/SortRequirementTypesConsolidated' responses: '200': $ref: '#/components/responses/DocReqsListRequirementTypesResponse' default: $ref: '#/components/responses/documents_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: RetrieveRequirementType parameters: - $ref: '#/components/parameters/DocReqsRequirementTypeId' responses: '200': $ref: '#/components/responses/DocReqsRequirementTypeResponse' default: $ref: '#/components/responses/documents_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/FilterRequirementsConsolidated' - $ref: '#/components/parameters/SortRequirementsConsolidated' - $ref: '#/components/parameters/documents_PageConsolidated' responses: '200': $ref: '#/components/responses/ListRequirementsResponse' default: $ref: '#/components/responses/documents_GenericErrorResponse' summary: List all requirements tags: - Requirements x-latency-category: responsive /requirements/{id}: get: description: Retrieve a document requirement record operationId: RetrieveDocumentRequirements parameters: - $ref: '#/components/parameters/DocReqsRequirementId' responses: '200': $ref: '#/components/responses/DocReqsRequirementResponse' default: $ref: '#/components/responses/documents_GenericErrorResponse' summary: Retrieve a document requirement tags: - Requirements x-latency-category: responsive /room_compositions: get: description: '' operationId: ListRoomCompositions parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[session_id], filter[status]' explode: true in: query name: filter required: false schema: properties: date_created_at: properties: eq: description: ISO 8601 date for filtering room compositions created on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room compositions created on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room compositions created on or before that date. example: '2021-04-25' format: date type: string type: object session_id: description: The session_id for filtering room compositions. example: 92e7d459-bcc5-4386-9f5f-6dd14a82588d format: uuid type: string status: description: The status for filtering room compositions. enum: - completed - processing - enqueued example: completed type: string type: object style: deepObject - $ref: '#/components/parameters/video_PageConsolidated' responses: '200': $ref: '#/components/responses/ListRoomCompositionsResponse' summary: View a list of room compositions. tags: - Room Compositions x-endpoint-cost: medium x-latency-category: responsive post: description: Asynchronously create a room composition. operationId: CreateRoomComposition requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRoomCompositionRequest' description: Parameters that can be defined during room composition creation. required: true responses: '202': $ref: '#/components/responses/CreateRoomCompositionResponse' '422': $ref: '#/components/responses/video_UnprocessableEntity' summary: Create a room composition. tags: - Room Compositions x-endpoint-cost: heavy x-latency-category: responsive /room_compositions/{room_composition_id}: delete: description: Synchronously delete a room composition. operationId: DeleteRoomComposition parameters: - description: The unique identifier of a room composition. in: path name: room_composition_id required: true schema: example: 5219b3af-87c6-4c08-9b58-5a533d893e21 format: uuid type: string responses: '204': description: The resource was deleted successfully. '404': $ref: '#/components/responses/video_ResourceNotFound' summary: Delete a room composition. tags: - Room Compositions x-endpoint-cost: medium x-latency-category: responsive get: operationId: ViewRoomComposition parameters: - description: The unique identifier of a room composition. in: path name: room_composition_id required: true schema: example: 5219b3af-87c6-4c08-9b58-5a533d893e21 format: uuid type: string responses: '200': $ref: '#/components/responses/GetRoomCompositionResponse' '404': $ref: '#/components/responses/video_ResourceNotFound' summary: View a room composition. tags: - Room Compositions x-endpoint-cost: light x-latency-category: responsive /room_participants: get: description: '' operationId: ListRoomParticipants parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_joined_at][eq], filter[date_joined_at][gte], filter[date_joined_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[date_left_at][eq], filter[date_left_at][gte], filter[date_left_at][lte], filter[context], filter[session_id]' explode: true in: query name: filter required: false schema: properties: context: description: Filter room participants based on the context. example: Alice type: string date_joined_at: properties: eq: description: ISO 8601 date for filtering room participants that joined on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room participants that joined on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room participants that joined on or before that date. example: '2021-04-25' format: date type: string type: object date_left_at: properties: eq: description: ISO 8601 date for filtering room participants that left on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room participants that left on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room participants that left on or before that date. example: '2021-04-25' format: date type: string type: object date_updated_at: properties: eq: description: ISO 8601 date for filtering room participants updated on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room participants updated on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room participants updated on or before that date. example: '2021-04-25' format: date type: string type: object session_id: description: Session_id for filtering room participants. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 type: string type: object style: deepObject - $ref: '#/components/parameters/video_PageConsolidated' 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/video_ResourceNotFound' summary: View a room participant. tags: - Room Participants x-endpoint-cost: light x-latency-category: responsive /room_recordings: delete: description: '' operationId: DeleteRoomRecordings parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[date_started_at][eq], filter[date_started_at][gte], filter[date_started_at][lte], filter[room_id], filter[participant_id], filter[session_id], filter[status], filter[type], filter[duration_secs]' explode: true in: query name: filter required: false schema: properties: date_ended_at: properties: eq: description: ISO 8601 date for filtering room recordings ended on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room recordings ended on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room recordings ended on or before that date. example: '2021-04-25' format: date type: string type: object date_started_at: properties: eq: description: ISO 8601 date for filtering room recordings started on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room recordings started on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room recordings started on or before that date. example: '2021-04-25' format: date type: string type: object duration_secs: description: duration_secs greater or equal for filtering room recordings. example: 20 type: integer participant_id: description: participant_id for filtering room recordings. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string room_id: description: room_id for filtering room recordings. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string session_id: description: session_id for filtering room recordings. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string status: description: status for filtering room recordings. example: completed type: string type: description: type for filtering room recordings. example: audio type: string type: object style: deepObject - $ref: '#/components/parameters/video_PageConsolidated' responses: '201': $ref: '#/components/responses/BulkDeleteRoomRecordingsResponse' '422': $ref: '#/components/responses/video_UnprocessableEntity' summary: Delete several room recordings in a bulk. tags: - Room Recordings x-endpoint-cost: heavy x-latency-category: responsive get: description: '' operationId: ListRoomRecordings parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[date_started_at][eq], filter[date_started_at][gte], filter[date_started_at][lte], filter[room_id], filter[participant_id], filter[session_id], filter[status], filter[type], filter[duration_secs]' explode: true in: query name: filter required: false schema: properties: date_ended_at: properties: eq: description: ISO 8601 date for filtering room recordings ended on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room recordings ended on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room recordings ended on or before that date. example: '2021-04-25' format: date type: string type: object date_started_at: properties: eq: description: ISO 8601 date for filtering room recordings started on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room recordings started on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room recordings started on or before that date. example: '2021-04-25' format: date type: string type: object duration_secs: description: duration_secs greater or equal for filtering room recordings. example: 20 type: integer participant_id: description: participant_id for filtering room recordings. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string room_id: description: room_id for filtering room recordings. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string session_id: description: session_id for filtering room recordings. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string status: description: status for filtering room recordings. example: completed type: string type: description: type for filtering room recordings. example: audio type: string type: object style: deepObject - $ref: '#/components/parameters/video_PageConsolidated' responses: '200': $ref: '#/components/responses/ListRoomRecordingsResponse' summary: View a list of room recordings. tags: - Room Recordings x-endpoint-cost: medium x-latency-category: responsive /room_recordings/{room_recording_id}: delete: description: Synchronously delete a Room Recording. operationId: DeleteRoomRecording parameters: - description: The unique identifier of a room recording. in: path name: room_recording_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/video_ResourceNotFound' summary: Delete a room recording. tags: - Room Recordings x-endpoint-cost: medium x-latency-category: responsive get: operationId: ViewRoomRecording parameters: - description: The unique identifier of a room recording. in: path name: room_recording_id required: true schema: example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 format: uuid type: string responses: '200': $ref: '#/components/responses/GetRoomRecordingResponse' '404': $ref: '#/components/responses/video_ResourceNotFound' summary: View a room recording. tags: - Room Recordings x-endpoint-cost: light x-latency-category: responsive /room_sessions: get: description: '' operationId: ListRoomSessions parameters: - description: To decide if room participants should be included in the response. in: query name: include_participants schema: example: true type: boolean - description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[room_id], filter[active]' explode: true in: query name: filter required: false schema: properties: active: description: Filter active or inactive room sessions. example: true type: boolean date_created_at: properties: eq: description: ISO 8601 date for filtering room sessions created on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room sessions created on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room sessions created on or before that date. example: '2021-04-25' format: date type: string type: object date_ended_at: properties: eq: description: ISO 8601 date for filtering room sessions ended on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room sessions ended on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room sessions ended on or before that date. example: '2021-04-25' format: date type: string type: object date_updated_at: properties: eq: description: ISO 8601 date for filtering room sessions updated on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room sessions updated on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room sessions updated on or before that date. example: '2021-04-25' format: date type: string type: object room_id: description: Room_id for filtering room sessions. example: 0ccc7b54-4df3-4bca-a65a-3da1ecc777f0 type: string type: object style: deepObject - $ref: '#/components/parameters/video_PageConsolidated' 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/video_ResourceNotFound' summary: View a room session. tags: - Room Sessions x-endpoint-cost: light x-latency-category: responsive /room_sessions/{room_session_id}/actions/end: post: description: 'Note: this will also kick all participants currently present in the room' operationId: EndSession 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 responses: '200': $ref: '#/components/responses/ActionSuccessResponse' security: [] summary: End a room session. tags: - Room Sessions x-endpoint-cost: medium x-latency-category: responsive /room_sessions/{room_session_id}/actions/kick: post: description: '' operationId: KickParticipantInSession 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ActionsParticipantsRequest' description: Parameters that can be defined during Kick action. required: true responses: '200': $ref: '#/components/responses/ActionSuccessResponse' security: [] summary: Kick participants from a room session. tags: - Room Sessions x-endpoint-cost: medium x-latency-category: responsive /room_sessions/{room_session_id}/actions/mute: post: description: '' operationId: MuteParticipantInSession 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ActionsParticipantsRequest' description: Parameters that can be defined during Mute action. required: true responses: '200': $ref: '#/components/responses/ActionSuccessResponse' security: [] summary: Mute participants in room session. tags: - Room Sessions x-endpoint-cost: medium x-latency-category: responsive /room_sessions/{room_session_id}/actions/unmute: post: description: '' operationId: UnmuteParticipantInSession 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ActionsParticipantsRequest' description: Parameters that can be defined during Unmute action. required: true responses: '200': $ref: '#/components/responses/ActionSuccessResponse' security: [] summary: Unmute participants in room session. tags: - Room Sessions x-endpoint-cost: medium x-latency-category: responsive /room_sessions/{room_session_id}/participants: get: description: '' operationId: RetrieveListRoomParticipants 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: 'Consolidated filter parameter (deepObject style). Originally: filter[date_joined_at][eq], filter[date_joined_at][gte], filter[date_joined_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[date_left_at][eq], filter[date_left_at][gte], filter[date_left_at][lte], filter[context]' explode: true in: query name: filter required: false schema: properties: context: description: Filter room participants based on the context. example: Alice type: string date_joined_at: properties: eq: description: ISO 8601 date for filtering room participants that joined on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room participants that joined on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room participants that joined on or before that date. example: '2021-04-25' format: date type: string type: object date_left_at: properties: eq: description: ISO 8601 date for filtering room participants that left on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room participants that left on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room participants that left on or before that date. example: '2021-04-25' format: date type: string type: object date_updated_at: properties: eq: description: ISO 8601 date for filtering room participants updated on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room participants updated on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room participants updated on or before that date. example: '2021-04-25' format: date type: string type: object type: object style: deepObject - $ref: '#/components/parameters/video_PageConsolidated' 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: To decide if room sessions should be included in the response. in: query name: include_sessions schema: example: true type: boolean - description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[unique_name]' explode: true in: query name: filter required: false schema: properties: date_created_at: properties: eq: description: ISO 8601 date for filtering rooms created on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering rooms created on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering rooms created on or before that date. example: '2021-04-25' format: date type: string type: object date_updated_at: properties: eq: description: ISO 8601 date for filtering rooms updated on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering rooms updated on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering rooms updated on or before that date. example: '2021-04-25' format: date type: string type: object unique_name: description: Unique_name for filtering rooms. example: my_video_room type: string type: object style: deepObject - $ref: '#/components/parameters/video_PageConsolidated' 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/video_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/video_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/video_ResourceNotFound' summary: View a room. tags: - Rooms x-endpoint-cost: light x-latency-category: responsive patch: description: Synchronously update a Room. operationId: UpdateRoom 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/PatchRoomRequest' description: Parameters that can be defined during room update. required: true responses: '200': $ref: '#/components/responses/PatchRoomResponse' '401': $ref: '#/components/responses/UnauthorizedResponse' '404': $ref: '#/components/responses/video_ResourceNotFound' '422': description: Bad request summary: Update a room. tags: - Rooms x-endpoint-cost: medium 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: RetrieveListRoomSessions 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 participants should be included in the response. in: query name: include_participants schema: example: true type: boolean - description: 'Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[date_updated_at][eq], filter[date_updated_at][gte], filter[date_updated_at][lte], filter[date_ended_at][eq], filter[date_ended_at][gte], filter[date_ended_at][lte], filter[active]' explode: true in: query name: filter required: false schema: properties: active: description: Filter active or inactive room sessions. example: true type: boolean date_created_at: properties: eq: description: ISO 8601 date for filtering room sessions created on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room sessions created on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room sessions created on or before that date. example: '2021-04-25' format: date type: string type: object date_ended_at: properties: eq: description: ISO 8601 date for filtering room sessions ended on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room sessions ended on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room sessions ended on or before that date. example: '2021-04-25' format: date type: string type: object date_updated_at: properties: eq: description: ISO 8601 date for filtering room sessions updated on that date. example: '2021-04-25' format: date type: string gte: description: ISO 8601 date for filtering room sessions updated on or after that date. example: '2021-04-25' format: date type: string lte: description: ISO 8601 date for filtering room sessions updated on or before that date. example: '2021-04-25' format: date type: string type: object type: object style: deepObject - $ref: '#/components/parameters/video_PageConsolidated' responses: '200': $ref: '#/components/responses/ListRoomSessionsResponse' summary: View a list of room sessions. tags: - Rooms x-endpoint-cost: medium x-latency-category: responsive /seti/black_box_test_results: get: description: Returns the results of the various black box tests operationId: GetBlackBoxTestResults parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[product]' explode: true in: query name: filter required: false schema: properties: product: description: Filter results for a specific product. type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/BlackBoxTestResultsResponse' summary: Retrieve Black Box Test Results tags: - SETI Observability x-latency-category: responsive /short_codes: get: operationId: ListShortCodes parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id]' explode: true in: query name: filter schema: properties: messaging_profile_id: 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. type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/ListShortCodesResponse' default: $ref: '#/components/responses/messaging_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/messaging_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/messaging_GenericErrorResponse' summary: Update short code tags: - Short Codes x-latency-category: responsive /sim_card_actions: get: description: This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters. operationId: ListSimCardActions parameters: - $ref: '#/components/parameters/FilterSIMCardActionsConsolidated' - $ref: '#/components/parameters/wireless_PageConsolidated' responses: '200': $ref: '#/components/responses/SimCardActionCollectionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: List SIM card actions tags: - SIM Card Actions x-latency-category: responsive /sim_card_actions/{id}: get: description: This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation. operationId: GetSimCardAction parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/SIMCardActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get SIM card action details tags: - SIM Card Actions x-latency-category: responsive /sim_card_data_usage_notifications: get: description: Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters. operationId: ListDataUsageNotifications parameters: - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/wireless_PageSize' - $ref: '#/components/parameters/FilterSIMCardId' responses: '200': $ref: '#/components/responses/SimCardDataUsageNotificationCollectionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: List SIM card data usage notifications tags: - SIM Cards x-latency-category: background post: description: Creates a new SIM card data usage notification. operationId: PostSimCardDataUsageNotification requestBody: content: application/json: schema: properties: sim_card_id: description: The identification UUID of the related SIM card resource. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string threshold: description: Data usage threshold that will trigger the notification. properties: amount: example: '2048.1' type: string unit: enum: - MB - GB example: MB type: string type: object required: - sim_card_id - threshold type: object required: true responses: '201': $ref: '#/components/responses/CreateSimCardDataUsageNotificationResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Create a new SIM card data usage notification tags: - SIM Cards x-latency-category: responsive /sim_card_data_usage_notifications/{id}: delete: description: Delete the SIM Card Data Usage Notification. operationId: DeleteSimCardDataUsageNotifications parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/DeleteSimCardDataUsageNotificationResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Delete SIM card data usage notifications tags: - SIM Cards x-latency-category: responsive get: description: Get a single SIM Card Data Usage Notification. operationId: GetSimCardDataUsageNotification parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GetSimCardDataUsageNotificationResponse' '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get a single SIM card data usage notification tags: - SIM Cards x-latency-category: background patch: description: Updates information for a SIM Card Data Usage Notification. operationId: PatchSimCardDataUsageNotification parameters: - $ref: '#/components/parameters/ResourceId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SimCardDataUsageNotification' required: true responses: '200': $ref: '#/components/responses/UpdateSimCardDataUsageNotificationResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Updates information for a SIM Card Data Usage Notification tags: - SIM Cards 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: GetSimCardGroupActions parameters: - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/wireless_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 - set_wireless_blocklist - remove_wireless_blocklist example: set_private_wireless_gateway type: string responses: '200': $ref: '#/components/responses/SimCardGroupActionCollectionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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: GetSimCardGroupAction parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/SIMCardGroupActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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: GetAllSimCardGroups parameters: - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/wireless_PageSize' - description: A valid SIM card group name. in: query name: filter[name] schema: example: My Test Group format: uuid type: string - description: A Private Wireless Gateway ID associated with the group. in: query name: filter[private_wireless_gateway_id] schema: example: 7606c6d3-ff7c-49c1-943d-68879e9d584d format: uuid type: string - description: A Wireless Blocklist ID associated with the group. in: query name: filter[wireless_blocklist_id] schema: example: 0f3f490e-c4d3-4cf5-838a-9970f10ee259 format: uuid type: string responses: '200': $ref: '#/components/responses/GetAllSimCardGroupsResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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: CreateSimCardGroup requestBody: content: application/json: schema: $ref: '#/components/schemas/SIMCardGroupCreate' required: true responses: '200': $ref: '#/components/responses/CreateSimCardGroupResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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: DeleteSimCardGroup parameters: - $ref: '#/components/parameters/SIMCardGroupId' responses: '200': $ref: '#/components/responses/DeleteSimCardGroupResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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: GetSimCardGroup parameters: - $ref: '#/components/parameters/SIMCardGroupId' - $ref: '#/components/parameters/IncludeICCIDs' responses: '200': $ref: '#/components/responses/GetSimCardGroupResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get SIM card group tags: - SIM Card Groups x-latency-category: responsive patch: description: Updates a SIM card group operationId: UpdateSimCardGroup parameters: - $ref: '#/components/parameters/SIMCardGroupId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SIMCardGroupPatch' required: true responses: '200': $ref: '#/components/responses/UpdateSimCardGroupResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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/SIMCardGroupId' responses: '202': $ref: '#/components/responses/SIMCardGroupActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request Private Wireless Gateway removal from SIM card group tags: - SIM Card Groups x-latency-category: background /sim_card_groups/{id}/actions/remove_wireless_blocklist: post: description: This action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group. operationId: RemoveWirelessBlocklistForSimCardGroup parameters: - $ref: '#/components/parameters/SIMCardGroupId' responses: '202': $ref: '#/components/responses/SIMCardGroupActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request Wireless Blocklist 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: SetPrivateWirelessGatewayForSimCardGroup parameters: - $ref: '#/components/parameters/SIMCardGroupId' 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' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request Private Wireless Gateway assignment for SIM card group tags: - SIM Card Groups x-latency-category: background /sim_card_groups/{id}/actions/set_wireless_blocklist: post: description: This action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group. operationId: SetWirelessBlocklistForSimCardGroup parameters: - $ref: '#/components/parameters/SIMCardGroupId' requestBody: content: application/json: schema: properties: wireless_blocklist_id: description: The identification of the related Wireless Blocklist resource. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string required: - wireless_blocklist_id type: object required: true responses: '202': $ref: '#/components/responses/SIMCardGroupActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request Wireless Blocklist 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: PreviewSimCardOrders requestBody: content: application/json: schema: properties: address_id: description: Uniquely identifies the address for the order. example: '1293384261075731499' 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/wireless_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: GetSimCardOrders parameters: - $ref: '#/components/parameters/FilterSIMCardOrdersConsolidated' - $ref: '#/components/parameters/wireless_PageConsolidated' responses: '200': $ref: '#/components/responses/GetAllSimCardOrdersResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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: CreateSimCardOrder requestBody: content: application/json: schema: $ref: '#/components/schemas/SimCardOrderCreate' required: true responses: '200': $ref: '#/components/responses/CreateSimCardOrderResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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: GetSimCardOrder parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GetSimCardOrderResponse' '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_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: GetSimCards parameters: - $ref: '#/components/parameters/FilterSIMCardConsolidated' - $ref: '#/components/parameters/wireless_PageConsolidated' - $ref: '#/components/parameters/IncludeSIMCardGroup' - $ref: '#/components/parameters/FilterSIMCardGroupId' - description: Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus sign. example: -current_billing_period_consumed_data.amount in: query name: sort required: false schema: enum: - current_billing_period_consumed_data.amount type: string responses: '200': $ref: '#/components/responses/SearchSimCardsResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get all SIM cards tags: - SIM Cards x-latency-category: responsive /sim_cards/actions/bulk_set_public_ips: post: description: 'This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards.<br/> For each SIM Card a SIM Card Action will be generated. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API. ' operationId: SetPublicIPsBulk requestBody: content: application/json: schema: properties: sim_card_ids: example: - 6b14e151-8493-4fa1-8664-1cc4e6d14158 items: $ref: '#/components/schemas/wireless_Id' type: array required: - sim_card_ids type: object responses: '202': $ref: '#/components/responses/BulkSIMCardActionResponse' '422': $ref: '#/components/responses/wireless_UnprocessableEntity' summary: Request bulk setting SIM card public IPs. tags: - SIM Cards x-latency-category: background /sim_cards/actions/validate_registration_codes: post: description: It validates whether SIM card registration codes are valid or not. operationId: ValidateRegistrationCodes 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 '401': description: Unauthorized default: $ref: '#/components/responses/wireless_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. 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: DeleteSimCard parameters: - $ref: '#/components/parameters/SIMCardId' - description: Enables deletion of disabled eSIMs that can't be uninstalled from a device. This is irreversible and the eSIM cannot be re-registered. in: query name: report_lost required: false schema: default: false type: boolean responses: '200': $ref: '#/components/responses/DeleteSimCardResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Deletes a SIM card tags: - SIM Cards x-latency-category: responsive get: description: Returns the details regarding a specific SIM card. operationId: GetSimCard parameters: - $ref: '#/components/parameters/SIMCardId' - $ref: '#/components/parameters/IncludeSIMCardGroup' - description: When set to true, includes the PIN and PUK codes in the response. These codes are used for SIM card security and unlocking purposes. Available for both physical SIM cards and eSIMs. in: query name: include_pin_puk_codes required: false schema: default: false type: boolean responses: '200': $ref: '#/components/responses/GetSimCardResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get SIM card tags: - SIM Cards x-latency-category: responsive patch: description: Updates SIM card data operationId: UpdateSimCard parameters: - $ref: '#/components/parameters/SIMCardId' requestBody: content: application/json: schema: $ref: '#/components/schemas/SIMCard' required: true responses: '200': $ref: '#/components/responses/UpdateSimCardResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Update a SIM card tags: - SIM Cards x-latency-category: responsive /sim_cards/{id}/actions/disable: post: description: 'This API disables a SIM card, disconnecting it from the network and making it impossible to consume data.<br/> The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the disabled state may take a period of time. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API. ' operationId: DisableSimCard parameters: - $ref: '#/components/parameters/SIMCardId' responses: '202': $ref: '#/components/responses/SIMCardActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request a SIM card disable tags: - SIM Cards x-latency-category: background /sim_cards/{id}/actions/enable: post: description: 'This API enables a SIM card, connecting it to the network and making it possible to consume data.<br/> To enable a SIM card, it must be associated with a SIM card group.<br/> The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the enabled state may take a period of time. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API. ' operationId: EnableSimCard parameters: - $ref: '#/components/parameters/SIMCardId' responses: '202': $ref: '#/components/responses/SIMCardActionResponse' '422': $ref: '#/components/responses/wireless_UnprocessableEntity' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request a SIM card enable tags: - SIM Cards x-latency-category: background /sim_cards/{id}/actions/remove_public_ip: post: description: "This API removes an existing public IP from a SIM card. <br/><br/>\n\ \ The API will trigger an asynchronous operation called a SIM Card Action.\ \ The status of the SIM Card Action can be followed through the [List SIM\ \ Card Action](https://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions)\ \ API." operationId: RemoveSimCardPublicIp parameters: - $ref: '#/components/parameters/SIMCardId' responses: '202': $ref: '#/components/responses/SIMCardActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request removing a SIM card public IP tags: - SIM Cards x-latency-category: background /sim_cards/{id}/actions/set_public_ip: post: description: "This API makes a SIM card reachable on the public internet by\ \ mapping a random public IP to the SIM card. <br/><br/>\n The API will trigger\ \ an asynchronous operation called a SIM Card Action. The status of the SIM\ \ Card Action can be followed through the [List SIM Card Action](https://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions)\ \ API. <br/><br/>\n Setting a Public IP to a SIM Card incurs a charge and\ \ will only succeed if the account has sufficient funds." operationId: SetSimCardPublicIp parameters: - $ref: '#/components/parameters/SIMCardId' - description: The code of the region where the public IP should be assigned. A list of available regions can be found at the regions endpoint in: query name: region_code required: false schema: example: dc2 type: string responses: '202': $ref: '#/components/responses/SIMCardActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request setting a SIM card public IP 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/> The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the standby state may take a period of time. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API. ' operationId: SetSimCardStandby parameters: - $ref: '#/components/parameters/SIMCardId' responses: '202': $ref: '#/components/responses/SIMCardActionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Request setting a SIM card to standby tags: - SIM Cards x-latency-category: background /sim_cards/{id}/activation_code: get: description: "It returns the activation code for an eSIM.<br/><br/>\n This API\ \ is only available for eSIMs. If the given SIM is a physical SIM card, or\ \ has already been installed, an error will be returned.\n" operationId: GetSimCardActivationCode parameters: - $ref: '#/components/parameters/SIMCardId' responses: '200': $ref: '#/components/responses/SIMCardActivationCodeResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get activation code for an eSIM tags: - SIM Cards x-latency-category: responsive /sim_cards/{id}/device_details: get: description: 'It returns the device details where a SIM card is currently being used. ' operationId: GetSimCardDeviceDetails parameters: - $ref: '#/components/parameters/SIMCardId' responses: '200': $ref: '#/components/responses/SIMCardDeviceDetailsResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get SIM card device details tags: - SIM Cards x-latency-category: responsive /sim_cards/{id}/public_ip: get: description: 'It returns the public IP requested for a SIM card. ' operationId: GetSimCardPublicIp parameters: - $ref: '#/components/parameters/SIMCardId' responses: '200': $ref: '#/components/responses/SIMCardPublicIPResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get SIM card public IP definition tags: - SIM Cards x-latency-category: responsive /sim_cards/{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: GetWirelessConnectivityLogs parameters: - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/wireless_PageSize' - $ref: '#/components/parameters/SIMCardId' responses: '200': $ref: '#/components/responses/WirelessConnectivityLogCollectionResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: List wireless connectivity logs tags: - SIM Cards x-latency-category: responsive /siprec_connectors: post: description: Creates a new SIPREC connector configuration. operationId: createSiprecConnector requestBody: $ref: '#/components/requestBodies/SiprecConnectorRequest' responses: '201': $ref: '#/components/responses/SiprecConnectorResponseBody' default: $ref: '#/components/responses/siprec_GenericErrorResponse' summary: Create a SIPREC connector tags: - SIPREC Connectors x-latency-category: responsive /siprec_connectors/{connector_name}: delete: description: Deletes a stored SIPREC connector. operationId: deleteSiprecConnector parameters: - $ref: '#/components/parameters/SiprecConnectorName' responses: '204': description: The SIPREC connector was deleted successfully. default: $ref: '#/components/responses/siprec_GenericErrorResponse' summary: Delete a SIPREC connector tags: - SIPREC Connectors x-latency-category: responsive get: description: Returns details of a stored SIPREC connector. operationId: getSiprecConnector parameters: - $ref: '#/components/parameters/SiprecConnectorName' responses: '200': $ref: '#/components/responses/SiprecConnectorResponseBody' default: $ref: '#/components/responses/siprec_GenericErrorResponse' summary: Retrieve a SIPREC connector tags: - SIPREC Connectors x-latency-category: responsive put: description: Updates a stored SIPREC connector configuration. operationId: updateSiprecConnector parameters: - $ref: '#/components/parameters/SiprecConnectorName' requestBody: $ref: '#/components/requestBodies/SiprecConnectorRequest' responses: '200': $ref: '#/components/responses/SiprecConnectorResponseBody' default: $ref: '#/components/responses/siprec_GenericErrorResponse' summary: Update a SIPREC connector tags: - SIPREC Connectors x-latency-category: responsive /storage/buckets/{bucketName}/ssl_certificate: delete: deprecated: false description: Deletes an SSL certificate and its matching secret. operationId: RemoveStorageSSLCertificate parameters: - description: Bucket Name example: '' in: path name: bucketName required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/SSLCertificate' type: object description: SSL Certificate Response headers: {} summary: Remove SSL Certificate tags: - Bucket SSL Certificate x-latency-category: responsive get: deprecated: false description: Returns the stored certificate detail of a bucket, if applicable. operationId: GetStorageSSLCertificates parameters: - description: The name of the bucket example: '' in: path name: bucketName required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/SSLCertificate' type: object description: SSL Certificate Response headers: {} summary: Get Bucket SSL Certificate tags: - Bucket SSL Certificate x-latency-category: responsive put: deprecated: false description: "Uploads an SSL certificate and its matching secret so that you\ \ can use Telnyx\u2019s storage as your CDN." operationId: AddStorageSSLCertificate parameters: - description: The name of the bucket example: '' in: path name: bucketName required: true schema: type: string requestBody: content: multipart/form-data: schema: properties: certificate: description: The SSL certificate file example: '' format: binary type: string private_key: description: The private key file example: '' format: binary type: string type: object responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/SSLCertificate' type: object description: SSL Certificate Response headers: {} summary: Add SSL Certificate tags: - Bucket SSL Certificate x-latency-category: responsive /storage/buckets/{bucketName}/usage/api: get: deprecated: false description: Returns the detail on API usage on a bucket of a particular time period, group by method category. operationId: GetStorageAPIUsage parameters: - description: The name of the bucket example: '' in: path name: bucketName required: true schema: type: string - description: 'Consolidated filter parameter (deepObject style). Originally: filter[start_time], filter[end_time]' example: end_time: '2020-01-01T00:00:00.000Z' start_time: '2020-01-01T00:00:00.000Z' explode: true in: query name: filter required: true schema: additionalProperties: false properties: end_time: description: The end time of the period to filter the usage (ISO microsecond format) format: date-time type: string start_time: description: The start time of the period to filter the usage (ISO microsecond format) format: date-time type: string required: - start_time - end_time type: object style: deepObject responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/BucketAPIUsageResponse' type: array type: object description: Bucket Usage headers: {} summary: Get API Usage tags: - Bucket Usage x-latency-category: responsive /storage/buckets/{bucketName}/usage/storage: get: deprecated: false description: Returns the amount of storage space and number of files a bucket takes up. operationId: GetBucketUsage parameters: - description: The name of the bucket example: '' in: path name: bucketName required: true schema: type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/BucketUsage' type: array meta: $ref: '#/components/schemas/PaginationMetaSimple' type: object description: Bucket Storage Usage headers: {} summary: Get Bucket Usage tags: - Bucket Usage x-latency-category: responsive /storage/buckets/{bucketName}/{objectName}/presigned_url: post: deprecated: false description: "Returns a timed and authenticated URL to get an object. This is\ \ the equivalent to AWS S3\u2019s \u201Cpresigned\u201D URL. Please note that\ \ Telnyx performs authentication differently from AWS S3 and you MUST NOT\ \ use the presign method of AWS s3api CLI or sdk to generate the presigned\ \ URL. \n\nRefer to: https://developers.telnyx.com/docs/cloud-storage/presigned-urls\n" operationId: CreatePresignedObjectUrl parameters: - description: The name of the bucket example: '' in: path name: bucketName required: true schema: type: string - description: The name of the object example: '' in: path name: objectName required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PresignedObjectUrlParams' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PresignedObjectUrl' description: Presigned URL Object Response headers: {} summary: Create Presigned Object URL tags: - Presigned Object URLs x-latency-category: responsive /storage/migration_source_coverage: get: deprecated: false description: '' operationId: ListMigrationSourceCoverage parameters: [] responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/MigrationSourceCoverageParams' type: array meta: $ref: '#/components/schemas/PaginationMetaSimple' type: object description: List Migrations Source Coverage Response headers: {} summary: List Migration Source coverage tags: - Data Migration x-latency-category: responsive /storage/migration_sources: get: deprecated: false description: '' operationId: ListMigrationSources parameters: [] responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/MigrationSourceParams' type: array meta: $ref: '#/components/schemas/PaginationMetaSimple' type: object description: List Migration Sources Response headers: {} summary: List all Migration Sources tags: - Data Migration x-latency-category: responsive post: deprecated: false description: Create a source from which data can be migrated from. operationId: CreateMigrationSource parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrationSourceParams' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/MigrationSourceParams' type: object description: Create Migration Source Response headers: {} summary: Create a Migration Source tags: - Data Migration x-latency-category: responsive /storage/migration_sources/{id}: delete: deprecated: false description: '' operationId: DeleteMigrationSource parameters: - description: Unique identifier for the data migration source. example: '' in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/MigrationSourceParams' type: object description: Create Migration Source Response headers: {} summary: Delete a Migration Source tags: - Data Migration x-latency-category: responsive get: deprecated: false description: '' operationId: GetMigrationSource parameters: - description: Unique identifier for the data migration source. example: '' in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/MigrationSourceParams' type: object description: Create Migration Source Response headers: {} summary: Get a Migration Source tags: - Data Migration x-latency-category: responsive /storage/migrations: get: deprecated: false description: '' operationId: ListMigrations parameters: [] responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/MigrationParams' type: array meta: $ref: '#/components/schemas/PaginationMetaSimple' type: object description: List Migrations Response headers: {} summary: List all Migrations tags: - Data Migration x-latency-category: responsive post: deprecated: false description: Initiate a migration of data from an external provider into Telnyx Cloud Storage. Currently, only S3 is supported. operationId: CreateMigration parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrationParams' responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/MigrationParams' type: object description: Create Migration Response headers: {} summary: Create a Migration tags: - Data Migration x-latency-category: responsive /storage/migrations/{id}: get: deprecated: false description: '' operationId: GetMigration parameters: - description: Unique identifier for the data migration. example: '' in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/MigrationParams' type: object description: Create Migration Response headers: {} summary: Get a Migration tags: - Data Migration x-latency-category: responsive /storage/migrations/{id}/actions/stop: post: deprecated: false description: '' operationId: StopMigration parameters: - description: Unique identifier for the data migration. example: '' in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/MigrationParams' type: object description: Create Migration Response headers: {} summary: Stop a Migration tags: - Data Migration x-latency-category: responsive /sub_number_orders: get: description: Get a paginated list of sub number orders. operationId: ListSubNumberOrders parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[status], filter[order_request_id], filter[country_code], filter[phone_number_type], filter[phone_numbers_count]' explode: true in: query name: filter schema: properties: country_code: description: ISO alpha-2 country code. example: US type: string order_request_id: description: ID of the number order the sub number order belongs to example: 12ade33a-21c0-473b-b055-b3c836e1c293 format: uuid type: string phone_number_type: description: Phone Number Type example: local type: string phone_numbers_count: description: Amount of numbers in the sub number order example: 1 type: integer status: description: Filter sub number orders by status. type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListSubNumberOrdersResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: List sub number orders tags: - Phone Number Orders x-group-parameters: 'true' x-latency-category: responsive /sub_number_orders/{id}/requirement_group: post: operationId: updateSubNumberOrderRequirementGroup parameters: - description: The ID of the sub number order in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: example: requirement_group_id: a4b201f9-8646-4e54-a7d2-b2e403eeaf8c schema: properties: requirement_group_id: description: The ID of the requirement group to associate format: uuid type: string required: - requirement_group_id type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubNumberOrderRequirementGroupResponse' description: Sub number order requirement group updated successfully default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Update requirement group for a sub number order tags: - Requirement Groups x-latency-category: responsive /sub_number_orders/{sub_number_order_id}: get: description: Get an existing sub number order. operationId: GetSubNumberOrder parameters: - description: The sub number order ID. in: path name: sub_number_order_id required: true schema: type: string - description: 'Consolidated filter parameter (deepObject style). Originally: filter[include_phone_numbers]' explode: true in: query name: filter schema: properties: include_phone_numbers: default: false description: Include the first 50 phone number objects in the results type: boolean type: object style: deepObject responses: '200': $ref: '#/components/responses/SubNumberOrderResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve a sub number order tags: - Phone 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/numbers_GenericErrorResponse' summary: Update a sub number order's requirements tags: - Phone Number Orders x-latency-category: responsive /sub_number_orders/{sub_number_order_id}/cancel: patch: description: Allows you to cancel a sub number order in 'pending' status. operationId: CancelSubNumberOrder parameters: - description: The ID of the sub number order. in: path name: sub_number_order_id required: true schema: type: string responses: '200': $ref: '#/components/responses/SubNumberOrderResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Cancel a sub number order tags: - Phone Number Orders x-latency-category: responsive /sub_number_orders_report: post: description: Create a CSV report for sub number orders. The report will be generated asynchronously and can be downloaded once complete. operationId: CreateSubNumberOrdersReport requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSubNumberOrdersReportRequest' required: false responses: '202': $ref: '#/components/responses/SubNumberOrdersReportResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Create a sub number orders report tags: - Phone Number Orders x-endpoint-cost: medium x-latency-category: background /sub_number_orders_report/{report_id}: get: description: Get the status and details of a sub number orders report. operationId: GetSubNumberOrdersReport parameters: - description: The unique identifier of the sub number orders report example: 12ade33a-21c0-473b-b055-b3c836e1c293 in: path name: report_id required: true schema: format: uuid type: string responses: '200': $ref: '#/components/responses/SubNumberOrdersReportResponse' default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Retrieve a sub number orders report tags: - Phone Number Orders x-endpoint-cost: light x-latency-category: responsive /sub_number_orders_report/{report_id}/download: get: description: Download the CSV file for a completed sub number orders report. The report status must be 'success' before the file can be downloaded. operationId: DownloadSubNumberOrdersReport parameters: - description: The unique identifier of the sub number orders report example: 12ade33a-21c0-473b-b055-b3c836e1c293 in: path name: report_id required: true schema: format: uuid type: string responses: '200': content: text/csv: example: 'id,order_request_id,is_block_sub_number_order,status,phone_number_type,requirements_met,phone_numbers_count,country_code,user_id,customer_reference,created_at,updated_at 1758d6ed-61a0-4d7a-bf57-b5dced413d33,f486fc2c-4fdf-4849-930d-b3045373e839,False,success,local,True,1,US,0d7ef697-df19-413a-b724-56b0539f5397,STRING,2025-05-23 14:33:12.376686,2025-05-23 14:33:15.624916' schema: format: binary type: string description: CSV file download default: $ref: '#/components/responses/numbers_GenericErrorResponse' summary: Download a sub number orders report tags: - Phone Number Orders x-endpoint-cost: light x-latency-category: background /telephony_credentials: get: description: List all On-demand Credentials. operationId: FindTelephonyCredentials parameters: - $ref: '#/components/parameters/telephony-credentials_PageConsolidated' - $ref: '#/components/parameters/telephony-credentials_FilterConsolidated' 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/{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}/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/Accounts/{account_sid}/Calls: get: description: Returns multiple call resouces for an account. This endpoint is eventually consistent. operationId: GetTexmlCalls parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageToken' - $ref: '#/components/parameters/To' - $ref: '#/components/parameters/From' - $ref: '#/components/parameters/Status' - $ref: '#/components/parameters/StartTime' - $ref: '#/components/parameters/StartTime_gt' - $ref: '#/components/parameters/StartTime_lt' - $ref: '#/components/parameters/EndTime' - $ref: '#/components/parameters/EndTime_gt' - $ref: '#/components/parameters/EndTime_lt' responses: '200': $ref: '#/components/responses/GetCallsResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Fetch multiple call resources tags: - TeXML REST Commands x-latency-category: responsive post: description: Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal. operationId: InitiateTexmlCall parameters: - $ref: '#/components/parameters/AccountSid' requestBody: content: application/json: schema: $ref: '#/components/schemas/InitiateCallRequest' description: Iniatiate Call request object required: true responses: '200': $ref: '#/components/responses/InitiateCallResponse' summary: Initiate an outbound call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Calls/{call_sid}: get: description: Returns an individual call identified by its CallSid. This endpoint is eventually consistent. operationId: GetTexmlCall parameters: - $ref: '#/components/parameters/CallSid' - $ref: '#/components/parameters/AccountSid' responses: '200': $ref: '#/components/responses/GetCallResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Fetch a call tags: - TeXML REST Commands x-latency-category: responsive post: description: Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example. operationId: UpdateTexmlCall parameters: - $ref: '#/components/parameters/CallSid' - $ref: '#/components/parameters/AccountSid' requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateCallRequest' description: Update Call request object required: true responses: '200': $ref: '#/components/responses/GetCallResponse' summary: Update call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json: get: description: Returns recordings for a call identified by call_sid. operationId: FetchTeXMLCallRecordings parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/CallSid' responses: '200': $ref: '#/components/responses/TexmlGetCallRecordingsResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Fetch recordings for a call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive post: description: Starts recording with specified parameters for call idientified by call_sid. operationId: StartTeXMLCallRecording parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/CallSid' requestBody: $ref: '#/components/requestBodies/TexmlCreateCallRecordingRequest' responses: '200': $ref: '#/components/responses/TexmlCreateCallRecordingResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Request recording for a call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json: post: description: Updates recording resource for particular call. operationId: UpdateTeXMLCallRecording parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/CallSid' - $ref: '#/components/parameters/RecordingSid' requestBody: $ref: '#/components/requestBodies/TexmlUpdateCallRecordingRequest' responses: '200': $ref: '#/components/responses/TexmlCreateCallRecordingResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Update recording on a call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json: post: description: Starts siprec session with specified parameters for call idientified by call_sid. operationId: StartTeXMLSiprecSession parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/CallSid' requestBody: $ref: '#/components/requestBodies/TexmlCreateSiprecSessionRequest' responses: '200': $ref: '#/components/responses/TexmlCreateSiprecSessionResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Request siprec session for a call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec/{siprec_sid}.json: post: description: Updates siprec session identified by siprec_sid. operationId: UpdateTeXMLSiprecSession parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/CallSid' - $ref: '#/components/parameters/SiprecSid' requestBody: $ref: '#/components/requestBodies/TexmlUpdateSiprecSessionRequest' responses: '200': $ref: '#/components/responses/TexmlUpdateSiprecSessionResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Updates siprec session for a call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams.json: post: description: Starts streaming media from a call to a specific WebSocket address. operationId: StartTeXMLCallStreaming parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/CallSid' requestBody: $ref: '#/components/requestBodies/TexmlCreateCallStreamingRequest' responses: '200': $ref: '#/components/responses/TexmlCreateCallStreamingResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Start streaming media from a call. tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams/{streaming_sid}.json: post: description: Updates streaming resource for particular call. operationId: UpdateTeXMLCallStreaming parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/CallSid' - $ref: '#/components/parameters/StreamingSid' requestBody: $ref: '#/components/requestBodies/TexmlUpdateCallStreamingRequest' responses: '200': $ref: '#/components/responses/TexmlUpdateCallStreamingResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Update streaming on a call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Conferences: get: description: Lists conference resources. operationId: GetTexmlConferences parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSize' - $ref: '#/components/parameters/PageToken' - $ref: '#/components/parameters/FriendlyName' - $ref: '#/components/parameters/ConferenceStatus' - $ref: '#/components/parameters/DateCreated' - $ref: '#/components/parameters/DateUpdated' responses: '200': $ref: '#/components/responses/GetConferencesResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: List conference resources tags: - TeXML REST Commands x-latency-category: responsive /texml/Accounts/{account_sid}/Conferences/{conference_sid}: get: description: Returns a conference resource. operationId: GetTexmlConference parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' responses: '200': $ref: '#/components/responses/GetConferenceResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Fetch a conference resource tags: - TeXML REST Commands x-latency-category: responsive post: description: Updates a conference resource. operationId: UpdateTexmlConference parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/call-scripting_UpdateConferenceRequest' description: Update Conference request object required: true responses: '200': $ref: '#/components/responses/GetConferenceResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Update a conference resource tags: - TeXML REST Commands x-latency-category: responsive /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants: get: description: Lists conference participants operationId: GetTexmlConferenceParticipants parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' responses: '200': $ref: '#/components/responses/GetParticipantsResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: List conference participants tags: - TeXML REST Commands x-latency-category: responsive post: description: Dials a new conference participant operationId: DialTexmlConferenceParticipant parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/DialConferenceParticipantRequest' description: Dial Conference Participant request object required: true responses: '200': $ref: '#/components/responses/DialParticipantResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Dial a new conference participant tags: - TeXML REST Commands x-latency-category: responsive /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}: delete: description: Deletes a conference participant operationId: DeleteTexmlConferenceParticipant parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' - $ref: '#/components/parameters/CallSidOrParticipantLabel' responses: '204': description: The resource was deleted successfully. '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Delete a conference participant tags: - TeXML REST Commands x-latency-category: responsive get: description: Gets conference participant resource operationId: GetTexmlConferenceParticipant parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' - $ref: '#/components/parameters/CallSidOrParticipantLabel' responses: '200': $ref: '#/components/responses/GetParticipantResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Get conference participant resource tags: - TeXML REST Commands x-latency-category: responsive post: description: Updates a conference participant operationId: UpdateTexmlConferenceParticipant parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' - $ref: '#/components/parameters/CallSidOrParticipantLabel' requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UpdateConferenceParticipantRequest' description: Update Conference Participant request object required: true responses: '200': $ref: '#/components/responses/GetParticipantResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Update a conference participant tags: - TeXML REST Commands x-latency-category: responsive /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings: get: description: Lists conference recordings operationId: GetTexmlConferenceRecordings parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' responses: '200': $ref: '#/components/responses/GetConferenceRecordingsResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: List conference recordings tags: - TeXML REST Commands x-latency-category: responsive /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json: get: description: Returns recordings for a conference identified by conference_sid. operationId: FetchTeXMLConferenceRecordings parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/ConferenceSid' responses: '200': $ref: '#/components/responses/TexmlGetCallRecordingsResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Fetch recordings for a conference tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Recordings.json: get: description: Returns multiple recording resources for an account. operationId: GetTeXMLCallRecordings parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PageSizeTexml' - $ref: '#/components/parameters/TexmlDateCreated' responses: '200': $ref: '#/components/responses/TexmlGetCallRecordingsResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Fetch multiple recording resources tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json: delete: description: Deletes recording resource identified by recording id. operationId: DeleteTeXMLCallRecording parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/RecordingSid' responses: '204': description: The resource was deleted successfully. '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Delete recording resource tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive get: description: Returns recording resource identified by recording id. operationId: GetTeXMLCallRecording parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/RecordingSid' responses: '200': $ref: '#/components/responses/TexmlGetCallRecordingResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Fetch recording resource tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Transcriptions.json: get: description: Returns multiple recording transcription resources for an account. operationId: GetTeXMLRecordingTranscriptions parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/PageToken' - $ref: '#/components/parameters/PageSize' responses: '200': $ref: '#/components/responses/TexmlListRecordingTranscriptionResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: List recording transcriptions tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json: delete: description: Permanently deletes a recording transcription. operationId: DeleteTeXMLRecordingTranscription parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/RecordingTranscriptionSid' responses: '204': description: The resource was deleted successfully. '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Delete a recording transcription tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive get: description: Returns the recording transcription resource identified by its ID. operationId: GetTeXMLRecordingTranscription parameters: - $ref: '#/components/parameters/AccountSid' - $ref: '#/components/parameters/RecordingTranscriptionSid' responses: '200': $ref: '#/components/responses/TexmlGetRecordingTranscriptionResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' summary: Fetch a recording transcription resource tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/calls/{application_id}: post: description: Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal. operationId: DeprecatedInitiateTexmlCall parameters: - $ref: '#/components/parameters/ApplicationId' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeprecatedInitiateCallRequest' description: Iniatiate Call request object required: true responses: '200': $ref: '#/components/responses/DeprecatedInitiateCallResponse' summary: (Deprecated) Initiate an outbound call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/calls/{call_sid}/update: post: description: Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example. operationId: DeprecatedUpdateTexmlCall parameters: - $ref: '#/components/parameters/CallSid' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCallRequest' description: Update Call request object required: true responses: '200': $ref: '#/components/responses/UpdateTeXMLCallResponse' summary: (Deprecated) Update call tags: - TeXML REST Commands x-group-parameters: 'true' x-latency-category: responsive /texml/secrets: post: description: Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to use your secret name, and this name will be replaced by the actual secret value when processing the TeXML on Telnyx side. The secrets are not visible in any logs. operationId: CreateTexmlSecret requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTeXMLSecretRequest' description: Create TeXML secret request object required: true responses: '201': $ref: '#/components/responses/CreateTeXMLSecretResponse' '422': $ref: '#/components/responses/UnprocessableEntityResponse' summary: Create a TeXML secret tags: - TeXML REST Commands x-latency-category: responsive /texml_applications: get: description: Returns a list of your TeXML Applications. operationId: FindTexmlApplications parameters: - $ref: '#/components/parameters/call-scripting_PageConsolidated' - $ref: '#/components/parameters/call-scripting_FilterConsolidated' - $ref: '#/components/parameters/SortApplication' responses: '200': $ref: '#/components/responses/GetAllTexmlApplicationsResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/call-scripting_UnauthorizedResponse' summary: List all TeXML Applications tags: - TeXML Applications x-endpoint-cost: medium x-latency-category: interactive 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' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/call-scripting_UnauthorizedResponse' '404': $ref: '#/components/responses/call-scripting_NotFoundResponse' '422': $ref: '#/components/responses/UnprocessableEntityResponse' summary: Creates a TeXML Application tags: - TeXML Applications x-endpoint-cost: medium x-latency-category: interactive /texml_applications/{id}: delete: description: Deletes a TeXML Application. operationId: DeleteTexmlApplication parameters: - $ref: '#/components/parameters/id' responses: '200': $ref: '#/components/responses/TexmlApplicationResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/call-scripting_UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponseApp' summary: Deletes a TeXML Application tags: - TeXML Applications x-latency-category: interactive get: description: Retrieves the details of an existing TeXML Application. operationId: GetTexmlApplication parameters: - $ref: '#/components/parameters/id' responses: '200': $ref: '#/components/responses/TexmlApplicationResponse' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/call-scripting_UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponseApp' summary: Retrieve a TeXML Application tags: - TeXML Applications x-latency-category: interactive 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' '400': $ref: '#/components/responses/BadRequestResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' '403': $ref: '#/components/responses/call-scripting_UnauthorizedResponse' '404': $ref: '#/components/responses/NotFoundResponseApp' '422': $ref: '#/components/responses/UnprocessableEntityResponse' summary: Update a TeXML Application tags: - TeXML Applications x-latency-category: interactive /text-to-speech/speech: post: description: Converts the provided text to speech using the specified voice and returns audio data operationId: generateTextToSpeech requestBody: content: application/json: schema: properties: text: description: The text to convert to speech type: string voice: description: 'The voice ID in the format Provider.ModelId.VoiceId. Examples: - AWS.Polly.Joanna-Neural - Azure.en-US-AvaMultilingualNeural - ElevenLabs.eleven_multilingual_v2.Rachel - Telnyx.KokoroTTS.af Use the `GET /text-to-speech/voices` endpoint to get a complete list of available voices.' type: string required: - voice - text type: object required: true responses: '200': content: audio/mpeg: schema: description: Raw audio data in MP3 format format: binary type: object description: Audio data generated from the provided text '401': $ref: '#/components/responses/UnauthorizedResponse' '422': description: Invalid request parameters summary: Generate speech from text tags: - Text to Speech Commands x-latency-category: interactive /text-to-speech/voices: get: description: Returns a list of voices that can be used with the text to speech commands. operationId: listTextToSpeechVoices parameters: - description: Filter voices by provider in: query name: provider required: false schema: enum: - aws - azure - elevenlabs - telnyx type: string - description: Reference to your ElevenLabs API key stored in the Telnyx Portal in: query name: elevenlabs_api_key_ref required: false schema: type: string responses: '200': content: application/json: schema: properties: voices: items: properties: accent: type: string age: type: string gender: type: string id: type: string label: type: string language: type: string name: type: string provider: type: string type: object type: array type: object description: Successful response with list of available voices '401': $ref: '#/components/responses/UnauthorizedResponse' summary: List available text to speech voices tags: - Text to Speech Commands x-latency-category: interactive /usage_reports: get: description: Get Telnyx usage data by product, broken out by the specified dimensions operationId: GetUsageReports parameters: - description: Telnyx product examples: product=messaging: summary: messaging value: messaging product=wireless: summary: wireless value: wireless in: query name: product required: true schema: type: string - description: Breakout by specified product dimensions examples: dimensions=direction&dimensions=currency&dimensions=message_type: summary: Dimensions aggregation list value: dimensions=direction&dimensions=currency&dimensions=message_type in: query name: dimensions required: true schema: items: type: string type: array - description: Specified product usage values examples: metrics=cost&metrics=billed_sec: summary: Metrics aggregation list value: metrics=cost&metrics=billed_sec in: query name: metrics required: true schema: items: type: string type: array - description: 'The start date for the time range you are interested in. The maximum time range is 31 days. Format: YYYY-MM-DDTHH:mm:ssZ' examples: start_date=2024-02-01T00:00:00Z: summary: Aggregate for records with timestamp starting at specified date and time. value: '2024-02-01T00:00:00Z' in: query name: start_date required: false schema: type: string - description: 'The end date for the time range you are interested in. The maximum time range is 31 days. Format: YYYY-MM-DDTHH:mm:ssZ' examples: end_date=2024-03-01T00:00:00Z: summary: Aggregate for records with timestamp ending at specified date and time. value: '2024-03-01T00:00:00Z' in: query name: end_date required: false schema: type: string - description: A more user-friendly way to specify the timespan you want to filter by. More options can be found in the Telnyx API Reference docs. examples: date_range=last_3_days: summary: last_3_days - Searches for records with timestamp starting at `00:00:00` since 3 days ago value: last_3_days date_range=today: summary: today - Searches for records with timestamp starting at `00:00:00` of the current day value: today in: query name: date_range required: false schema: type: string - description: Filter records on dimensions examples: filter[country_code]=NLD: summary: Filter country code on NLD value: filter[country_code]=NLD filter[currency]=USD: summary: Filter currency on USD value: filter[currency]=USD filter[direction]=inbound: summary: Filter direction on Inbound value: filter[direction]=inbound in: query name: filter required: false schema: type: string - description: Return the aggregations for all Managed Accounts under the user making the request. examples: managed_accounts=true: summary: Fetch aggregations for all Managed Accounts value: false in: query name: managed_accounts required: false schema: type: boolean - description: Specifies the sort order for results examples: defaultOrder: summary: Default Order (No Sort) value: '' 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 required: false schema: items: type: string type: array - description: Specify the response format (csv or json). JSON is returned by default, even if not specified. examples: format=csv: summary: Get the response in CSV format value: csv format=json: summary: Get the response in JSON format value: json in: query name: format required: false schema: enum: - csv - json type: string - in: header name: authorization_bearer schema: description: Authenticates the request with your Telnyx API V2 KEY type: string - description: 'Consolidated page parameter (deepObject style). Originally: page[number], page[size]' examples: page[number]=1&page[size]=20: summary: Returns the first page with 20 records per page (default pagination) value: number: 1 size: 20 page[number]=1&page[size]=50: summary: Returns the first page with 50 records per page (larger page size) value: number: 1 size: 50 page[number]=2&page[size]=20: summary: Returns the second page with 20 records per page value: number: 2 size: 20 page[number]=5&page[size]=100: summary: Returns the fifth page with 100 records per page value: number: 5 size: 100 explode: true in: query name: page schema: properties: number: default: 1 exclusiveMinimum: true minimum: 1 title: Page[Number] type: integer size: default: 20 maximum: 5000 title: Page[Size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsageReportsResponse' text/csv: schema: description: CSV formatted data example: 'user_id,direction,product,cost,billed_sec 3ca7bd3d-7d82-4e07-9df4-009123068320,inbound,forking,0.000800,17.000000 ...' type: string description: Successful '400': content: application/json: schema: $ref: '#/components/schemas/usage-reports_ErrorResponse' description: Bad Request '500': content: application/json: schema: $ref: '#/components/schemas/usage-reports_ErrorResponse' description: Internal Server Error security: - bearerAuth: [] summary: Get Telnyx product usage data (BETA) tags: - Usage Reports (BETA) x-latency-category: interactive /usage_reports/options: get: description: Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions operationId: ListUsageReportsOptions parameters: - description: Options (dimensions and metrics) for a given product. If none specified, all products will be returned. examples: product=wireless: summary: Specify a product if you know what you're looking for value: wireless in: query name: product required: false schema: type: string - in: header name: authorization_bearer schema: description: Authenticates the request with your Telnyx API V2 KEY type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsageReportsOptionsResponse' description: Successful '400': content: application/json: schema: $ref: '#/components/schemas/usage-reports_ErrorResponse' description: Bad Request '500': content: application/json: schema: $ref: '#/components/schemas/usage-reports_ErrorResponse' description: Internal Server Error security: - bearerAuth: [] summary: Get Usage Reports query options (BETA) tags: - Usage Reports (BETA) x-latency-category: interactive /user_addresses: get: description: Returns a list of your user addresses. operationId: FindUserAddress parameters: - $ref: '#/components/parameters/user-addresses_PageConsolidated' - $ref: '#/components/parameters/user-addresses_FilterConsolidated' - $ref: '#/components/parameters/SortUserAddress' responses: '200': $ref: '#/components/responses/GetAllUserAddressResponse' '400': description: Bad request '401': description: Unauthorized '404': description: Resource not found summary: List all user addresses tags: - UserAddresses x-endpoint-cost: medium x-latency-category: responsive post: description: Creates a user address. operationId: CreateUserAddress parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAddressCreate' description: Parameters that can be defined during user address creation required: true responses: '200': $ref: '#/components/responses/UserAddressResponse' '422': description: Bad request summary: Creates a user address tags: - UserAddresses x-endpoint-cost: medium x-latency-category: responsive /user_addresses/{id}: get: description: Retrieves the details of an existing user address. operationId: GetUserAddress parameters: - description: user address ID in: path name: id required: true schema: type: string responses: '200': $ref: '#/components/responses/UserAddressResponse' '401': description: Unauthorized '404': description: Resource not found '422': description: Bad request summary: Retrieve a user address tags: - UserAddresses x-latency-category: responsive /user_tags: get: description: List all user tags. operationId: GetUserTags parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[starts_with]' explode: true in: query name: filter schema: properties: starts_with: description: Filter tags by prefix example: my-tag type: string type: object style: deepObject responses: '200': $ref: '#/components/responses/ListUserTagsResponse' '401': $ref: '#/components/responses/UnauthenticatedResponse' summary: List User Tags tags: - User Tags 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/verify_GenericErrorResponse' summary: List verifications by phone number tags: - Verify x-latency-category: responsive /verifications/by_phone_number/{phone_number}/actions/verify: post: operationId: VerifyVerificationCodeByPhoneNumber 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/VerifyVerificationCodeRequestByPhoneNumber' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerifyVerificationCodeResponse' description: Expected verify response to a valid request. '400': $ref: '#/components/responses/verify_GenericErrorResponse' summary: Verify verification code by phone number 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/verify_GenericErrorResponse' summary: Trigger Call verification tags: - Verify x-latency-category: responsive /verifications/flashcall: post: operationId: CreateFlashcallVerification 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/verify_GenericErrorResponse' summary: Trigger Flash call 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/verify_GenericErrorResponse' summary: Trigger SMS 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/verify_GenericErrorResponse' summary: Retrieve verification tags: - Verify x-latency-category: responsive /verifications/{verification_id}/actions/verify: post: operationId: VerifyVerificationCodeById 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/VerifyVerificationCodeRequestById' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerifyVerificationCodeResponse' description: Expected verify response to a valid request. '400': $ref: '#/components/responses/verify_GenericErrorResponse' summary: Verify verification code by ID tags: - Verify x-latency-category: responsive /verified_numbers: get: description: Gets a paginated list of Verified Numbers. operationId: ListVerifiedNumbers parameters: - description: 'Consolidated page parameter (deepObject style). Use page[size] and page[number] in the query string. Originally: page[size], page[number]' explode: true in: query name: page required: false schema: properties: number: default: 1 title: page[number] type: integer size: default: 25 title: page[size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListVerifiedNumbersResponse' description: Expected response to a valid request. '400': $ref: '#/components/responses/verified-numbers_GenericErrorResponse' '401': $ref: '#/components/responses/UnauthorizedRequestErrorResponse' '422': $ref: '#/components/responses/verified-numbers_UnprocessableEntityErrorResponse' summary: List all Verified Numbers tags: - Verified Numbers x-group-parameters: 'true' x-latency-category: responsive post: description: Initiates phone number verification procedure. operationId: CreateVerifiedNumber requestBody: content: application/json: schema: properties: phone_number: example: '+15551234567' type: string verification_method: description: Verification method. enum: - sms - call example: sms type: string required: - phone_number - verification_method title: Create Verified Number Request type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateVerifiedNumberResponse' description: Expected response to a valid request. '400': $ref: '#/components/responses/verified-numbers_GenericErrorResponse' '401': $ref: '#/components/responses/UnauthorizedRequestErrorResponse' '422': $ref: '#/components/responses/verified-numbers_UnprocessableEntityErrorResponse' summary: Request phone number verification tags: - Verified Numbers x-latency-category: responsive /verified_numbers/{phone_number}: delete: operationId: DeleteVerifiedNumber parameters: - description: The phone number being deleted. in: path name: phone_number required: true schema: description: +E164 formatted phone number. example: '+15551234567' type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerifiedNumberResponseDataWrapper' description: Expected verifications response to a valid request. '400': $ref: '#/components/responses/verified-numbers_GenericErrorResponse' '401': $ref: '#/components/responses/UnauthorizedRequestErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' summary: Delete a verified number tags: - Verified Numbers x-latency-category: responsive get: operationId: GetVerifiedNumber parameters: - description: The phone number being requested. in: path name: phone_number required: true schema: description: +E164 formatted phone number. example: '+15551234567' type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerifiedNumberResponseDataWrapper' description: Expected verifications response to a valid request. '400': $ref: '#/components/responses/verified-numbers_GenericErrorResponse' '401': $ref: '#/components/responses/UnauthorizedRequestErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' summary: Retrieve a verified number tags: - Verified Numbers x-latency-category: responsive /verified_numbers/{phone_number}/actions/verify: post: operationId: VerifyVerificationCode parameters: - description: The phone number being verified. in: path name: phone_number required: true schema: description: +E164 formatted phone number. example: '+15551234567' type: string requestBody: content: application/json: schema: properties: verification_code: example: '123456' type: string required: - verification_code title: Verify Verification Code Request type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/VerifiedNumberResponseDataWrapper' description: Expected response to a valid request. '400': $ref: '#/components/responses/verified-numbers_GenericErrorResponse' '401': $ref: '#/components/responses/UnauthorizedRequestErrorResponse' '404': $ref: '#/components/responses/NotFoundErrorResponse' '422': $ref: '#/components/responses/verified-numbers_UnprocessableEntityErrorResponse' summary: Submit verification code tags: - Verified Numbers x-latency-category: responsive /verify_profiles: get: description: Gets a paginated list of Verify profiles. operationId: ListProfiles parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[name]' explode: true in: query name: filter required: false schema: properties: name: description: Optional filter for profile names. title: filter[name] type: string type: object style: deepObject - description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page required: false schema: properties: number: default: 1 title: page[number] type: integer size: default: 25 title: page[size] type: integer type: object style: deepObject responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListVerifyProfilesResponse' description: Expected Verify profile response to a valid request. '400': $ref: '#/components/responses/verify_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' additionalProperties: true type: object flashcall: $ref: '#/components/schemas/CreateVerifyProfileFlashcallRequest' additionalProperties: true type: object language: example: en-US type: string name: example: Test Profile type: string sms: $ref: '#/components/schemas/CreateVerifyProfileSMSRequest' additionalProperties: true type: object webhook_failover_url: example: http://example.com/webhook/failover type: string webhook_url: example: http://example.com/webhook type: string 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/verify_GenericErrorResponse' summary: Create a Verify profile tags: - Verify x-latency-category: responsive /verify_profiles/templates: get: description: List all Verify profile message templates. operationId: ListProfileMessageTemplates responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListVerifyProfileMessageTemplateResponse' description: Expected Verify profile message template response to a valid request. summary: Retrieve Verify profile message templates tags: - Verify x-latency-category: responsive post: description: Create a new Verify profile message template. operationId: CreateMessageTemplate requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMessageTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageTemplateResponseDataWrapper' description: Expected message template response to a valid request. '400': $ref: '#/components/responses/verify_GenericErrorResponse' summary: Create message template tags: - Verify x-latency-category: responsive /verify_profiles/templates/{template_id}: patch: description: Update an existing Verify profile message template. operationId: UpdateMessageTemplate parameters: - description: The identifier of the message template to update. in: path name: template_id required: true schema: example: 12ade33a-21c0-473b-b055-b3c836e1c292 format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMessageTemplateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MessageTemplateResponseDataWrapper' description: Expected message template response to a valid request. '400': $ref: '#/components/responses/verify_GenericErrorResponse' summary: Update message template tags: - Verify x-latency-category: responsive /verify_profiles/{verify_profile_id}: delete: operationId: DeleteProfile 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/verify_GenericErrorResponse' summary: Delete Verify profile tags: - Verify x-latency-category: responsive get: description: Gets a single Verify profile. operationId: GetVerifyProfile 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/verify_GenericErrorResponse' summary: Retrieve 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' additionalProperties: true type: object flashcall: $ref: '#/components/schemas/UpdateVerifyProfileFlashcallRequest' additionalProperties: true type: object language: example: en-US type: string name: example: Test Profile type: string sms: $ref: '#/components/schemas/UpdateVerifyProfileSMSRequest' additionalProperties: true type: object webhook_failover_url: example: http://example.com/webhook/failover type: string webhook_url: example: http://example.com/webhook type: string 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/verify_GenericErrorResponse' summary: Update Verify profile tags: - Verify x-latency-category: responsive /virtual_cross_connects: get: description: List all Virtual Cross Connects. operationId: ListVirtualCrossConnects parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[network_id]' explode: true in: query name: filter schema: properties: network_id: description: The associated network id to filter on. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/VirtualCrossConnectListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all Virtual Cross Connects tags: - Virtual Cross Connects x-latency-category: responsive post: description: Create a new Virtual Cross Connect.<br /><br />For AWS and GCE, you have the option of creating the primary connection first and the secondary connection later. You also have the option of disabling the primary and/or secondary connections at any time and later re-enabling them. With Azure, you do not have this option. Azure requires both the primary and secondary connections to be created at the same time and they can not be independantly disabled. operationId: CreateVirtualCrossConnect requestBody: content: application/json: schema: $ref: '#/components/schemas/VirtualCrossConnectCreate' required: true responses: '200': $ref: '#/components/responses/VirtualCrossConnectResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create a Virtual Cross Connect tags: - Virtual Cross Connects x-latency-category: responsive /virtual_cross_connects/{id}: delete: description: Delete a Virtual Cross Connect. operationId: DeleteVirtualCrossConnect parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/VirtualCrossConnectResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete a Virtual Cross Connect tags: - Virtual Cross Connects x-latency-category: responsive get: description: Retrieve a Virtual Cross Connect. operationId: GetVirtualCrossConnect parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/VirtualCrossConnectResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve a Virtual Cross Connect tags: - Virtual Cross Connects x-latency-category: responsive patch: description: Update the Virtual Cross Connect.<br /><br />Cloud IPs can only be patched during the `created` state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted. Once the Virtual Cross Connect has moved to `provisioning`, the IPs can no longer be patched.<br /><br />Once the Virtual Cross Connect has moved to `provisioned` and you are ready to enable routing, you can toggle the routing announcements to `true`. operationId: UpdateVirtualCrossConnect parameters: - $ref: '#/components/parameters/ResourceId' requestBody: content: application/json: schema: $ref: '#/components/schemas/VirtualCrossConnectPatch' required: true responses: '200': $ref: '#/components/responses/VirtualCrossConnectResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Update the Virtual Cross Connect tags: - Virtual Cross Connects x-latency-category: responsive /virtual_cross_connects_coverage: get: description: List Virtual Cross Connects Cloud Coverage.<br /><br />This endpoint shows which cloud regions are available for the `location_code` your Virtual Cross Connect will be provisioned in. operationId: ListVirtualCrossConnectCoverage parameters: - description: 'Consolidated filters parameter (deepObject style). Originally: filters[available_bandwidth][contains]' explode: true in: query name: filters schema: additionalProperties: false properties: available_bandwidth: oneOf: - description: Filter by exact available bandwidth match type: integer - additionalProperties: false description: Available bandwidth filtering operations properties: contains: description: Filter by available bandwidth containing the specified value type: integer type: object type: object style: deepObject - description: 'Consolidated filter parameter (deepObject style). Originally: filter[cloud_provider], filter[cloud_provider_region], filter[location.region], filter[location.site], filter[location.pop], filter[location.code]' explode: true in: query name: filter schema: properties: cloud_provider: description: The Virtual Private Cloud provider. enum: - aws - azure - gce example: aws type: string cloud_provider_region: description: The region of specific cloud provider. example: us-east-1 type: string location.code: description: The code of associated location to filter on. example: silicon_valley-ca type: string location.pop: description: The POP of associated location to filter on. example: SV1 type: string location.region: description: The region of associated location to filter on. example: AMER type: string location.site: description: The site of associated location to filter on. example: SJC type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/VirtualCrossConnectCoverageListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List Virtual Cross Connect Cloud Coverage tags: - Virtual Cross Connects x-latency-category: responsive /webhook_deliveries: get: description: Lists webhook_deliveries for the authenticated user operationId: GetWebhookDeliveries parameters: - $ref: '#/components/parameters/PageConsolidated' - description: 'Consolidated filter parameter (deepObject style). Originally: filter[status][eq], filter[event_type], filter[webhook][contains], filter[attempts][contains], filter[started_at][gte], filter[started_at][lte], filter[finished_at][gte], filter[finished_at][lte]' explode: true in: query name: filter required: false schema: properties: attempts: properties: contains: description: Return only webhook_deliveries whose `attempts` component contains the given text example: https://fallback.example.com/webhooks type: string type: object event_type: description: Return only webhook_deliveries matching the given value of `event_type`. Accepts multiple values separated by a `,`. example: call_initiated,call.initiated type: string finished_at: properties: gte: description: Return only webhook_deliveries whose delivery finished later than or at given ISO 8601 datetime example: '2019-03-29T11:10:00Z' type: string lte: description: Return only webhook_deliveries whose delivery finished earlier than or at given ISO 8601 datetime example: '2019-03-29T11:10:00Z' type: string type: object started_at: properties: gte: description: Return only webhook_deliveries whose delivery started later than or at given ISO 8601 datetime example: '2019-03-29T11:10:00Z' type: string lte: description: Return only webhook_deliveries whose delivery started earlier than or at given ISO 8601 datetime example: '2019-03-29T11:10:00Z' type: string type: object status: properties: eq: description: Return only webhook_deliveries matching the given `status` enum: - delivered - failed example: delivered type: string type: object webhook: properties: contains: description: Return only webhook deliveries whose `webhook` component contains the given text example: call.initiated type: string type: object type: object style: deepObject 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 /wireguard_interfaces: get: description: List all WireGuard Interfaces. operationId: ListWireguardInterfaces parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[network_id]' explode: true in: query name: filter schema: properties: network_id: description: The associated network id to filter on. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/WireguardInterfaceListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all WireGuard Interfaces tags: - WireGuard Interfaces x-latency-category: responsive post: description: Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created. operationId: CreateWireguardInterface requestBody: content: application/json: schema: $ref: '#/components/schemas/WireguardInterfaceCreate' required: true responses: '202': $ref: '#/components/responses/WireguardInterfaceResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create a WireGuard Interface tags: - WireGuard Interfaces x-latency-category: responsive /wireguard_interfaces/{id}: delete: description: Delete a WireGuard Interface. operationId: DeleteWireguardInterface parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/WireguardInterfaceResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete a WireGuard Interface tags: - WireGuard Interfaces x-latency-category: responsive get: description: Retrieve a WireGuard Interfaces. operationId: GetWireguardInterface parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/WireguardInterfaceResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve a WireGuard Interfaces tags: - WireGuard Interfaces x-latency-category: responsive /wireguard_peers: get: description: List all WireGuard peers. operationId: ListWireguardPeers parameters: - description: 'Consolidated filter parameter (deepObject style). Originally: filter[wireguard_interface_id]' explode: true in: query name: filter schema: properties: wireguard_interface_id: description: The id of the associated WireGuard interface to filter on. example: 6a09cdc3-8948-47f0-aa62-74ac943d6c58 format: uuid type: string type: object style: deepObject - $ref: '#/components/parameters/PageConsolidated' responses: '200': $ref: '#/components/responses/WireguardPeerListResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: List all WireGuard Peers tags: - WireGuard Interfaces x-latency-category: responsive post: description: Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created. operationId: CreateWireguardPeer requestBody: content: application/json: schema: $ref: '#/components/schemas/WireguardPeerCreate' required: true responses: '202': $ref: '#/components/responses/WireguardPeerResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Create a WireGuard Peer tags: - WireGuard Interfaces x-latency-category: responsive /wireguard_peers/{id}: delete: description: Delete the WireGuard peer. operationId: DeleteWireguardPeer parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/WireguardPeerResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Delete the WireGuard Peer tags: - WireGuard Interfaces x-latency-category: responsive get: description: Retrieve the WireGuard peer. operationId: GetWireguardPeer parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/WireguardPeerResponse' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve the WireGuard Peer tags: - WireGuard Interfaces x-latency-category: responsive patch: description: Update the WireGuard peer. operationId: UpdateWireguardPeer parameters: - $ref: '#/components/parameters/ResourceId' requestBody: content: application/json: schema: $ref: '#/components/schemas/WireguardPeerPatch' required: true responses: '200': $ref: '#/components/responses/WireguardPeerResponse' '422': $ref: '#/components/responses/netapps_UnprocessableEntity' default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Update the WireGuard Peer tags: - WireGuard Interfaces x-latency-category: responsive /wireguard_peers/{id}/config: get: description: Retrieve Wireguard config template for Peer operationId: GetWireguardPeerConfig parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': content: text/plain: schema: example: '[Interface] PrivateKey = <! INSERT PEER PRIVATE KEY HERE !> Address = 198.51.100.1/32 [Peer] PublicKey = qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU= AllowedIPs = 198.51.100.0/29 Endpoint = 203.0.113.0:51871 PersistentKeepalive = 25 ' type: string description: Successful response default: $ref: '#/components/responses/netapps_GenericErrorResponse' summary: Retrieve Wireguard config template for Peer tags: - WireGuard Interfaces 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/wireless_PageSize' responses: '200': $ref: '#/components/responses/GetWdrReportsResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get all Wireless Detail Records (WDRs) Reports tags: - Reporting x-latency-category: responsive 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/wireless_UnprocessableEntity' default: $ref: '#/components/responses/wireless_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/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Delete a Wireless Detail Record (WDR) Report tags: - Reporting x-latency-category: responsive get: description: Returns one specific WDR report operationId: GetWdrReport parameters: - $ref: '#/components/parameters/ResourceId' responses: '200': $ref: '#/components/responses/GetWdrReportResponse' '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get a Wireless Detail Record (WDR) Report tags: - Reporting x-latency-category: background /wireless/regions: get: description: Retrieve all wireless regions for the given product. operationId: WirelessRegionsGetAll parameters: - description: The product for which to list regions (e.g., 'public_ips', 'private_wireless_gateways'). in: query name: product required: true schema: example: public_ips type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/wireless_Region' type: array type: object description: A list of wireless regions '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get all wireless regions tags: - Wireless Regions x-latency-category: responsive /wireless_blocklist_values: get: description: Retrieve all wireless blocklist values for a given blocklist type. operationId: WirelessBlocklistsGetAll parameters: - description: The Wireless Blocklist type for which to list possible values (e.g., `country`, `mcc`, `plmn`). in: query name: type required: true schema: enum: - country - mcc - plmn example: country type: string responses: '200': content: application/json: schema: properties: data: oneOf: - items: $ref: '#/components/schemas/Country' title: Country type: array - items: $ref: '#/components/schemas/MCC' title: MCC type: array - items: $ref: '#/components/schemas/PLMN' title: PLMN type: array meta: $ref: '#/components/schemas/PaginationMeta' type: object description: A list of possible wireless blocklist values '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get all possible wireless blocklist values tags: - Wireless Blocklists x-latency-category: responsive /wireless_blocklists: get: description: Get all Wireless Blocklists belonging to the user. operationId: GetWirelessBlocklistsGateways parameters: - $ref: '#/components/parameters/PageNumber' - $ref: '#/components/parameters/wireless_PageSize' - description: The name of the Wireless Blocklist. example: my private gateway in: query name: filter[name] required: false schema: type: string - description: When the Private Wireless Gateway was last updated. example: country in: query name: filter[type] required: false schema: type: string - description: Values to filter on (inclusive). example: US,CA in: query name: filter[values] required: false schema: type: string responses: '200': $ref: '#/components/responses/GetAllWirelessBlocklistsResponse' '401': description: Unauthorized default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get all Wireless Blocklists tags: - Wireless Blocklists x-latency-category: responsive patch: description: Update a Wireless Blocklist. operationId: UpdateWirelessBlocklist requestBody: content: application/json: schema: properties: name: description: The name of the Wireless Blocklist. example: My Wireless Blocklist type: string type: description: The type of wireless blocklist. enum: - country - mcc - plmn example: country type: string values: description: Values to block. The values here depend on the `type` of Wireless Blocklist. example: - CA - US items: oneOf: - $ref: '#/components/schemas/CountryCode' - $ref: '#/components/schemas/MobileCountryCode' - $ref: '#/components/schemas/PLMNCode' type: array type: object required: true responses: '202': $ref: '#/components/responses/UpdateWirelessBlocklistResponse' '422': $ref: '#/components/responses/wireless_UnprocessableEntity' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Update a Wireless Blocklist tags: - Wireless Blocklists x-latency-category: responsive post: description: Create a Wireless Blocklist to prevent SIMs from connecting to certain networks. operationId: CreateWirelessBlocklist requestBody: content: application/json: schema: properties: name: description: The name of the Wireless Blocklist. example: My Wireless Blocklist type: string type: description: The type of wireless blocklist. enum: - country - mcc - plmn example: country type: string values: description: Values to block. The values here depend on the `type` of Wireless Blocklist. example: - CA - US items: oneOf: - $ref: '#/components/schemas/CountryCode' - $ref: '#/components/schemas/MobileCountryCode' - $ref: '#/components/schemas/PLMNCode' type: array required: - name - type - values type: object required: true responses: '202': $ref: '#/components/responses/CreateWirelessBlocklistResponse' '422': $ref: '#/components/responses/wireless_UnprocessableEntity' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Create a Wireless Blocklist tags: - Wireless Blocklists x-latency-category: responsive /wireless_blocklists/{id}: delete: description: Deletes the Wireless Blocklist. operationId: DeleteWirelessBlocklist parameters: - $ref: '#/components/parameters/WirelessBlocklistId' responses: '200': $ref: '#/components/responses/DeleteWirelessBlocklistResponse' '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Delete a Wireless Blocklist tags: - Wireless Blocklists x-latency-category: responsive get: description: Retrieve information about a Wireless Blocklist. operationId: GetWirelessBlocklist parameters: - $ref: '#/components/parameters/WirelessBlocklistId' responses: '200': $ref: '#/components/responses/GetWirelessBlocklistResponse' '404': $ref: '#/components/responses/wireless_ResourceNotFound' default: $ref: '#/components/responses/wireless_GenericErrorResponse' summary: Get a Wireless Blocklist tags: - Wireless Blocklists x-latency-category: responsive /{bucketName}: delete: description: Deletes a bucket. The bucket must be empty for it to be deleted. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html operationId: DeleteBucket parameters: - description: The name of the bucket. in: path name: bucketName required: true schema: type: string responses: '204': description: Success '401': description: Unauthorized summary: DeleteBucket tags: - Bucket x-latency-category: responsive get: description: List all objects contained in a given bucket. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html operationId: ListObjects parameters: - description: The name of the bucket. in: path name: bucketName required: true schema: maxLength: 64 minLength: 4 type: string - in: query name: list-type required: false schema: enum: - 2 type: integer responses: '200': content: application/xml: schema: $ref: '#/components/schemas/ListObjectsResponse' description: Success '404': description: Bucket does not exist. summary: ListObjectsV2 tags: - Object x-latency-category: responsive head: description: Determines if a bucket exists and you have permission to access it. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html operationId: HeadBucket parameters: - description: The name of the bucket. in: path name: bucketName required: true schema: type: string responses: '200': description: Success '404': description: NoSuchBucket summary: HeadBucket tags: - Bucket x-latency-category: responsive post: description: Deletes one or multiple objects from a given bucket. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html operationId: DeleteObjects parameters: - description: The bucket name. in: path name: bucketName required: true schema: type: string - allowEmptyValue: true in: query name: delete required: true schema: enum: - true type: boolean requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteObjectsRequest' required: true responses: '200': content: application/xml: schema: $ref: '#/components/schemas/DeleteObjectsResponse' description: Success '401': description: Unauthorized summary: DeleteObjects tags: - Object x-latency-category: responsive put: description: Create a bucket. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html operationId: CreateBucket parameters: - description: The name of the bucket. in: path name: bucketName required: true schema: example: mybucket maxLength: 64 minLength: 4 type: string requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateBucketRequest' responses: '200': description: Success '409': content: application/xml: schema: type: string xml: name: BucketAlreadyExists description: BucketAlreadyExists summary: CreateBucket tags: - Bucket x-latency-category: responsive /{bucketName}/{objectName}: delete: description: Delete an object from a given bucket. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html operationId: DeleteObject parameters: - description: The bucket name. in: path name: bucketName required: true schema: type: string - description: The object name. in: path name: objectName required: true schema: minLength: 1 type: string responses: '204': description: Success '401': description: Unauthorized summary: DeleteObject tags: - Object x-latency-category: responsive get: description: Retrieves an object from a given bucket. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html operationId: GetObject parameters: - description: The bucket name. in: path name: bucketName required: true schema: type: string - description: The object name. in: path name: objectName required: true schema: minLength: 1 type: string - in: query name: uploadId required: false schema: type: string responses: '200': content: application/octet-stream: schema: format: binary type: string description: Success '404': description: ObjectNotFound summary: GetObject tags: - Object x-latency-category: responsive head: description: Retrieves metadata from an object without returning the object itself. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html operationId: HeadObject parameters: - description: The bucket name. in: path name: bucketName required: true schema: type: string - description: The object name. in: path name: objectName required: true schema: minLength: 1 type: string responses: '200': description: Success headers: Content-Length: schema: type: integer Date: schema: format: date-time type: string Last-Modified: schema: format: date-time type: string '404': description: ObjectNotFound summary: HeadObject tags: - Object x-latency-category: responsive put: description: Add an object to a bucket. externalDocs: url: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html operationId: PutObject parameters: - description: The bucket name. in: path name: bucketName required: true schema: type: string - description: The object name. in: path name: objectName required: true schema: minLength: 1 type: string - in: header name: Content-type schema: type: string - in: query name: partNumber required: false schema: type: string - in: query name: uploadId required: false schema: type: string requestBody: content: '*/*': schema: format: binary type: string required: true responses: '200': description: Success '401': description: Unauthorized summary: PutObject tags: - Object x-latency-category: responsive /{bucketName}/{objectName}/uploads/{uploadID}: parameters: - in: path name: bucketName required: true schema: type: string - in: path name: objectName required: true schema: type: string - in: path name: uploadID required: true schema: maxLength: 36 minLength: 36 type: string security: - bearerAuth: [] servers: - description: Version 2.0.0 of the Telnyx API url: https://api.telnyx.com/v2 tags: - description: Access Tokens creation name: Access Tokens - description: Operations to work with Address records. Address records are emergency-validated addresses meant to be associated with phone numbers. They are validated for emergency usage purposes at creation time, although you may validate them separately with a custom workflow using the ValidateAddress operation separately. Address records are not usable for physical orders, such as for Telnyx SIM cards, please use UserAddress for that. It is not possible to entirely skip emergency service validation for Address records; if an emergency provider for a phone number rejects the address then it cannot be used on a phone number. To prevent records from getting out of sync, Address records are immutable and cannot be altered once created. If you realize you need to alter an address, a new record must be created with the differing address. name: Addresses - description: Advanced OptIn/OptOut name: Advanced OptIn/OptOut - description: Configure AI assistant specifications name: Assistants - description: Turn audio into text or text into audio. name: Audio - description: Audit log operations. name: Audit Logs - description: V2 Auto Recharge Preferences API name: AutoRechargePreferences - description: Billing operations name: Billing - description: Billing groups operations name: Billing Groups - description: Brand operations name: Brands - description: SSL certificate operations name: Bucket SSL Certificate - description: Bucket Usage operations name: Bucket Usage - description: Phone number campaign bulk assignment name: Bulk Phone Number Campaigns - description: Background jobs performed over a batch of phone numbers name: Bulk Phone Number Operations - description: Endpoints for creating and checking the status of campaigns, brands, and phone numbers name: Bulk Small Business - description: Bundle Pricing operations name: Bundle Pricing - description: Call Control command operations name: Call Commands - description: Call Control applications operations name: Call Control Applications - description: Call information name: Call Information - description: Call Recordings operations. name: Call Recordings - description: Campaign operations name: Campaign - description: Generate text with LLMs name: Chat - description: Identify common themes and patterns in your embedded documents name: Clusters - description: Conference command operations name: Conference Commands - description: Connections operations name: Connections - description: Manage historical AI assistant conversations name: Conversations - description: Country Coverage name: Country Coverage - description: Credential connection operations name: Credential Connections - description: Credentials operations name: Credentials - description: Customer Service Record operations name: Customer Service Record - description: Migrate data from an external provider into Telnyx Cloud Storage name: Data Migration - description: Call Control debugging name: Debugging - description: Detail Records operations name: Detail Records - description: Dialogflow Connection Operations. name: Dialogflow Integration - description: Documents name: Documents - description: Dynamic emergency address operations name: Dynamic Emergency Addresses - description: Dynamic Emergency Endpoints name: Dynamic Emergency Endpoints - description: Embed documents and perform text searches name: Embeddings - description: External Connections operations name: External Connections - description: FQDN connection operations name: FQDN Connections - description: FQDN operations name: FQDNs - description: Customize LLMs for your unique needs name: Fine Tuning - description: Global IPs name: Global IPs - description: IP Address Operations name: IP Addresses - description: IP connection operations name: IP Connections - description: IP Range Operations name: IP Ranges - description: IP operations name: IPs - description: Store and retrieve integration secrets name: Integration Secrets - description: Inventory Level name: Inventory Level - description: Invoice operations name: Invoice - 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: Manage your tollfree verification requests name: Messaging Tollfree Verification - description: Messaging URL Domains name: Messaging URL Domains - description: Mobile network operators operations name: Mobile Network Operators - description: Monthly Charges Report name: Monthly Charges - description: Network operations name: Networks - description: Notification settings operations name: Notifications - description: Configure your phone numbers name: Number Configurations - description: Look up phone number data name: Number Lookup - description: Number portout operations name: Number Portout - description: OTA updates operations name: OTA updates - description: Outbound voice profiles operations name: Outbound Voice Profiles - description: Background jobs performed over a phone-numbers block's phone numbers name: Phone Number Blocks Background Jobs - description: Phone number campaign assignment name: Phone Number Campaigns - description: Configure your phone numbers name: Phone Number Configurations - description: Number order documents name: Phone Number Order Documents - description: Number orders name: Phone Number Orders - description: Determining portability of phone numbers name: Phone Number Porting - description: Number reservations name: Phone Number Reservations - description: Number search name: Phone Number Search - description: Endpoints related to porting orders management. name: Porting Orders - description: Presigned object URL operations name: Presigned Object URLs - 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: Public Internet Gateway operations name: Public Internet Gateways - description: Mobile push credential management name: Push Credentials - description: Queue commands operations name: Queue Commands - description: Send RCS messages name: RCS messaging - description: Regions name: Regions - description: Regulatory Requirements name: Regulatory Requirements - description: Wireless reporting operations name: Reporting - description: Ledger billing reports name: Reports - description: Requirement Groups name: Requirement Groups - 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 Compositions operations. name: Room Compositions - description: Rooms Participants operations. name: Room Participants - description: Rooms Recordings operations. name: Room Recordings - description: Rooms Sessions operations. name: Room Sessions - description: Rooms operations. name: Rooms - description: Rooms Client Tokens operations. name: Rooms Client Tokens - description: Observability into Telnyx platform stability and performance. name: SETI Observability - description: View SIM card actions, their progress and timestamps using the SIM Card Actions API name: SIM Card Actions - 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: SIPREC connectors configuration. name: SIPREC Connectors - description: Short codes name: Short Codes - description: TeXML Applications operations name: TeXML Applications - description: TeXML REST Commands name: TeXML REST Commands - description: Text to Speech commands operations name: Text to Speech Commands - description: Usage data reporting across Telnyx products name: Usage Reports (BETA) - description: User-defined tags for Telnyx resources name: User Tags - description: Operations for working with UserAddress records. UserAddress records are stored addresses that users can use for non-emergency-calling purposes, such as for shipping addresses for orders of wireless SIMs (or other physical items). They cannot be used for emergency calling and are distinct from Address records, which are used on phone numbers. name: UserAddresses - description: Verified Numbers operations name: Verified Numbers - description: Two factor authentication API name: Verify - description: Virtual Cross Connect operations name: Virtual Cross Connects - description: Voice Channels name: Voice Channels - description: Voicemail API name: Voicemail - description: Webhooks operations name: Webhooks - description: WireGuard Interface operations name: WireGuard Interfaces - description: Wireless operations name: Wireless - description: Wireless Blocklists operations name: Wireless Blocklists - description: Regions for wireless services name: Wireless Regions webhooks: CallAIGatherEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallAIGatherEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallAIGatherEndedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call AI Gather Ended tags: - Call Commands CallAIGatherMessageHistoryUpdated: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallAIGatherMessageHistoryUpdated parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallAIGatherMessageHistoryUpdatedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call AI Gather Message History Updated tags: - Call Commands CallAIGatherPartialResults: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallAIGatherPartialResults parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallAIGatherPartialResultsEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call AI Gather Partial Results tags: - Call Commands CustomerServiceRecordStatusChanged: post: description: This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details. operationId: CustomerServiceRecordStatusChanged parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: properties: data: $ref: '#/components/schemas/CustomerServiceRecordStatusChangedEvent' meta: $ref: '#/components/schemas/CallbackWebhookMeta' type: object required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Customer Service Record Status Changed tags: - Customer Service Record callAnswered: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallAnswered parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Answered tags: - Call Commands callBridged: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallBridged parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Bridged tags: - Call Commands callConversationEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallConversationEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/callConversationEndedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Conversation Ended tags: - Call Commands callConversationInsightsGenerated: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallConversationInsightsGenerated parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/callConversationInsightsGeneratedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Conversation Insights Generated tags: - Call Commands callDtmfReceived: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallDtmfReceived parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Dtmf Received tags: - Call Commands callEnqueued: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallEnqueued parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Enqueued tags: - Call Commands callForkStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallForkStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Fork Started tags: - Call Commands callForkStopped: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallForkStopped parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Fork Stopped tags: - Call Commands callGatherEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallGatherEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Gather Ended tags: - Call Commands callHangup: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallHangup parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Hangup tags: - Call Commands callInitiated: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallInitiated parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Initiated tags: - Call Commands callLeftQueue: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallLeftQueue parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Left Queue tags: - Call Commands callMachineDetectionEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallMachineDetectionEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Machine Detection Ended tags: - Call Commands callMachineGreetingEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallMachineGreetingEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Machine Greeting Ended tags: - Call Commands callMachinePremiumDetectionEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallMachinePremiumDetectionEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallMachinePremiumDetectionEndedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Machine Premium Detection Ended tags: - Call Commands callMachinePremiumGreetingEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallMachinePremiumGreetingEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallMachinePremiumGreetingEndedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Machine Premium Greeting Ended tags: - Call Commands callPlaybackEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallPlaybackEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Playback Ended tags: - Call Commands callPlaybackStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallPlaybackStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Playback Started tags: - Call Commands callRecordingError: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallRecordingError parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/callRecordingErrorEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Recording Error tags: - Call Commands callRecordingSaved: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallRecordingSaved parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Recording Saved tags: - Call Commands callRecordingTranscriptionSaved: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallRecordingTranscriptionSaved parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/callRecordingTranscriptionSavedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Recording Transcription Saved tags: - Call Commands callReferCompleted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallReferCompleted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Refer Completed tags: - Call Commands callReferFailed: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallReferFailed parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Refer Failed tags: - Call Commands callReferStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallReferStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Refer Started tags: - Call Commands callSiprecFailed: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallSiprecFailed parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallSiprecFailedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Siprec Failed tags: - Call Commands callSiprecStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallSiprecStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallSiprecStartedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Siprec Started tags: - Call Commands callSiprecStopped: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallSiprecStopped parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallSiprecStoppedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Siprec Stopped tags: - Call Commands callSpeakEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallSpeakEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Speak Ended tags: - Call Commands callSpeakStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallSpeakStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Call Speak Started tags: - Call Commands callStreamingFailed: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallStreamingFailed parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallStreamingFailedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Streaming Failed tags: - Call Commands callStreamingStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallStreamingStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallStreamingStartedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Streaming Started tags: - Call Commands callStreamingStopped: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CallStreamingStopped parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallStreamingStoppedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Call Streaming Stopped tags: - Call Commands campaignStatusUpdate: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: CampaignStatusUpdate parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CampaignStatusUpdateEvent' required: true responses: '200': description: The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL. summary: Campaign Status Update tags: - Campaign conferenceCreated: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceCreated parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Created tags: - Conference Commands conferenceEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Ended tags: - Conference Commands conferenceFloorChanged: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceFloorChanged parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Floor Changed tags: - Conference Commands conferenceParticipantJoined: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceParticipantJoined parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Participant Joined tags: - Conference Commands conferenceParticipantLeft: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceParticipantLeft parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Participant Left tags: - Conference Commands conferenceParticipantPlaybackEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceParticipantPlaybackEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Participant Playback Ended tags: - Conference Commands conferenceParticipantPlaybackStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceParticipantPlaybackStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Participant Playback Started tags: - Conference Commands conferenceParticipantSpeakEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceParticipantSpeakEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Participant Speak Ended tags: - Conference Commands conferenceParticipantSpeakStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceParticipantSpeakStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Participant Speak Started tags: - Conference Commands conferencePlaybackEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferencePlaybackEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Playback Ended tags: - Conference Commands conferencePlaybackStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferencePlaybackStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Playback Started tags: - Conference Commands conferenceRecordingSaved: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceRecordingSaved parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Recording Saved tags: - Conference Commands conferenceSpeakEnded: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceSpeakEnded parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Speak Ended tags: - Conference Commands conferenceSpeakStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ConferenceSpeakStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Conference Speak Started tags: - Conference Commands deliveryUpdate: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: DeliveryUpdate parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Delivery Update tags: - Messages fax.delivered: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: FaxDelivered parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Fax Delivered tags: - Programmable Fax Commands fax.failed: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: FaxFailed parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Fax Failed tags: - Programmable Fax Commands fax.media.processed: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: FaxMediaProcessed parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Fax Media Processed tags: - Programmable Fax Commands fax.queued: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: FaxQueued parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Fax Queued tags: - Programmable Fax Commands fax.sending.started: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: FaxSendingStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Fax Sending Started tags: - Programmable Fax Commands inboundMessage: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: InboundMessage parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Inbound Message tags: - Messages numberOrderStatusUpdate: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: NumberOrderStatusUpdate parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/NumberOrderWebhookEvent' required: true responses: '200': description: The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL. summary: Number Order Status Update tags: - Phone Number Orders replacedLinkClick: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: ReplacedLinkClick parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Replaced Link Click tags: - Messaging Profiles streamingFailed: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: StreamingFailed parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallStreamingFailedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Streaming Failed tags: - Call Commands streamingStarted: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: StreamingStarted parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallStreamingStartedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Streaming Started tags: - Call Commands streamingStopped: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: StreamingStopped parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature requestBody: content: application/json: schema: $ref: '#/components/schemas/CallStreamingStoppedEvent' required: true responses: '200': description: The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL. summary: Streaming Stopped tags: - Call Commands transcription: post: description: ' This webhook uses Telnyx headers (telnyx-timestamp, telnyx-signature-ed25519) that are compatible with Standard Webhooks specification for SDK generation. Custom validation logic can map these to standard webhook-timestamp and webhook-signature equivalents. See https://github.com/standard-webhooks/standard-webhooks for details.' operationId: Transcription parameters: - description: Unix timestamp (seconds since epoch) of when the webhook was sent - compatible with webhook-timestamp in: header name: telnyx-timestamp required: true schema: description: Unix timestamp for replay attack prevention format: int64 type: integer x-webhook-equivalent: webhook-timestamp - description: Base64 encoded Ed25519 signature for webhook verification - compatible with webhook-signature in: header name: telnyx-signature-ed25519 required: true schema: description: Ed25519 signature of timestamp|payload for verification type: string x-webhook-equivalent: webhook-signature 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. summary: Transcription tags: - Call Commands