{ "opencollection": "1.0.0", "info": { "name": "Telnyx API", "version": "2.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "OAuth Discovery", "type": "folder" }, "items": [ { "info": { "name": "Authorization server metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/.well-known/oauth-authorization-server" }, "docs": "OAuth 2.0 Authorization Server Metadata (RFC 8414)" }, { "info": { "name": "Protected resource metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/.well-known/oauth-protected-resource" }, "docs": "OAuth 2.0 Protected Resource Metadata for resource discovery" } ] }, { "info": { "name": "Brands", "type": "folder" }, "items": [ { "info": { "name": "List Brands", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/brand", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "recordsPerPage", "value": "", "type": "query", "description": "number of records per page. maximum of 500" }, { "name": "sort", "value": "-identityStatus", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by createdAt in descending order." }, { "name": "displayName", "value": "", "type": "query" }, { "name": "entityType", "value": "", "type": "query" }, { "name": "state", "value": "", "type": "query" }, { "name": "country", "value": "", "type": "query" }, { "name": "brandId", "value": "", "type": "query", "description": "Filter results by the Telnyx Brand id" }, { "name": "tcrBrandId", "value": "", "type": "query", "description": "Filter results by the TCR Brand id" } ] }, "docs": "This endpoint is used to list all brands associated with your organization." }, { "info": { "name": "Create Brand", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/brand", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Brand Feedback By Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/brand/feedback/:brandId", "params": [ { "name": "brandId", "value": "", "type": "path" } ] }, "docs": "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 " }, { "info": { "name": "Get Brand SMS OTP Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/brand/smsOtp/:referenceId", "params": [ { "name": "referenceId", "value": "", "type": "path", "description": "The reference ID returned when the OTP was initially triggered" }, { "name": "brandId", "value": "", "type": "query", "description": "Filter by Brand ID for easier lookup in portal applications" } ] }, "docs": "Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification.\n\nThis endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand verification process. You can query by either:\n\n* `referenceId` - The reference ID returned when the OTP was initially triggered\n* `brandId` - Query parameter for portal users to look up OTP status by Brand ID\n\nThe response includes delivery status, verification dates, and detailed delive" }, { "info": { "name": "Get Brand", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId", "params": [ { "name": "brandId", "value": "", "type": "path" } ] }, "docs": "Retrieve a brand by `brandId`." }, { "info": { "name": "Update Brand", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId", "params": [ { "name": "brandId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a brand's attributes by `brandId`." }, { "info": { "name": "Delete Brand", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId", "params": [ { "name": "brandId", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Resend brand 2FA email", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/2faEmail", "params": [ { "name": "brandId", "value": "", "type": "path" } ] }, "docs": "Resend brand 2FA email" }, { "info": { "name": "List External Vettings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting", "params": [ { "name": "brandId", "value": "", "type": "path" } ] }, "docs": "Get list of valid external vetting record for a given brand" }, { "info": { "name": "Order Brand External Vetting", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting", "params": [ { "name": "brandId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Order new external vetting for a brand.\n\nDuplicate orders for the same `evpId` and `vettingClass` return `400` with code `10012` if a successful vetting exists within the last 180 days, or one is currently being processed. Failed vettings can be retried immediately." }, { "info": { "name": "Import External Vetting Record", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/externalVetting", "params": [ { "name": "brandId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation can be used to import an external vetting record from a TCR-approved\nvetting provider. If the vetting provider confirms validity of the record, it will be\nsaved with the brand and will be considered for future campaign qualification." }, { "info": { "name": "Revet Brand", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/revet", "params": [ { "name": "brandId", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Get Brand SMS OTP Status by Brand ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The Brand ID for which to query OTP status" } ] }, "docs": "Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID.\n\nThis endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand verification process by looking it up with the brand ID.\n\nThe response includes delivery status, verification dates, and detailed delivery information.\n\n**Note:** This is an alternative to the `/10dlc/brand/smsOtp/{referenceId}` endpoint when you have the Brand ID but n" }, { "info": { "name": "Trigger Brand SMS OTP", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The Brand ID for which to trigger the OTP" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Trigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification.\n\n**Important Notes:**\n\n* Only allowed for Sole Proprietor (`SOLE_PROPRIETOR`) brands\n* Triggers generation of a one-time password sent to the `mobilePhone` number in the brand's profile\n* Campaigns cannot be created until OTP verification is complete\n* US/CA numbers only for real OTPs; mock brands can use non-US/CA numbers for testing\n* Returns a `referenceId` that can be used to check OTP status via the" }, { "info": { "name": "Verify Brand SMS OTP", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/10dlc/brand/:brandId/smsOtp", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "The Brand ID for which to verify the OTP" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify the SMS OTP (One-Time Password) for Sole Proprietor brand verification.\n\n**Verification Flow:**\n\n1. User receives OTP via SMS after triggering\n2. User submits the OTP pin through this endpoint\n3. Upon successful verification:\n - A `BRAND_OTP_VERIFIED` webhook event is sent to the CSP\n - The brand's `identityStatus` changes to `VERIFIED`\n - Campaigns can now be created for this brand\n\n**Error Handling:**\n\nProvides proper error responses for:\n* Invalid OTP pins\n* Expired OTPs\n* OTP ve" } ] }, { "info": { "name": "Campaign", "type": "folder" }, "items": [ { "info": { "name": "List Campaigns", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/campaign", "params": [ { "name": "brandId", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "The 1-indexed page number to get. The default value is `1`." }, { "name": "recordsPerPage", "value": "", "type": "query", "description": "The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`." }, { "name": "sort", "value": "-assignedPhoneNumbersCount", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by createdAt in descending order." } ] }, "docs": "Retrieve a list of campaigns associated with a supplied `brandId`." }, { "info": { "name": "Accept Shared Campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/campaign/acceptSharing/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "TCR's ID for the campaign to import" } ] }, "docs": "Manually accept a campaign shared with Telnyx" }, { "info": { "name": "Get Campaign Cost", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/campaign/usecase/cost", "params": [ { "name": "usecase", "value": "", "type": "query" } ] }, "docs": "Get Campaign Cost" }, { "info": { "name": "Get campaign", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "Retrieve campaign details by `campaignId`." }, { "info": { "name": "Update campaign", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a campaign's properties by `campaignId`. **Please note:** only sample messages are editable." }, { "info": { "name": "Deactivate campaign", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "Terminate a campaign. Note that once deactivated, a campaign cannot be restored." }, { "info": { "name": "Submit campaign appeal for manual review", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/appeal", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "The Telnyx campaign identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Campaign Mno Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/mnoMetadata", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "ID of the campaign in question" } ] }, "docs": "Get the campaign metadata for each MNO it was submitted to." }, { "info": { "name": "Get campaign operation status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/operationStatus", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "Retrieve campaign's operation status at MNO level." }, { "info": { "name": "Get OSR campaign attributes", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/osr/attributes", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "Get OSR campaign attributes" }, { "info": { "name": "Get Sharing Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/sharing", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "ID of the campaign in question" } ] }, "docs": "Get Sharing Status" }, { "info": { "name": "Submit Campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/campaignBuilder", "body": { "type": "json", "data": "{}" } }, "docs": "Before creating a campaign, use the [Qualify By Usecase endpoint](https://developers.telnyx.com/api-reference/campaign/qualify-by-usecase) 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 s" }, { "info": { "name": "Qualify By Usecase", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/campaignBuilder/brand/:brandId/usecase/:usecase", "params": [ { "name": "usecase", "value": "", "type": "path" }, { "name": "brandId", "value": "", "type": "path" } ] }, "docs": "This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case." } ] }, { "info": { "name": "Enum", "type": "folder" }, "items": [ { "info": { "name": "Get Enum", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/enum/:endpoint", "params": [ { "name": "endpoint", "value": "", "type": "path" } ] }, "docs": "Get Enum" } ] }, { "info": { "name": "Shared Campaigns", "type": "folder" }, "items": [ { "info": { "name": "List shared partner campaigns", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/partnerCampaign/sharedByMe", "params": [ { "name": "page", "value": "", "type": "query", "description": "The 1-indexed page number to get. The default value is `1`." }, { "name": "recordsPerPage", "value": "", "type": "query", "description": "The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`." } ] }, "docs": "Get all partner campaigns you have shared to Telnyx in a paginated fashion\n\nThis endpoint is currently limited to only returning shared campaigns that Telnyx\nhas accepted. In other words, shared but pending campaigns are currently omitted\nfrom the response from this endpoint." }, { "info": { "name": "Get Sharing Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/partnerCampaign/:campaignId/sharing", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "ID of the campaign in question" } ] }, "docs": "Get Sharing Status" }, { "info": { "name": "List Shared Campaigns", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/partner_campaigns", "params": [ { "name": "page", "value": "", "type": "query", "description": "The 1-indexed page number to get. The default value is `1`." }, { "name": "recordsPerPage", "value": "", "type": "query", "description": "The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`." }, { "name": "sort", "value": "-assignedPhoneNumbersCount", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by createdAt in descending order." } ] }, "docs": "Retrieve all partner campaigns you have shared to Telnyx in a paginated fashion.\n\nThis 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." }, { "info": { "name": "Get Single Shared Campaign", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/partner_campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "Retrieve campaign details by `campaignId`." }, { "info": { "name": "Update Single Shared Campaign", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/10dlc/partner_campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update campaign details by `campaignId`. **Please note:** Only webhook urls are editable." } ] }, { "info": { "name": "Bulk Phone Number Campaigns", "type": "folder" }, "items": [ { "info": { "name": "Assign Messaging Profile To Campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile", "body": { "type": "json", "data": "{}" } }, "docs": "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 `campaig" }, { "info": { "name": "Get Assignment Task Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path" } ] }, "docs": "Check the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by `taskId`." }, { "info": { "name": "Get Phone Number Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/phoneNumberAssignmentByProfile/:taskId/phoneNumbers", "params": [ { "name": "taskId", "value": "", "type": "path" }, { "name": "recordsPerPage", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "Check the status of the individual phone number/campaign assignments associated with the supplied `taskId`." } ] }, { "info": { "name": "Phone Number Campaigns", "type": "folder" }, "items": [ { "info": { "name": "List phone number campaigns", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/phone_number_campaigns", "params": [ { "name": "recordsPerPage", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[telnyx_campaign_id], filter[telnyx_brand_id], filter[tcr_campaign_id], filter[tcr_brand_id]" }, { "name": "sort", "value": "-phoneNumber", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by createdAt in descending order." } ] }, "docs": "List phone number campaigns" }, { "info": { "name": "Create New Phone Number Campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/10dlc/phone_number_campaigns", "body": { "type": "json", "data": "{}" } }, "docs": "Create New Phone Number Campaign" }, { "info": { "name": "Get Single Phone Number Campaign", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/10dlc/phone_number_campaigns/:phoneNumber", "params": [ { "name": "phoneNumber", "value": "", "type": "path" } ] }, "docs": "Retrieve an individual phone number/campaign assignment by `phoneNumber`." }, { "info": { "name": "Create New Phone Number Campaign", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/10dlc/phone_number_campaigns/:phoneNumber", "params": [ { "name": "phoneNumber", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create New Phone Number Campaign" }, { "info": { "name": "Delete Phone Number Campaign", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/10dlc/phone_number_campaigns/:phoneNumber", "params": [ { "name": "phoneNumber", "value": "", "type": "path" } ] }, "docs": "This endpoint allows you to remove a campaign assignment from the supplied `phoneNumber`." } ] }, { "info": { "name": "IP Addresses", "type": "folder" }, "items": [ { "info": { "name": "List all Access IP Addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/access_ip_address", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[ip_source], filter[ip_address], filter[created_at]. Supports complex bracket operations for dynamic filtering." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Access IP Addresses" }, { "info": { "name": "Create new Access IP Address", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/access_ip_address", "body": { "type": "json", "data": "{}" } }, "docs": "Create new Access IP Address" }, { "info": { "name": "Retrieve an access IP address", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/access_ip_address/:access_ip_address_id", "params": [ { "name": "access_ip_address_id", "value": "", "type": "path" } ] }, "docs": "Retrieve an access IP address" }, { "info": { "name": "Delete access IP address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/access_ip_address/:access_ip_address_id", "params": [ { "name": "access_ip_address_id", "value": "", "type": "path" } ] }, "docs": "Delete access IP address" } ] }, { "info": { "name": "IP Ranges", "type": "folder" }, "items": [ { "info": { "name": "List all Access IP Ranges", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/access_ip_ranges", "params": [ { "name": "filter", "value": "", "type": "query", "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." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Access IP Ranges" }, { "info": { "name": "Create new Access IP Range", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/access_ip_ranges", "body": { "type": "json", "data": "{}" } }, "docs": "Create new Access IP Range" }, { "info": { "name": "Delete access IP ranges", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/access_ip_ranges/:access_ip_range_id", "params": [ { "name": "access_ip_range_id", "value": "", "type": "path" } ] }, "docs": "Delete access IP ranges" } ] }, { "info": { "name": "SIM Cards", "type": "folder" }, "items": [ { "info": { "name": "Purchase eSIMs", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/actions/purchase/esims", "body": { "type": "json", "data": "{}" } }, "docs": "Purchases and registers the specified amount of eSIMs to the current user's account.

\nIf sim_card_group_id is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used.

\n" }, { "info": { "name": "Register SIM cards", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/actions/register/sim_cards", "body": { "type": "json", "data": "{}" } }, "docs": "Register the SIM cards associated with the provided registration codes to the current user's account.

\nIf sim_card_group_id is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.

\n" }, { "info": { "name": "List SIM card data usage notifications", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "filter[sim_card_id]", "value": "", "type": "query", "description": "A valid SIM card ID." } ] }, "docs": "Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters." }, { "info": { "name": "Create a new SIM card data usage notification", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new SIM card data usage notification." }, { "info": { "name": "Get a single SIM card data usage notification", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Get a single SIM Card Data Usage Notification." }, { "info": { "name": "Updates information for a SIM Card Data Usage Notification", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates information for a SIM Card Data Usage Notification." }, { "info": { "name": "Delete SIM card data usage notifications", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/sim_card_data_usage_notifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete the SIM Card Data Usage Notification." }, { "info": { "name": "Get all SIM cards", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_cards", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter for SIM cards (deepObject style). Originally: filter[iccid], filter[msisdn], filter[status], filter[tags]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "include_sim_card_group", "value": "", "type": "query", "description": "It includes the associated SIM card group object in the response when present." }, { "name": "filter[sim_card_group_id]", "value": "", "type": "query", "description": "A valid SIM card group ID." }, { "name": "sort", "value": "-current_billing_period_consumed_data.amount", "type": "query", "description": "Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus sign." } ] }, "docs": "Get all SIM cards belonging to the user that match the given filters." }, { "info": { "name": "Request bulk disabling voice on SIM cards.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/actions/bulk_disable_voice", "body": { "type": "json", "data": "{}" } }, "docs": "This API triggers an asynchronous operation to disable voice on SIM cards belonging to a specified SIM Card Group.
\nFor each SIM Card a SIM Card Action will be generated. The status of the SIM Card Actions can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n\nThe overall status of the Bulk SIM Card Action can be followed through the [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/si" }, { "info": { "name": "Request bulk enabling voice on SIM cards.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/actions/bulk_enable_voice", "body": { "type": "json", "data": "{}" } }, "docs": "This API triggers an asynchronous operation to enable voice on SIM cards belonging to a specified SIM Card Group.
\nFor each SIM Card a SIM Card Action will be generated. The status of the SIM Card Actions can be followed through the [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n\nThe overall status of the Bulk SIM Card Action can be followed through the [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/sim" }, { "info": { "name": "Request bulk setting SIM card public IPs.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/actions/bulk_set_public_ips", "body": { "type": "json", "data": "{}" } }, "docs": "This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards.
\nFor 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://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n" }, { "info": { "name": "Validate SIM cards registration codes", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/actions/validate_registration_codes", "body": { "type": "json", "data": "{}" } }, "docs": "It validates whether SIM card registration codes are valid or not." }, { "info": { "name": "Get SIM card", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_cards/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." }, { "name": "include_sim_card_group", "value": "", "type": "query", "description": "It includes the associated SIM card group object in the response when present." }, { "name": "include_pin_puk_codes", "value": "", "type": "query", "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." } ] }, "docs": "Returns the details regarding a specific SIM card." }, { "info": { "name": "Update a SIM card", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/sim_cards/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates SIM card data" }, { "info": { "name": "Deletes a SIM card", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/sim_cards/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." }, { "name": "report_lost", "value": "", "type": "query", "description": "Enables deletion of disabled eSIMs that can't be uninstalled from a device. This is irreversible and the eSIM cannot be re-registered." } ] }, "docs": "The SIM card will be decommissioned, removed from your account and you will stop being charged.
The SIM card won't be able to connect to the network after the deletion is completed, thus making it impossible to consume data.
\nTransitioning to the disabled state may take a period of time.\nUntil the transition is completed, the SIM card status will be disabling disabling.
In order to re-enable the SIM card, you will need to re-register it." }, { "info": { "name": "Request a SIM card disable", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/disable", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ] }, "docs": "This API disables a SIM card, disconnecting it from the network and making it impossible to consume data.
\nThe 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://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n" }, { "info": { "name": "Request a SIM card enable", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/enable", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ] }, "docs": "This API enables a SIM card, connecting it to the network and making it possible to consume data.
\nTo enable a SIM card, it must be associated with a SIM card group.
\nThe 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://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.\n" }, { "info": { "name": "Request removing a SIM card public IP", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/remove_public_ip", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ] }, "docs": "This API removes an existing public IP from a SIM card.

\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://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API." }, { "info": { "name": "Request setting a SIM card public IP", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/set_public_ip", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." }, { "name": "region_code", "value": "", "type": "query", "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" } ] }, "docs": "This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card.

\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://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions) API.

\n Setting a Public IP to a SIM Card incurs a charge and will only succeed if the account has sufficient funds." }, { "info": { "name": "Request setting a SIM card to standby", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_cards/:id/actions/set_standby", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ] }, "docs": "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.
\nTo set a SIM card to standby, it must be associated with SIM card group.
\nThe 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://developers.telnyx.com/api-reference/si" }, { "info": { "name": "Get activation code for an eSIM", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_cards/:id/activation_code", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ] }, "docs": "It returns the activation code for an eSIM.

\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" }, { "info": { "name": "Get SIM card device details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_cards/:id/device_details", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ] }, "docs": "It returns the device details where a SIM card is currently being used.\n" }, { "info": { "name": "Get SIM card public IP definition", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_cards/:id/public_ip", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ] }, "docs": "It returns the public IP requested for a SIM card.\n" }, { "info": { "name": "List wireless connectivity logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_cards/:id/wireless_connectivity_logs", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM." } ] }, "docs": "This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes." } ] }, { "info": { "name": "Addresses", "type": "folder" }, "items": [ { "info": { "name": "List all addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/addresses", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." } ] }, "docs": "Returns a list of your addresses." }, { "info": { "name": "Creates an address", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/addresses", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an address." }, { "info": { "name": "Validate an address", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/addresses/actions/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Validates an address for emergency services." }, { "info": { "name": "Retrieve an address", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/addresses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "address ID" } ] }, "docs": "Retrieves the details of an existing address." }, { "info": { "name": "Deletes an address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/addresses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "address ID" } ] }, "docs": "Deletes an existing address." }, { "info": { "name": "Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/addresses/:id/actions/accept_suggestions", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID of the address that should be accepted." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft." } ] }, { "info": { "name": "Advanced Number Orders", "type": "folder" }, "items": [ { "info": { "name": "List Advanced Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/advanced_orders" }, "docs": "List Advanced Orders" }, { "info": { "name": "Create Advanced Order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/advanced_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Create Advanced Order" }, { "info": { "name": "Update Advanced Order", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/advanced_orders/:advanced-order-id/requirement_group", "params": [ { "name": "advanced-order-id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Advanced Order" }, { "info": { "name": "Get Advanced Order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/advanced_orders/:order_id", "params": [ { "name": "order_id", "value": "", "type": "path" } ] }, "docs": "Get Advanced Order" } ] }, { "info": { "name": "Assistants", "type": "folder" }, "items": [ { "info": { "name": "List assistants", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants" }, "docs": "Retrieve a list of all AI Assistants configured by the user." }, { "info": { "name": "Create an assistant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new AI Assistant." }, { "info": { "name": "Import assistants from external provider", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/import", "body": { "type": "json", "data": "{}" } }, "docs": "Import assistants from external providers. Any assistant that has already been imported will be overwritten with its latest version from the importing provider." }, { "info": { "name": "Get All Tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/tags" }, "docs": "Get All Tags" }, { "info": { "name": "List assistant tests with pagination", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/tests", "params": [ { "name": "test_suite", "value": "", "type": "query", "description": "Filter tests by test suite name" }, { "name": "telnyx_conversation_channel", "value": "", "type": "query", "description": "Filter tests by communication channel (e.g., 'web_chat', 'sms')" }, { "name": "destination", "value": "", "type": "query", "description": "Filter tests by destination (phone number, webhook URL, etc.)" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Retrieves a paginated list of assistant tests with optional filtering capabilities" }, { "info": { "name": "Create a new assistant test", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/tests", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a comprehensive test configuration for evaluating AI assistant performance" }, { "info": { "name": "Get all test suite names", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/tests/test-suites" }, "docs": "Retrieves a list of all distinct test suite names available to the current user" }, { "info": { "name": "Get test suite run history", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/tests/test-suites/:suite_name/runs", "params": [ { "name": "suite_name", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query", "description": "Filter runs by execution status (pending, running, completed, failed, timeout)" }, { "name": "test_suite_run_id", "value": "", "type": "query", "description": "Filter runs by specific suite execution batch ID" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Retrieves paginated history of test runs for a specific test suite with filtering options" }, { "info": { "name": "Trigger test suite execution", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/tests/test-suites/:suite_name/runs", "params": [ { "name": "suite_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Executes all tests within a specific test suite as a batch operation" }, { "info": { "name": "Get assistant test by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id", "params": [ { "name": "test_id", "value": "", "type": "path" } ] }, "docs": "Retrieves detailed information about a specific assistant test" }, { "info": { "name": "Update an assistant test", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id", "params": [ { "name": "test_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing assistant test configuration with new settings" }, { "info": { "name": "Delete an assistant test", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id", "params": [ { "name": "test_id", "value": "", "type": "path" } ] }, "docs": "Permanently removes an assistant test and all associated data" }, { "info": { "name": "Get test run history for a specific test", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id/runs", "params": [ { "name": "test_id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query", "description": "Filter runs by execution status (pending, running, completed, failed, timeout)" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Retrieves paginated execution history for a specific assistant test with filtering options" }, { "info": { "name": "Trigger a manual test run", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id/runs", "params": [ { "name": "test_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates immediate execution of a specific assistant test" }, { "info": { "name": "Get specific test run details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/tests/:test_id/runs/:run_id", "params": [ { "name": "test_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ] }, "docs": "Retrieves detailed information about a specific test run execution" }, { "info": { "name": "Get an assistant", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "fetch_dynamic_variables_from_webhook", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "call_control_id", "value": "", "type": "query" } ] }, "docs": "Retrieve an AI Assistant configuration by `assistant_id`." }, { "info": { "name": "Update an assistant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an AI Assistant's attributes." }, { "info": { "name": "Delete an assistant", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ] }, "docs": "Delete an AI Assistant by `assistant_id`." }, { "info": { "name": "Get Canary Deploy", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ] }, "docs": "Endpoint to get a canary deploy configuration for an assistant.\n\nRetrieves the current canary deploy configuration with all version IDs and their\ntraffic percentages for the specified assistant." }, { "info": { "name": "Create Canary Deploy", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Endpoint to create a canary deploy configuration for an assistant.\n\nCreates a new canary deploy configuration with multiple version IDs and their traffic\npercentages for A/B testing or gradual rollouts of assistant versions." }, { "info": { "name": "Update Canary Deploy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete Canary Deploy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/canary-deploys", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ] }, "docs": "Endpoint to delete a canary deploy configuration for an assistant.\n\nRemoves all canary deploy configurations for the specified assistant." }, { "info": { "name": "Assistant Chat (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/chat", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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-reference/conversations/create-a-conversation), [filter existing conversations](https://developers.telnyx.com/api-reference/conversations/list-conversations), [fetch messages for a conversation](https://developers.telnyx" }, { "info": { "name": "Assistant Sms Chat", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/chat/sms", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send an SMS message for an assistant. This endpoint: \n1. Validates the assistant exists and has messaging profile configured \n2. If should_create_conversation is true, creates a new conversation with metadata \n3. Sends the SMS message (If `text` is set, this will be sent. Otherwise, if this is the first message in the conversation and the assistant has a `greeting` configured, this will be sent. Otherwise the assistant will generate the text to send.) \n4. Updates conversation metadata if provide" }, { "info": { "name": "Clone Assistant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/clone", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ] }, "docs": "Clone an existing assistant, excluding telephony and messaging settings." }, { "info": { "name": "List scheduled events", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "from_date", "value": "", "type": "query" }, { "name": "to_date", "value": "", "type": "query" }, { "name": "conversation_channel", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Get scheduled events for an assistant with pagination and filtering" }, { "info": { "name": "Create a scheduled event", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a scheduled event for an assistant" }, { "info": { "name": "Get a scheduled event", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events/:event_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "event_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a scheduled event by event ID" }, { "info": { "name": "Delete a scheduled event", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events/:event_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "event_id", "value": "", "type": "path" } ] }, "docs": "If the event is pending, this will cancel the event. Otherwise, this will simply remove the record of the event." }, { "info": { "name": "Add Assistant Tag", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tags", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Assistant Tag" }, { "info": { "name": "Remove Assistant Tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tags/:tag", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "tag", "value": "", "type": "path" } ] }, "docs": "Remove Assistant Tag" }, { "info": { "name": "Get assistant texml", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/texml", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ] }, "docs": "Get an assistant texml by `assistant_id`." }, { "info": { "name": "Add Assistant Tool", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tools/:tool_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ] }, "docs": "Add Assistant Tool" }, { "info": { "name": "Remove Assistant Tool", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tools/:tool_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ] }, "docs": "Remove Assistant Tool" }, { "info": { "name": "Test Assistant Tool", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/tools/:tool_id/test", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Test a webhook tool for an assistant" }, { "info": { "name": "Get all versions of an assistant", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions", "params": [ { "name": "assistant_id", "value": "", "type": "path" } ] }, "docs": "Retrieves all versions of a specific assistant with complete configuration and metadata" }, { "info": { "name": "Get a specific assistant version", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions/:version_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" }, { "name": "include_mcp_servers", "value": "", "type": "query" } ] }, "docs": "Retrieves a specific version of an assistant by assistant_id and version_id" }, { "info": { "name": "Update a specific assistant version", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions/:version_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of a specific assistant version. Can not update main version" }, { "info": { "name": "Delete a specific assistant version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions/:version_id", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "Permanently removes a specific version of an assistant. Can not delete main version" }, { "info": { "name": "Promote an assistant version to main", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/assistants/:assistant_id/versions/:version_id/promote", "params": [ { "name": "assistant_id", "value": "", "type": "path" }, { "name": "version_id", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "List Tools", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/tools", "params": [ { "name": "filter[type]", "value": "", "type": "query" }, { "name": "filter[name]", "value": "", "type": "query" }, { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[number]", "value": "", "type": "query" } ] }, "docs": "List Tools" }, { "info": { "name": "Create Tool", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/tools", "body": { "type": "json", "data": "{}" } }, "docs": "Create Tool" }, { "info": { "name": "Get Tool", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/tools/:tool_id", "params": [ { "name": "tool_id", "value": "", "type": "path" } ] }, "docs": "Get Tool" }, { "info": { "name": "Update Tool", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/ai/tools/:tool_id", "params": [ { "name": "tool_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Tool" }, { "info": { "name": "Delete Tool", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/tools/:tool_id", "params": [ { "name": "tool_id", "value": "", "type": "path" } ] }, "docs": "Delete Tool" } ] }, { "info": { "name": "Audio", "type": "folder" }, "items": [ { "info": { "name": "Transcribe speech to text", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/audio/transcriptions", "body": { "type": "multipart-form", "data": [] } }, "docs": "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." } ] }, { "info": { "name": "Chat", "type": "folder" }, "items": [ { "info": { "name": "Create a chat completion", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/chat/completions", "body": { "type": "json", "data": "{}" } }, "docs": "**Deprecated**: Use `POST /v2/ai/openai/chat/completions` instead. 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." }, { "info": { "name": "Get available models", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/models" }, "docs": "**Deprecated**: Use `GET /v2/ai/openai/models` instead. This endpoint returns a list of Open Source and OpenAI models that are available for use.

**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." }, { "info": { "name": "Summarize file content", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/summarize", "body": { "type": "json", "data": "{}" } }, "docs": "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" } ] }, { "info": { "name": "Clusters", "type": "folder" }, "items": [ { "info": { "name": "List all clusters", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/clusters", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all clusters" }, { "info": { "name": "Compute new clusters", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/clusters", "body": { "type": "json", "data": "{}" } }, "docs": "Starts a background task to compute how the data in an [embedded storage bucket](https://developers.telnyx.com/api-reference/embeddings/embed-documents) is clustered. This helps identify common themes and patterns in the data." }, { "info": { "name": "Fetch a cluster", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/clusters/:task_id", "params": [ { "name": "task_id", "value": "", "type": "path" }, { "name": "top_n_nodes", "value": "", "type": "query", "description": "The number of nodes in the cluster to return in the response. Nodes will be sorted by their centrality within the cluster." }, { "name": "show_subclusters", "value": "", "type": "query", "description": "Whether or not to include subclusters and their nodes in the response." } ] }, "docs": "Fetch a cluster" }, { "info": { "name": "Delete a cluster", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/clusters/:task_id", "params": [ { "name": "task_id", "value": "", "type": "path" } ] }, "docs": "Delete a cluster" }, { "info": { "name": "Fetch a cluster visualization", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/clusters/:task_id/graph", "params": [ { "name": "task_id", "value": "", "type": "path" }, { "name": "cluster_id", "value": "", "type": "query" } ] }, "docs": "Fetch a cluster visualization" } ] }, { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "List conversations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/conversations", "params": [ { "name": "id", "value": "", "type": "query", "description": "Filter by conversation ID (e.g. id=eq.123)" }, { "name": "name", "value": "", "type": "query", "description": "Filter by conversation Name (e.g. `name=like.Voice%`)" }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by creation datetime (e.g., `created_at=gte.2025-01-01`)" }, { "name": "last_message_at", "value": "", "type": "query", "description": "Filter by last message datetime (e.g., `last_message_at=lte.2025-06-01`)" }, { "name": "metadata->assistant_id", "value": "", "type": "query", "description": "Filter by assistant ID (e.g., `metadata->assistant_id=eq.assistant-123`)" }, { "name": "metadata->call_control_id", "value": "", "type": "query", "description": "Filter by call control ID (e.g., `metadata->call_control_id=eq.v3:123`)" }, { "name": "metadata->telnyx_agent_target", "value": "", "type": "query", "description": "Filter by the phone number, SIP URI, or other identifier for the agent (e.g., `metadata->telnyx_agent_target=eq.+13128675309`)" }, { "name": "metadata->telnyx_end_user_target", "value": "", "type": "query", "description": "Filter by the phone number, SIP URI, or other identifier for the end user (e.g., `metadata->telnyx_end_user_target=eq.+13128675309`)" }, { "name": "metadata->telnyx_conversation_channel", "value": "", "type": "query", "description": "Filter by conversation channel (e.g., `metadata->telnyx_conversation_channel=eq.phone_call`)" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the number of returned conversations (e.g., `limit=10`)" }, { "name": "order", "value": "", "type": "query", "description": "Order the results by specific fields (e.g., `order=created_at.desc` or `order=last_message_at.asc`)" }, { "name": "or", "value": "", "type": "query", "description": "Apply OR conditions using PostgREST syntax (e.g., `or=(created_at.gte.2025-04-01,last_message_at.gte.2025-04-01)`)" } ] }, "docs": "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`." }, { "info": { "name": "Create a conversation", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/conversations", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new AI Conversation." }, { "info": { "name": "Get Insight Template Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/conversations/insight-groups", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "Get all insight groups" }, { "info": { "name": "Create Insight Template Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/conversations/insight-groups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new insight group" }, { "info": { "name": "Get Insight Template Group", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/conversations/insight-groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the insight group" } ] }, "docs": "Get insight group by ID" }, { "info": { "name": "Update Insight Template Group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/conversations/insight-groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the insight group" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an insight template group" }, { "info": { "name": "Delete Insight Template Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/conversations/insight-groups/:group_id", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the insight group" } ] }, "docs": "Delete insight group by ID" }, { "info": { "name": "Assign Insight Template To Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/conversations/insight-groups/:group_id/insights/:insight_id/assign", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the insight group" }, { "name": "insight_id", "value": "", "type": "path", "description": "The ID of the insight" } ] }, "docs": "Assign an insight to a group" }, { "info": { "name": "Unassign Insight Template From Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/conversations/insight-groups/:group_id/insights/:insight_id/unassign", "params": [ { "name": "group_id", "value": "", "type": "path", "description": "The ID of the insight group" }, { "name": "insight_id", "value": "", "type": "path", "description": "The ID of the insight" } ] }, "docs": "Remove an insight from a group" }, { "info": { "name": "Get Insight Templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/conversations/insights", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "Get all insights" }, { "info": { "name": "Create Insight Template", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/conversations/insights", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new insight" }, { "info": { "name": "Get Insight Template", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/conversations/insights/:insight_id", "params": [ { "name": "insight_id", "value": "", "type": "path", "description": "The ID of the insight" } ] }, "docs": "Get insight by ID" }, { "info": { "name": "Update Insight Template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/conversations/insights/:insight_id", "params": [ { "name": "insight_id", "value": "", "type": "path", "description": "The ID of the insight" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an insight template" }, { "info": { "name": "Delete Insight Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/conversations/insights/:insight_id", "params": [ { "name": "insight_id", "value": "", "type": "path", "description": "The ID of the insight" } ] }, "docs": "Delete insight by ID" }, { "info": { "name": "Get a conversation", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/conversations/:conversation_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation to retrieve" } ] }, "docs": "Retrieve a specific AI conversation by its ID." }, { "info": { "name": "Update conversation metadata", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/conversations/:conversation_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update metadata for a specific conversation." }, { "info": { "name": "Delete a conversation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/conversations/:conversation_id", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation to delete" } ] }, "docs": "Delete a specific conversation by its ID." }, { "info": { "name": "Get insights for a conversation", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/conversations/:conversation_id/conversations-insights", "params": [ { "name": "conversation_id", "value": "", "type": "path" } ] }, "docs": "Retrieve insights for a specific conversation" }, { "info": { "name": "Create Message", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/conversations/:conversation_id/message", "params": [ { "name": "conversation_id", "value": "", "type": "path", "description": "The ID of the conversation" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new message to the conversation. Used to insert a new messages to a conversation manually ( without using chat endpoint )" }, { "info": { "name": "Get conversation messages", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/conversations/:conversation_id/messages", "params": [ { "name": "conversation_id", "value": "", "type": "path" }, { "name": "page[size]", "value": "", "type": "query", "description": "The number of messages to return per page." }, { "name": "page[number]", "value": "", "type": "query", "description": "The page number to retrieve." } ] }, "docs": "Retrieve messages for a specific conversation, including tool calls made by the assistant." } ] }, { "info": { "name": "Embeddings", "type": "folder" }, "items": [ { "info": { "name": "Get Tasks by Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/embeddings", "params": [ { "name": "status", "value": "", "type": "query", "description": "List of task statuses i.e. `status=queued&status=processing`" } ] }, "docs": "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`." }, { "info": { "name": "Embed documents", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/embeddings", "body": { "type": "json", "data": "{}" } }, "docs": "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 *" }, { "info": { "name": "List embedded buckets", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/embeddings/buckets" }, "docs": "Get all embedding buckets for a user." }, { "info": { "name": "Get file-level embedding statuses for a bucket", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/embeddings/buckets/:bucket_name", "params": [ { "name": "bucket_name", "value": "", "type": "path" } ] }, "docs": "Get all embedded files for a given user bucket, including their processing status." }, { "info": { "name": "Disable AI for an Embedded Bucket", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/embeddings/buckets/:bucket_name", "params": [ { "name": "bucket_name", "value": "", "type": "path" } ] }, "docs": "Deletes an entire bucket's embeddings and disables the bucket for AI-use, returning it to normal storage pricing." }, { "info": { "name": "Search for documents", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/embeddings/similarity-search", "body": { "type": "json", "data": "{}" } }, "docs": "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 distanc" }, { "info": { "name": "Embed URL content", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/embeddings/url", "body": { "type": "json", "data": "{}" } }, "docs": "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-reference/embeddings/search-for-documents) and [clustering](https://developers.telnyx.com/docs/inferen" }, { "info": { "name": "Get an embedding task's status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/embeddings/:task_id", "params": [ { "name": "task_id", "value": "", "type": "path" } ] }, "docs": "Check the status of a current embedding task. Will be one of the following:\n- `queued` - Task is waiting to be picked up by a worker\n- `processing` - The embedding task is running\n- `success` - Task completed successfully and the bucket is embedded\n- `failure` - Task failed and no files were embedded successfully\n- `partial_success` - Some files were embedded successfully, but at least one failed" } ] }, { "info": { "name": "Fine Tuning", "type": "folder" }, "items": [ { "info": { "name": "List fine tuning jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/fine_tuning/jobs" }, "docs": "Retrieve a list of all fine tuning jobs created by the user." }, { "info": { "name": "Create a fine tuning job", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/fine_tuning/jobs", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new fine tuning job." }, { "info": { "name": "Get a fine tuning job", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/fine_tuning/jobs/:job_id", "params": [ { "name": "job_id", "value": "", "type": "path" } ] }, "docs": "Retrieve a fine tuning job by `job_id`." }, { "info": { "name": "Cancel a fine tuning job", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/fine_tuning/jobs/:job_id/cancel", "params": [ { "name": "job_id", "value": "", "type": "path" } ] }, "docs": "Cancel a fine tuning job." } ] }, { "info": { "name": "Integrations", "type": "folder" }, "items": [ { "info": { "name": "List Integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/integrations" }, "docs": "List all available integrations." }, { "info": { "name": "List User Integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/integrations/connections" }, "docs": "List user setup integrations" }, { "info": { "name": "Get User Integration connection By Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/integrations/connections/:user_connection_id", "params": [ { "name": "user_connection_id", "value": "", "type": "path", "description": "The connection id" } ] }, "docs": "Get user setup integrations" }, { "info": { "name": "Delete Integration Connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/integrations/connections/:user_connection_id", "params": [ { "name": "user_connection_id", "value": "", "type": "path", "description": "The user integration connection identifier" } ] }, "docs": "Delete a specific integration connection." }, { "info": { "name": "List Integration By Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/integrations/:integration_id", "params": [ { "name": "integration_id", "value": "", "type": "path", "description": "The integration id" } ] }, "docs": "Retrieve integration details" } ] }, { "info": { "name": "MCP Servers", "type": "folder" }, "items": [ { "info": { "name": "List MCP Servers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/mcp_servers", "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "url", "value": "", "type": "query" }, { "name": "page[size]", "value": "", "type": "query" }, { "name": "page[number]", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of MCP servers." }, { "info": { "name": "Create MCP Server", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/mcp_servers", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new MCP server." }, { "info": { "name": "Get MCP Server", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/mcp_servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path" } ] }, "docs": "Retrieve details for a specific MCP server." }, { "info": { "name": "Update MCP Server", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/mcp_servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing MCP server." }, { "info": { "name": "Delete MCP Server", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/mcp_servers/:mcp_server_id", "params": [ { "name": "mcp_server_id", "value": "", "type": "path" } ] }, "docs": "Delete a specific MCP server." } ] }, { "info": { "name": "Missions", "type": "folder" }, "items": [ { "info": { "name": "List missions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-based)" }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "List all missions for the organization" }, { "info": { "name": "Create mission", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new mission definition" }, { "info": { "name": "List recent events", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/events", "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-based)" }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "List recent events across all missions" }, { "info": { "name": "List recent runs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/runs", "params": [ { "name": "status", "value": "", "type": "query" }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-based)" }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "List recent runs across all missions" }, { "info": { "name": "Get mission", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "Get a mission by ID (includes tools, knowledge_bases, mcp_servers)" }, { "info": { "name": "Update mission", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id", "params": [ { "name": "mission_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a mission definition" }, { "info": { "name": "Delete mission", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "Delete a mission" }, { "info": { "name": "Clone mission", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/clone", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "Clone an existing mission" }, { "info": { "name": "List knowledge bases", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/knowledge-bases", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "List all knowledge bases for a mission" }, { "info": { "name": "Create knowledge base", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/knowledge-bases", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "Create a new knowledge base for a mission" }, { "info": { "name": "Get knowledge base", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/knowledge-bases/:knowledge_base_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "knowledge_base_id", "value": "", "type": "path" } ] }, "docs": "Get a specific knowledge base by ID" }, { "info": { "name": "Update knowledge base", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/knowledge-bases/:knowledge_base_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "knowledge_base_id", "value": "", "type": "path" } ] }, "docs": "Update a knowledge base definition" }, { "info": { "name": "Delete knowledge base", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/knowledge-bases/:knowledge_base_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "knowledge_base_id", "value": "", "type": "path" } ] }, "docs": "Delete a knowledge base from a mission" }, { "info": { "name": "List MCP servers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/mcp-servers", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "List all MCP servers for a mission" }, { "info": { "name": "Create MCP server", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/mcp-servers", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "Create a new MCP server for a mission" }, { "info": { "name": "Get MCP server", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/mcp-servers/:mcp_server_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "mcp_server_id", "value": "", "type": "path" } ] }, "docs": "Get a specific MCP server by ID" }, { "info": { "name": "Update MCP server", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/mcp-servers/:mcp_server_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "mcp_server_id", "value": "", "type": "path" } ] }, "docs": "Update an MCP server definition" }, { "info": { "name": "Delete MCP server", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/mcp-servers/:mcp_server_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "mcp_server_id", "value": "", "type": "path" } ] }, "docs": "Delete an MCP server from a mission" }, { "info": { "name": "List runs for mission", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query" }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-based)" }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "List all runs for a specific mission" }, { "info": { "name": "Start a run", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs", "params": [ { "name": "mission_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start a new run for a mission" }, { "info": { "name": "Get run details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ] }, "docs": "Get details of a specific run" }, { "info": { "name": "Update run", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update run status and/or result" }, { "info": { "name": "Cancel run", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/cancel", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ] }, "docs": "Cancel a running or paused run" }, { "info": { "name": "List events", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/events", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" }, { "name": "step_id", "value": "", "type": "query" }, { "name": "agent_id", "value": "", "type": "query" }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-based)" }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of items per page" } ] }, "docs": "List events for a run (paginated)" }, { "info": { "name": "Log event", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/events", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Log an event for a run" }, { "info": { "name": "Get event details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/events/:event_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" }, { "name": "event_id", "value": "", "type": "path" } ] }, "docs": "Get details of a specific event" }, { "info": { "name": "Pause run", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/pause", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ] }, "docs": "Pause a running run" }, { "info": { "name": "Get plan", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/plan", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ] }, "docs": "Get the plan (all steps) for a run" }, { "info": { "name": "Create initial plan", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/plan", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create the initial plan for a run" }, { "info": { "name": "Add step(s) to plan", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/plan/steps", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add one or more steps to an existing plan" }, { "info": { "name": "Get step details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/plan/steps/:step_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" }, { "name": "step_id", "value": "", "type": "path" } ] }, "docs": "Get details of a specific plan step" }, { "info": { "name": "Update step status", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/plan/steps/:step_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" }, { "name": "step_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the status of a plan step" }, { "info": { "name": "Resume run", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/resume", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ] }, "docs": "Resume a paused run" }, { "info": { "name": "List linked Telnyx agents", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/telnyx-agents", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ] }, "docs": "List all Telnyx agents linked to a run" }, { "info": { "name": "Link Telnyx agent to run", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/telnyx-agents", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Link a Telnyx AI agent (voice/messaging) to a run" }, { "info": { "name": "Unlink Telnyx agent", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/runs/:run_id/telnyx-agents/:telnyx_agent_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "run_id", "value": "", "type": "path" }, { "name": "telnyx_agent_id", "value": "", "type": "path" } ] }, "docs": "Unlink a Telnyx agent from a run" }, { "info": { "name": "List tools", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/tools", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "List all tools for a mission" }, { "info": { "name": "Create tool", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/tools", "params": [ { "name": "mission_id", "value": "", "type": "path" } ] }, "docs": "Create a new tool for a mission" }, { "info": { "name": "Get tool", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/tools/:tool_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ] }, "docs": "Get a specific tool by ID" }, { "info": { "name": "Update tool", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/tools/:tool_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ] }, "docs": "Update a tool definition" }, { "info": { "name": "Delete tool", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ai/missions/:mission_id/tools/:tool_id", "params": [ { "name": "mission_id", "value": "", "type": "path" }, { "name": "tool_id", "value": "", "type": "path" } ] }, "docs": "Delete a tool from a mission" } ] }, { "info": { "name": "OpenAI Chat", "type": "folder" }, "items": [ { "info": { "name": "Create a chat completion (OpenAI-compatible)", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/openai/chat/completions", "body": { "type": "json", "data": "{}" } }, "docs": "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 by setting the base URL to `https://api.telnyx.com/v2/ai/openai`." }, { "info": { "name": "Get available models (OpenAI-compatible)", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/openai/models" }, "docs": "This endpoint returns a list of Open Source and OpenAI models that are available for use.

**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." } ] }, { "info": { "name": "OpenAI Embeddings", "type": "folder" }, "items": [ { "info": { "name": "Create embeddings", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ai/openai/embeddings", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an embedding vector representing the input text. This endpoint is compatible with the [OpenAI Embeddings API](https://platform.openai.com/docs/api-reference/embeddings) and may be used with the OpenAI JS or Python SDK by setting the base URL to `https://api.telnyx.com/v2/ai/openai`." }, { "info": { "name": "List embedding models", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ai/openai/embeddings/models" }, "docs": "Returns a list of available embedding models. This endpoint is compatible with the OpenAI Models API format." } ] }, { "info": { "name": "Messaging", "type": "folder" }, "items": [ { "info": { "name": "List alphanumeric sender IDs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/alphanumeric_sender_ids", "params": [ { "name": "filter[messaging_profile_id]", "value": "", "type": "query", "description": "Filter by messaging profile ID." }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number." }, { "name": "page[size]", "value": "", "type": "query", "description": "Page size." } ] }, "docs": "List all alphanumeric sender IDs for the authenticated user." }, { "info": { "name": "Create an alphanumeric sender ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/alphanumeric_sender_ids", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new alphanumeric sender ID associated with a messaging profile." }, { "info": { "name": "Retrieve an alphanumeric sender ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/alphanumeric_sender_ids/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the alphanumeric sender ID." } ] }, "docs": "Retrieve a specific alphanumeric sender ID." }, { "info": { "name": "Delete an alphanumeric sender ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/alphanumeric_sender_ids/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the alphanumeric sender ID." } ] }, "docs": "Delete an alphanumeric sender ID and disassociate it from its messaging profile." }, { "info": { "name": "List messaging hosted numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_hosted_numbers", "params": [ { "name": "filter[messaging_profile_id]", "value": "", "type": "query", "description": "Filter by messaging profile ID." }, { "name": "filter[phone_number]", "value": "", "type": "query", "description": "Filter by exact phone number." }, { "name": "filter[phone_number][contains]", "value": "", "type": "query", "description": "Filter by phone number substring." }, { "name": "sort[phone_number]", "value": "", "type": "query", "description": "Sort by phone number." }, { "name": "page[number]", "value": "", "type": "query" }, { "name": "page[size]", "value": "", "type": "query" } ] }, "docs": "List all hosted numbers associated with the authenticated user." }, { "info": { "name": "Retrieve a messaging hosted number", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_hosted_numbers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or phone number of the hosted number." } ] }, "docs": "Retrieve a specific messaging hosted number by its ID or phone number." }, { "info": { "name": "Update a messaging hosted number", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/messaging_hosted_numbers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID or phone number of the hosted number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the messaging settings for a hosted number." }, { "info": { "name": "List high-level messaging profile metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profile_metrics", "params": [ { "name": "time_frame", "value": "", "type": "query", "description": "The time frame for metrics." } ] }, "docs": "List high-level metrics for all messaging profiles belonging to the authenticated user." }, { "info": { "name": "Regenerate messaging profile secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_profiles/:id/actions/regenerate_secret", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the messaging profile." } ] }, "docs": "Regenerate the v1 secret for a messaging profile." }, { "info": { "name": "List alphanumeric sender IDs for a messaging profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profiles/:id/alphanumeric_sender_ids", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the messaging profile." }, { "name": "page[number]", "value": "", "type": "query" }, { "name": "page[size]", "value": "", "type": "query" } ] }, "docs": "List all alphanumeric sender IDs associated with a specific messaging profile." }, { "info": { "name": "Get detailed messaging profile metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profiles/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "The identifier of the messaging profile." }, { "name": "time_frame", "value": "", "type": "query", "description": "The time frame for metrics." } ] }, "docs": "Get detailed metrics for a specific messaging profile, broken down by time interval." } ] }, { "info": { "name": "Audit Logs", "type": "folder" }, "items": [ { "info": { "name": "List Audit Logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/audit_events", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[created_before], filter[created_after]" }, { "name": "sort", "value": "", "type": "query", "description": "Set the order of the results by the creation date." } ] }, "docs": "Retrieve a list of audit log entries. Audit logs are a best-effort, eventually consistent record of significant account-related changes." } ] }, { "info": { "name": "Authentication Providers", "type": "folder" }, "items": [ { "info": { "name": "List all SSO authentication providers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/authentication_providers", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "Returns a list of your SSO authentication providers." }, { "info": { "name": "Creates an authentication provider", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/authentication_providers", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an authentication provider." }, { "info": { "name": "Retrieve an authentication provider", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/authentication_providers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "authentication provider ID" } ] }, "docs": "Retrieves the details of an existing authentication provider." }, { "info": { "name": "Update an authentication provider", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/authentication_providers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing authentication provider." }, { "info": { "name": "Deletes an authentication provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/authentication_providers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "authentication provider ID" } ] }, "docs": "Deletes an existing authentication provider." } ] }, { "info": { "name": "Phone Number Search", "type": "folder" }, "items": [ { "info": { "name": "List available phone number blocks", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/available_phone_number_blocks", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[locality], filter[country_code], filter[national_destination_code], filter[phone_number_type]" } ] }, "docs": "List available phone number blocks" }, { "info": { "name": "List available phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/available_phone_numbers", "params": [ { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "List available phone numbers" } ] }, { "info": { "name": "Billing", "type": "folder" }, "items": [ { "info": { "name": "Get user balance details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/balance" }, "docs": "Get user balance details" } ] }, { "info": { "name": "Billing Groups", "type": "folder" }, "items": [ { "info": { "name": "List all billing groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/billing_groups", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all billing groups" }, { "info": { "name": "Create a billing group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/billing_groups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a billing group" }, { "info": { "name": "Get a billing group", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/billing_groups/:id", "params": [ { "name": "id", "value": "f5586561-8ff0-4291-a0ac-84fe544797bd", "type": "path", "description": "The id of the billing group" } ] }, "docs": "Get a billing group" }, { "info": { "name": "Update a billing group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/billing_groups/:id", "params": [ { "name": "id", "value": "f5586561-8ff0-4291-a0ac-84fe544797bd", "type": "path", "description": "The id of the billing group" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a billing group" }, { "info": { "name": "Delete a billing group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/billing_groups/:id", "params": [ { "name": "id", "value": "f5586561-8ff0-4291-a0ac-84fe544797bd", "type": "path", "description": "The id of the billing group" } ] }, "docs": "Delete a billing group" } ] }, { "info": { "name": "SIM Card Actions", "type": "folder" }, "items": [ { "info": { "name": "List bulk SIM card actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/bulk_sim_card_actions", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "filter[action_type]", "value": "", "type": "query", "description": "Filter by action type." } ] }, "docs": "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." }, { "info": { "name": "Get bulk SIM card action details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/bulk_sim_card_actions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "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." }, { "info": { "name": "List SIM card actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_actions", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters." }, { "info": { "name": "Get SIM card action details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_actions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation." } ] }, { "info": { "name": "Bundles", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Bundles", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/bundle_pricing/billing_bundles", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Supports filtering by country_iso and resource. Examples: filter[country_iso]=US or filter[resource]=+15617819942" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Get all allowed bundles." }, { "info": { "name": "Get Bundle By Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/bundle_pricing/billing_bundles/:bundle_id", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "bundle_id", "value": "", "type": "path" } ] }, "docs": "Get a single bundle by ID." } ] }, { "info": { "name": "User Bundles", "type": "folder" }, "items": [ { "info": { "name": "Get User Bundles", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/bundle_pricing/user_bundles", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Supports filtering by country_iso and resource. Examples: filter[country_iso]=US or filter[resource]=+15617819942" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Get a paginated list of user bundles." }, { "info": { "name": "Create User Bundles", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/bundle_pricing/user_bundles/bulk", "headers": [ { "name": "authorization_bearer", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates multiple user bundles for the user." }, { "info": { "name": "Get Unused User Bundles", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/bundle_pricing/user_bundles/unused", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Supports filtering by country_iso and resource. Examples: filter[country_iso]=US or filter[resource]=+15617819942" } ] }, "docs": "Returns all user bundles that aren't in use." }, { "info": { "name": "Get User Bundle by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/bundle_pricing/user_bundles/:user_bundle_id", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "user_bundle_id", "value": "", "type": "path" } ] }, "docs": "Retrieves a user bundle by its ID." }, { "info": { "name": "Deactivate User Bundle", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/bundle_pricing/user_bundles/:user_bundle_id", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "user_bundle_id", "value": "", "type": "path" } ] }, "docs": "Deactivates a user bundle by its ID." }, { "info": { "name": "Get User Bundle Resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/bundle_pricing/user_bundles/:user_bundle_id/resources", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "user_bundle_id", "value": "", "type": "path" } ] }, "docs": "Retrieves the resources of a user bundle by its ID." } ] }, { "info": { "name": "Call Control Applications", "type": "folder" }, "items": [ { "info": { "name": "List call control applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/call_control_applications", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." } ] }, "docs": "Return a list of call control applications." }, { "info": { "name": "Create a call control application", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/call_control_applications", "body": { "type": "json", "data": "{}" } }, "docs": "Create a call control application." }, { "info": { "name": "Retrieve a call control application", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/call_control_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieves the details of an existing call control application." }, { "info": { "name": "Update a call control application", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/call_control_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing call control application." }, { "info": { "name": "Delete a call control application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/call_control_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Deletes a call control application." } ] }, { "info": { "name": "Debugging", "type": "folder" }, "items": [ { "info": { "name": "List call events", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/call_events", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]" } ] }, "docs": "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.\n\n**Note**: Only one `filter[occurred_at]` can be passed.\n" } ] }, { "info": { "name": "Call Commands", "type": "folder" }, "items": [ { "info": { "name": "Dial", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls", "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\n**Expected Webhooks:**\n\n- `call.initiated`\n- `call.answered` or `call.hangup`\n- `call.hold` and `call.unhold` if the call is held/unheld\n- `call.machine.detection.ended` if `answering_machine_detection` was requested\n- `call.machine.greeting.ended` if `answering_machine_detection` was requested to detect the end of machine gree" }, { "info": { "name": "Add messages to AI Assistant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/ai_assistant_add_messages", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add messages to the conversation started by an AI assistant on the call." }, { "info": { "name": "Join AI Assistant Conversation", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/ai_assistant_join", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a participant to an existing AI assistant conversation. Use this command to bring an additional call leg into a running AI conversation." }, { "info": { "name": "Start AI Assistant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/ai_assistant_start", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start an AI assistant on the call.\n\n**Expected Webhooks:**\n\n- `call.conversation.ended`\n- `call.conversation_insights.generated`\n" }, { "info": { "name": "Stop AI Assistant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/ai_assistant_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop an AI assistant on the call." }, { "info": { "name": "Answer call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/answer", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Answer an incoming call. You must issue this command before executing subsequent commands on an incoming call.\n\n**Expected Webhooks:**\n\n- `call.answered`\n- `call.hold` and `call.unhold` if the call is held/unheld\n- `call.deepfake_detection.result` if `deepfake_detection` was enabled\n- `call.deepfake_detection.error` if `deepfake_detection` was enabled and an error occurred\n- `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url` was set\n\nWhen the `record` parameter is set" }, { "info": { "name": "Bridge calls", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/bridge", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bridge two call control calls.\n\n**Expected Webhooks:**\n\n- `call.bridged` for Leg A\n- `call.bridged` for Leg B\n" }, { "info": { "name": "Update client state", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/client_state_update", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates client state" }, { "info": { "name": "Enqueue call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/enqueue", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Put the call in a queue." }, { "info": { "name": "Forking start", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/fork_start", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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:**\n\n- `call.fork.started`\n- `call.fork.stopped`\n\n" }, { "info": { "name": "Forking stop", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/fork_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop forking a call.\n\n**Expected Webhooks:**\n\n- `call.fork.stopped`\n" }, { "info": { "name": "Gather", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/gather", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gather DTMF signals to build interactive menus.\n\nYou can pass a list of valid digits. The `Answer` command must be issued before the `gather` command.\n\n**Expected Webhooks:**\n\n- `call.dtmf.received` (you may receive many of these webhooks)\n- `call.gather.ended`\n" }, { "info": { "name": "Gather stop", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/gather_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop current gather.\n\n**Expected Webhooks:**\n\n- `call.gather.ended`\n" }, { "info": { "name": "Gather using AI", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/gather_using_ai", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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:**\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" }, { "info": { "name": "Gather using audio", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/gather_using_audio", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Play an audio file on the call until the required DTMF signals are gathered to build interactive menus.\n\nYou 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.\n\n**Expected Webhooks:**\n\n- `call.playback.started`\n- `call.playback.ended`\n- `call.dtmf.received` (you may receive many of these" }, { "info": { "name": "Gather using speak", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/gather_using_speak", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Convert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus.\n\nYou 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.\n\n**Expected Webhooks:**\n\n- `call.dtmf.received` (you may receive many of these webhooks)\n- `call.gather.ended`\n" }, { "info": { "name": "Hangup call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/hangup", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Hang up the call.\n\n**Expected Webhooks:**\n\n- `call.hangup`\n- `call.recording.saved`\n" }, { "info": { "name": "Remove call from a queue", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/leave_queue", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the call from a queue." }, { "info": { "name": "Play audio URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/playback_start", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Play an audio file on the call. If multiple play audio commands are issued consecutively,\nthe audio files will be placed in a queue awaiting playback.\n\n*Notes:*\n\n- When `overlay` is enabled, `target_legs` is limited to `self`.\n- A customer cannot Play Audio with `overlay=true` unless there is a Play Audio with `overlay=false` actively playing.\n\n**Expected Webhooks:**\n\n- `call.playback.started`\n- `call.playback.ended`\n" }, { "info": { "name": "Stop audio playback", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/playback_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop audio being played on the call.\n\n**Expected Webhooks:**\n\n- `call.playback.ended` or `call.speak.ended`\n" }, { "info": { "name": "Record pause", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/record_pause", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pause recording the call. Recording can be resumed via Resume recording command.\n\n**Expected Webhooks:**\n\nThere are no webhooks associated with this command.\n" }, { "info": { "name": "Record resume", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/record_resume", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume recording the call.\n\n**Expected Webhooks:**\n\nThere are no webhooks associated with this command.\n" }, { "info": { "name": "Recording start", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/record_start", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start recording the call. Recording will stop on call hang-up, or can be initiated via the Stop Recording command.\n\n**Expected Webhooks:**\n\n- `call.recording.saved`\n- `call.recording.transcription.saved`\n- `call.recording.error`\n" }, { "info": { "name": "Recording stop", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/record_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop recording the call.\n\n**Expected Webhooks:**\n\n- `call.recording.saved`\n" }, { "info": { "name": "SIP Refer a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/refer", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate a SIP Refer on a Call Control call. You can initiate a SIP Refer at any point in the duration of a call.\n\n**Expected Webhooks:**\n\n- `call.refer.started`\n- `call.refer.completed`\n- `call.refer.failed`\n" }, { "info": { "name": "Reject a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/reject", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reject an incoming call.\n\n**Expected Webhooks:**\n\n- `call.hangup`\n" }, { "info": { "name": "Send DTMF", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/send_dtmf", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends DTMF tones from this leg. DTMF tones will be heard by the other end of the call.\n\n**Expected Webhooks:**\n\nThere are no webhooks associated with this command.\n" }, { "info": { "name": "Send SIP info", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/send_sip_info", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends SIP info from this leg.\n\n**Expected Webhooks:**\n\n- `call.sip_info.received` (to be received on the target call leg)\n" }, { "info": { "name": "SIPREC start", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/siprec_start", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start siprec session to configured in SIPREC connector SRS. \n\n**Expected Webhooks:**\n\n- `siprec.started`\n- `siprec.stopped`\n- `siprec.failed`\n" }, { "info": { "name": "SIPREC stop", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/siprec_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop SIPREC session.\n\n**Expected Webhooks:**\n\n- `siprec.stopped`\n" }, { "info": { "name": "Speak text", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/speak", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\n**Expected Webhooks:**\n\n- `call.speak.started`\n- `call.speak.ended`\n" }, { "info": { "name": "Streaming start", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/streaming_start", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nPlease find more details about media streaming messages specification under the [link](https://developers.telnyx.com/docs/voice/programmable-voice/media-streaming)." }, { "info": { "name": "Streaming stop", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/streaming_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop streaming a call to a WebSocket.\n\n**Expected Webhooks:**\n\n- `streaming.stopped`\n" }, { "info": { "name": "Noise Suppression Start (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/suppression_start", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Noise Suppression Start (BETA)" }, { "info": { "name": "Noise Suppression Stop (BETA)", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/suppression_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Noise Suppression Stop (BETA)" }, { "info": { "name": "Switch supervisor role", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/switch_supervisor_role", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Switch the supervisor role for a bridged call. This allows switching between different supervisor modes during an active call" }, { "info": { "name": "Transcription start", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/transcription_start", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command.\n\n**Expected Webhooks:**\n\n- `call.transcription`\n" }, { "info": { "name": "Transcription stop", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/transcription_stop", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop real-time transcription." }, { "info": { "name": "Transfer call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/calls/:call_control_id/actions/transfer", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\n**Expected Webhooks:**\n\n- `call.initiated`\n- `call.bridged` to Leg B\n- `call.answered` or `call.hangup`\n- `call.machine.detection.ended` if `answering_machine_detection` was" } ] }, { "info": { "name": "Call Information", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a call status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/calls/:call_control_id", "params": [ { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ] }, "docs": "Returns the status of a call (data is available 10 minutes after call ended)." }, { "info": { "name": "List all active calls for given connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/connections/:connection_id/active_calls", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Telnyx connection id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]" } ] }, "docs": "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.\n" } ] }, { "info": { "name": "Voice Channels", "type": "folder" }, "items": [ { "info": { "name": "List your voice channels for non-US zones", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/channel_zones", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "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 Telnyx Support Articles section for full information and examples of how to utilize Channel Billing." }, { "info": { "name": "Update voice channels for non-US Zones", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/channel_zones/:channel_zone_id", "params": [ { "name": "channel_zone_id", "value": "", "type": "path", "description": "Channel zone identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "List your voice channels for US Zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/inbound_channels" }, "docs": "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 Telnyx Support Articles section for full information and examples of how to utilize Channel Billing." }, { "info": { "name": "Update voice channels for US Zone", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/inbound_channels", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "List All Numbers using Channel Billing", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/list" }, "docs": "Retrieve a list of all phone numbers using Channel Billing, grouped by Zone." }, { "info": { "name": "List Numbers using Channel Billing for a specific Zone", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/list/:channel_zone_id", "params": [ { "name": "channel_zone_id", "value": "", "type": "path", "description": "Channel zone identifier" } ] }, "docs": "Retrieve a list of phone numbers using Channel Billing for a specific Zone." } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "Get monthly charges breakdown", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/charges_breakdown", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date for the charges breakdown in ISO date format (YYYY-MM-DD)" }, { "name": "end_date", "value": "", "type": "query", "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." }, { "name": "format", "value": "", "type": "query", "description": "Response format" } ] }, "docs": "Retrieve a detailed breakdown of monthly charges for phone numbers in a specified date range. The date range cannot exceed 31 days." }, { "info": { "name": "Get monthly charges summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/charges_summary", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date for the charges summary in ISO date format (YYYY-MM-DD)" }, { "name": "end_date", "value": "", "type": "query", "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." } ] }, "docs": "Retrieve a summary of monthly charges for a specified date range. The date range cannot exceed 31 days." }, { "info": { "name": "List invoices", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/invoices", "params": [ { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "Retrieve a paginated list of invoices." }, { "info": { "name": "Get invoice by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/invoices/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Invoice UUID" }, { "name": "action", "value": "", "type": "query", "description": "Invoice action" } ] }, "docs": "Retrieve a single invoice by its unique identifier." } ] }, { "info": { "name": "Phone Number Orders", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all comments", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/comments", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[comment_record_type], filter[comment_record_id]" } ] }, "docs": "Retrieve all comments" }, { "info": { "name": "Create a comment", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/comments", "body": { "type": "json", "data": "{}" } }, "docs": "Create a comment" }, { "info": { "name": "Retrieve a comment", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/comments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The comment ID." } ] }, "docs": "Retrieve a comment" }, { "info": { "name": "Mark a comment as read", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/comments/:id/read", "params": [ { "name": "id", "value": "", "type": "path", "description": "The comment ID." } ] }, "docs": "Mark a comment as read" }, { "info": { "name": "Retrieve a list of phone numbers associated to orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_order_phone_numbers", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[country_code]" } ] }, "docs": "Get a list of phone numbers associated to orders." }, { "info": { "name": "Retrieve a single phone number within a number order.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_order_phone_numbers/:number_order_phone_number_id", "params": [ { "name": "number_order_phone_number_id", "value": "", "type": "path", "description": "The number order phone number ID." } ] }, "docs": "Get an existing phone number in number order." }, { "info": { "name": "Update requirements for a single phone number within a number order.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/number_order_phone_numbers/:number_order_phone_number_id", "params": [ { "name": "number_order_phone_number_id", "value": "", "type": "path", "description": "The number order phone number ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates requirements for a single phone number within a number order." }, { "info": { "name": "List number orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_orders", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers_count], filter[customer_reference], filter[requirements_met]" } ] }, "docs": "Get a paginated list of number orders." }, { "info": { "name": "Create a number order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/number_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a phone number order." }, { "info": { "name": "Retrieve a number order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_orders/:number_order_id", "params": [ { "name": "number_order_id", "value": "", "type": "path", "description": "The number order ID." } ] }, "docs": "Get an existing phone number order." }, { "info": { "name": "Update a number order", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/number_orders/:number_order_id", "params": [ { "name": "number_order_id", "value": "", "type": "path", "description": "The number order ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a phone number order." }, { "info": { "name": "List sub number orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sub_number_orders", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[status], filter[order_request_id], filter[country_code], filter[phone_number_type], filter[phone_numbers_count]" } ] }, "docs": "Get a paginated list of sub number orders." }, { "info": { "name": "Retrieve a sub number order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sub_number_orders/:sub_number_order_id", "params": [ { "name": "sub_number_order_id", "value": "", "type": "path", "description": "The sub number order ID." }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[include_phone_numbers]" } ] }, "docs": "Get an existing sub number order." }, { "info": { "name": "Update a sub number order's requirements", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/sub_number_orders/:sub_number_order_id", "params": [ { "name": "sub_number_order_id", "value": "", "type": "path", "description": "The sub number order ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a sub number order." }, { "info": { "name": "Cancel a sub number order", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/sub_number_orders/:sub_number_order_id/cancel", "params": [ { "name": "sub_number_order_id", "value": "", "type": "path", "description": "The ID of the sub number order." } ] }, "docs": "Allows you to cancel a sub number order in 'pending' status." }, { "info": { "name": "Create a sub number orders report", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sub_number_orders_report", "body": { "type": "json", "data": "{}" } }, "docs": "Create a CSV report for sub number orders. The report will be generated asynchronously and can be downloaded once complete." }, { "info": { "name": "Retrieve a sub number orders report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sub_number_orders_report/:report_id", "params": [ { "name": "report_id", "value": "12ade33a-21c0-473b-b055-b3c836e1c293", "type": "path", "description": "The unique identifier of the sub number orders report" } ] }, "docs": "Get the status and details of a sub number orders report." }, { "info": { "name": "Download a sub number orders report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sub_number_orders_report/:report_id/download", "params": [ { "name": "report_id", "value": "12ade33a-21c0-473b-b055-b3c836e1c293", "type": "path", "description": "The unique identifier of the sub number orders report" } ] }, "docs": "Download the CSV file for a completed sub number orders report. The report status must be 'success' before the file can be downloaded." } ] }, { "info": { "name": "Conference Commands", "type": "folder" }, "items": [ { "info": { "name": "List conferences", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/conferences", "params": [ { "name": "region", "value": "", "type": "query", "description": "Region where the conference data is located" }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]" } ] }, "docs": "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`." }, { "info": { "name": "Create conference", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences", "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\n**Expected Webhooks:**\n\n- `conference.created`\n- `conference.participant.joined`\n- `conference.participant.left`\n- `conference.ended`\n- `conference.recording.saved`\n- `conference" }, { "info": { "name": "List conference participants", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/conferences/:conference_id/participants", "params": [ { "name": "conference_id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id" }, { "name": "region", "value": "", "type": "query", "description": "Region where the conference data is located" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[muted], filter[on_hold], filter[whispering]" } ] }, "docs": "Lists conference participants" }, { "info": { "name": "Retrieve a conference", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/conferences/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id" }, { "name": "region", "value": "", "type": "query", "description": "Region where the conference data is located" } ] }, "docs": "Retrieve an existing conference" }, { "info": { "name": "End a conference", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/end", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference." } ], "body": { "type": "json", "data": "{}" } }, "docs": "End a conference and terminate all active participants." }, { "info": { "name": "Gather DTMF using audio prompt in a conference", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/gather_using_audio", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Play an audio file to a specific conference participant and gather DTMF input." }, { "info": { "name": "Hold conference participants", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/hold", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Hold a list of participants in a conference call" }, { "info": { "name": "Join a conference", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/join", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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:**\n\n- `conference.participant.joined`\n- `conference.participant.left`\n" }, { "info": { "name": "Leave a conference", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/leave", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a call leg from a conference and moves it back to parked state. \n\n**Expected Webhooks:**\n\n- `conference.participant.left`\n" }, { "info": { "name": "Mute conference participants", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/mute", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mute a list of participants in a conference call" }, { "info": { "name": "Play audio to conference participants", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/play", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Play audio to all or some participants on a conference call." }, { "info": { "name": "Conference recording pause", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/record_pause", "params": [ { "name": "id", "value": "", "type": "path", "description": "Specifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pause conference recording." }, { "info": { "name": "Conference recording resume", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/record_resume", "params": [ { "name": "id", "value": "", "type": "path", "description": "Specifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume conference recording." }, { "info": { "name": "Conference recording start", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/record_start", "params": [ { "name": "id", "value": "", "type": "path", "description": "Specifies the conference to record by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start recording the conference. Recording will stop on conference end, or via the Stop Recording command.\n\n**Expected Webhooks:**\n\n- `conference.recording.saved`" }, { "info": { "name": "Conference recording stop", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/record_stop", "params": [ { "name": "id", "value": "", "type": "path", "description": "Specifies the conference to stop the recording for by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop recording the conference.\n\n**Expected Webhooks:**\n\n- `conference.recording.saved`\n" }, { "info": { "name": "Send DTMF to conference participants", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/send_dtmf", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send DTMF tones to one or more conference participants." }, { "info": { "name": "Speak text to conference participants", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/speak", "params": [ { "name": "id", "value": "", "type": "path", "description": "Specifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Convert text to speech and play it to all or some participants." }, { "info": { "name": "Stop audio being played on the conference", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/stop", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop audio being played to all or some participants on a conference call." }, { "info": { "name": "Unhold conference participants", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/unhold", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unhold a list of participants in a conference call" }, { "info": { "name": "Unmute conference participants", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/unmute", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unmute a list of participants in a conference call" }, { "info": { "name": "Update conference participant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/conferences/:id/actions/update", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference by id or name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update conference participant supervisor_role" }, { "info": { "name": "Retrieve a conference participant", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/conferences/:id/participants/:participant_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference." }, { "name": "participant_id", "value": "", "type": "path", "description": "Uniquely identifies the participant by their ID or label." } ] }, "docs": "Retrieve details of a specific conference participant by their ID or label." }, { "info": { "name": "Update a conference participant", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/conferences/:id/participants/:participant_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the conference." }, { "name": "participant_id", "value": "", "type": "path", "description": "Uniquely identifies the participant." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update properties of a conference participant." } ] }, { "info": { "name": "Connections", "type": "folder" }, "items": [ { "info": { "name": "List connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/connections", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." } ] }, "docs": "Returns a list of your connections irrespective of type." }, { "info": { "name": "Retrieve a connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "IP Connection ID" } ] }, "docs": "Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type." } ] }, { "info": { "name": "Country Coverage", "type": "folder" }, "items": [ { "info": { "name": "Get country coverage", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/country_coverage" }, "docs": "Get country coverage" }, { "info": { "name": "Get coverage for a specific country", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/country_coverage/countries/:country_code", "params": [ { "name": "country_code", "value": "", "type": "path", "description": "Country ISO code." } ] }, "docs": "Get coverage for a specific country" } ] }, { "info": { "name": "Credential Connections", "type": "folder" }, "items": [ { "info": { "name": "List credential connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/credential_connections", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." } ] }, "docs": "Returns a list of your credential connections." }, { "info": { "name": "Create a credential connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/credential_connections", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a credential connection." }, { "info": { "name": "Retrieve a credential connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/credential_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieves the details of an existing credential connection." }, { "info": { "name": "Update a credential connection", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/credential_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing credential connection." }, { "info": { "name": "Delete a credential connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/credential_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Deletes an existing credential connection." }, { "info": { "name": "Check a Credential Connection Registration Status", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/credential_connections/:id/actions/check_registration_status", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "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`)" } ] }, { "info": { "name": "Call Recordings", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a stored credential", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/custom_storage_credentials/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource." } ] }, "docs": "Returns the information about custom storage credentials." }, { "info": { "name": "Create a custom storage credential", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/custom_storage_credentials/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a custom storage credentials configuration." }, { "info": { "name": "Update a stored credential", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/custom_storage_credentials/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a stored custom credentials configuration." }, { "info": { "name": "Delete a stored credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/custom_storage_credentials/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource." } ] }, "docs": "Deletes a stored custom credentials configuration." }, { "info": { "name": "List all recording transcriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/recording_transcriptions", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Filter recording transcriptions by various attributes." } ] }, "docs": "Returns a list of your recording transcriptions." }, { "info": { "name": "Retrieve a recording transcription", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/recording_transcriptions/:recording_transcription_id", "params": [ { "name": "recording_transcription_id", "value": "", "type": "path", "description": "Uniquely identifies the recording transcription by id." } ] }, "docs": "Retrieves the details of an existing recording transcription." }, { "info": { "name": "Delete a recording transcription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/recording_transcriptions/:recording_transcription_id", "params": [ { "name": "recording_transcription_id", "value": "", "type": "path", "description": "Uniquely identifies the recording transcription by id." } ] }, "docs": "Permanently deletes a recording transcription." }, { "info": { "name": "List all call recordings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/recordings", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Filter recordings by various attributes." } ] }, "docs": "Returns a list of your call recordings." }, { "info": { "name": "Delete a list of call recordings", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/recordings/actions/delete", "body": { "type": "json", "data": "{}" } }, "docs": "Permanently deletes a list of call recordings." }, { "info": { "name": "Retrieve a call recording", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/recordings/:recording_id", "params": [ { "name": "recording_id", "value": "", "type": "path", "description": "Uniquely identifies the recording by id." } ] }, "docs": "Retrieves the details of an existing call recording." }, { "info": { "name": "Delete a call recording", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/recordings/:recording_id", "params": [ { "name": "recording_id", "value": "", "type": "path", "description": "Uniquely identifies the recording by id." } ] }, "docs": "Permanently deletes a call recording." } ] }, { "info": { "name": "Customer Service Record", "type": "folder" }, "items": [ { "info": { "name": "List customer service records", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/customer_service_records", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "List customer service records." }, { "info": { "name": "Create a customer service record", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/customer_service_records", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new customer service record for the provided phone number." }, { "info": { "name": "Verify CSR phone number coverage", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/customer_service_records/phone_number_coverages", "body": { "type": "json", "data": "{}" } }, "docs": "Verify the coverage for a list of phone numbers." }, { "info": { "name": "Get a customer service record", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/customer_service_records/:customer_service_record_id", "params": [ { "name": "customer_service_record_id", "value": "", "type": "path", "description": "The ID of the customer service record" } ] }, "docs": "Get a specific customer service record." } ] }, { "info": { "name": "Detail Records", "type": "folder" }, "items": [ { "info": { "name": "Search detail records", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/detail_records", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filter records on a given record attribute and value.
Example: filter[status]=delivered.
Required: filter[record_type] must be specified." }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results.
Example: sort=-created_at" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Search for any detail record across the Telnyx Platform" } ] }, { "info": { "name": "Dialogflow Integration", "type": "folder" }, "items": [ { "info": { "name": "Retrieve stored Dialogflow Connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/dialogflow_connections/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Uniquely identifies a Telnyx application (Call Control)." } ] }, "docs": "Return details of the Dialogflow connection associated with the given CallControl connection." }, { "info": { "name": "Create a Dialogflow Connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/dialogflow_connections/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Uniquely identifies a Telnyx application (Call Control)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services." }, { "info": { "name": "Update stored Dialogflow Connection", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/dialogflow_connections/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Uniquely identifies a Telnyx application (Call Control)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a stored Dialogflow Connection." }, { "info": { "name": "Delete stored Dialogflow Connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/dialogflow_connections/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "Uniquely identifies a Telnyx application (Call Control)." } ] }, "docs": "Deletes a stored Dialogflow Connection." } ] }, { "info": { "name": "Documents", "type": "folder" }, "items": [ { "info": { "name": "List all document links", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/document_links", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter for document links (deepObject style). Originally: filter[linked_record_type], filter[linked_resource_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "List all documents links ordered by created_at descending." }, { "info": { "name": "List all documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/documents", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter for documents (deepObject style). Originally: sort[]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "List all documents ordered by created_at descending." }, { "info": { "name": "Upload a document", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/documents", "body": { "type": "json", "data": "{}" } }, "docs": "Upload a document.

Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted." }, { "info": { "name": "Retrieve a document", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/documents/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a document." }, { "info": { "name": "Update a document", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/documents/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a document." }, { "info": { "name": "Delete a document", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/documents/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a document.

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." }, { "info": { "name": "Download a document", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/documents/:id/download", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Download a document." }, { "info": { "name": "Generate a temporary download link for a document", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/documents/:id/download_link", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the document" } ] }, "docs": "Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication." } ] }, { "info": { "name": "Dynamic Emergency Addresses", "type": "folder" }, "items": [ { "info": { "name": "List dynamic emergency addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/dynamic_emergency_addresses", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[status], filter[country_code]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns the dynamic emergency addresses according to filters" }, { "info": { "name": "Create a dynamic emergency address.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/dynamic_emergency_addresses", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a dynamic emergency address." }, { "info": { "name": "Get a dynamic emergency address", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/dynamic_emergency_addresses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Dynamic Emergency Address id" } ] }, "docs": "Returns the dynamic emergency address based on the ID provided" }, { "info": { "name": "Delete a dynamic emergency address", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/dynamic_emergency_addresses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Dynamic Emergency Address id" } ] }, "docs": "Deletes the dynamic emergency address based on the ID provided" } ] }, { "info": { "name": "Dynamic Emergency Endpoints", "type": "folder" }, "items": [ { "info": { "name": "List dynamic emergency endpoints", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/dynamic_emergency_endpoints", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[status], filter[country_code]" } ] }, "docs": "Returns the dynamic emergency endpoints according to filters" }, { "info": { "name": "Create a dynamic emergency endpoint.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/dynamic_emergency_endpoints", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a dynamic emergency endpoints." }, { "info": { "name": "Get a dynamic emergency endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/dynamic_emergency_endpoints/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Dynamic Emergency Endpoint id" } ] }, "docs": "Returns the dynamic emergency endpoint based on the ID provided" }, { "info": { "name": "Delete a dynamic emergency endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/dynamic_emergency_endpoints/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Dynamic Emergency Endpoint id" } ] }, "docs": "Deletes the dynamic emergency endpoint based on the ID provided" } ] }, { "info": { "name": "Enterprises", "type": "folder" }, "items": [ { "info": { "name": "List enterprises", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/enterprises", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-indexed)" }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "legal_name", "value": "", "type": "query", "description": "Filter by legal name (partial match)" } ] }, "docs": "Retrieve a paginated list of enterprises associated with your account." }, { "info": { "name": "Create an enterprise", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/enterprises", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new enterprise for Branded Calling / Number Reputation services.\n\nRegisters the enterprise in the Branded Calling / Number Reputation services, enabling it to create Display Identity Records (DIRs) or enroll in Number Reputation monitoring.\n\n**Required Fields:** `legal_name`, `doing_business_as`, `organization_type`, `country_code`, `website`, `fein`, `industry`, `number_of_employees`, `organization_legal_type`, `organization_contact`, `billing_contact`, `organization_physical_address`," }, { "info": { "name": "Get an enterprise", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" } ] }, "docs": "Retrieve details of a specific enterprise by ID." }, { "info": { "name": "Update an enterprise", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update enterprise information. All fields are optional — only the provided fields will be updated." }, { "info": { "name": "Delete an enterprise", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" } ] }, "docs": "Delete an enterprise and all associated resources. This action is irreversible." } ] }, { "info": { "name": "Number Reputation Settings", "type": "folder" }, "items": [ { "info": { "name": "Get reputation settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id/reputation", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" } ] }, "docs": "Retrieve the current Number Reputation settings for an enterprise.\n\nReturns the enrollment status (`pending`, `approved`, `rejected`, `deleted`), check frequency, and any rejection reasons.\n\nReturns `404` if reputation has not been enabled for this enterprise." }, { "info": { "name": "Enable Number Reputation", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id/reputation", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable Number Reputation service for an enterprise.\n\n**Requirements:**\n- Signed LOA (Letter of Authorization) document ID\n- Reputation check frequency (defaults to `business_daily`)\n- Number Reputation Terms of Service must be accepted\n\n**Flow:**\n1. Registers the enterprise for reputation monitoring\n2. Creates reputation settings with `pending` status\n3. Awaits admin approval before monitoring begins\n\n**Resubmission After Rejection:**\nIf a previously rejected record exists, this endpoint will de" }, { "info": { "name": "Disable Number Reputation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id/reputation", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" } ] }, "docs": "Disable Number Reputation for an enterprise.\n\nThis will:\n- Delete the reputation settings record\n- Log the deletion for audit purposes\n- Stop all future automated reputation checks\n\n**Note:** Can only be performed on `approved` reputation settings." }, { "info": { "name": "Update reputation check frequency", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id/reputation/frequency", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update how often reputation data is automatically refreshed.\n\n**Note:** The enterprise must have `approved` reputation settings. Updating frequency on `pending` or `rejected` settings will return an error.\n\n**Available Frequencies:**\n- `business_daily` — Monday–Friday\n- `daily` — Every day including weekends\n- `weekly` — Once per week\n- `biweekly` — Once every two weeks\n- `monthly` — Once per month\n- `never` — Manual refresh only (no automatic checks)" } ] }, { "info": { "name": "Reputation Phone Numbers", "type": "folder" }, "items": [ { "info": { "name": "List reputation phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id/reputation/numbers", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-indexed)" }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "phone_number", "value": "", "type": "query", "description": "Filter by specific phone number (E.164 format)" } ] }, "docs": "List all phone numbers associated with an enterprise for Number Reputation monitoring.\n\nReturns phone numbers with their cached reputation data (if available). Supports pagination and filtering by phone number." }, { "info": { "name": "Associate phone numbers for reputation", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id/reputation/numbers", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Associate one or more phone numbers with an enterprise for Number Reputation monitoring.\n\n**Validations:**\n- Phone numbers must be in E.164 format (e.g., `+16035551234`)\n- Phone numbers must be in-service and belong to your account (verified via Warehouse)\n- Phone numbers must be US local numbers\n- Phone numbers cannot already be associated with any enterprise\n\n**Note:** This operation is atomic — if any number fails validation, the entire request fails.\n\n**Maximum:** 100 phone numbers per reque" }, { "info": { "name": "Get reputation data for a phone number", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id/reputation/numbers/:phone_number", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" }, { "name": "phone_number", "value": "", "type": "path", "description": "Phone number in E.164 format" }, { "name": "fresh", "value": "", "type": "query", "description": "When true, fetches fresh reputation data (incurs API cost). When false, returns cached data." } ] }, "docs": "Get detailed reputation data for a specific phone number associated with an enterprise.\n\n**Query Parameters:**\n- `fresh` (default: `false`): When `true`, fetches fresh reputation data (incurs API cost). When `false`, returns cached data. If no cached data exists, fresh data is automatically fetched.\n\n**Returns:**\n- `spam_risk`: Overall spam risk level (`low`, `medium`, `high`)\n- `spam_category`: Spam category classification\n- `maturity_score`: Maturity metric (0–100)\n- `connection_score`: Connec" }, { "info": { "name": "Disassociate a phone number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/enterprises/:enterprise_id/reputation/numbers/:phone_number", "params": [ { "name": "enterprise_id", "value": "", "type": "path", "description": "Unique identifier of the enterprise (UUID)" }, { "name": "phone_number", "value": "", "type": "path", "description": "Phone number in E.164 format" } ] }, "docs": "Remove a phone number from Number Reputation monitoring for an enterprise.\n\nThe number will no longer be tracked and reputation data will no longer be refreshed." }, { "info": { "name": "List reputation phone numbers (simplified)", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/reputation/numbers", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-indexed)" }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "phone_number", "value": "", "type": "query", "description": "Filter by specific phone number (E.164 format)" } ] }, "docs": "List all phone numbers enrolled in Number Reputation monitoring for your account. This is a simplified endpoint that does not require an `enterprise_id` — it returns numbers across all your enterprises.\n\nSupports pagination and filtering by phone number." }, { "info": { "name": "Get reputation data for a phone number (simplified)", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/reputation/numbers/:phone_number", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number in E.164 format" }, { "name": "fresh", "value": "", "type": "query", "description": "When true, fetches fresh reputation data (incurs API cost). When false, returns cached data." } ] }, "docs": "Get reputation data for a specific phone number without requiring an `enterprise_id`.\n\nSame response as the enterprise-scoped endpoint. Uses cached data by default." }, { "info": { "name": "Disassociate a phone number (simplified)", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/reputation/numbers/:phone_number", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number in E.164 format" } ] }, "docs": "Remove a phone number from Number Reputation monitoring without requiring an `enterprise_id`." } ] }, { "info": { "name": "External Connections", "type": "folder" }, "items": [ { "info": { "name": "List all External Connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filter parameter for external connections (deepObject style). Supports filtering by connection_name, external_sip_connection, id, created_at, and phone_number." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "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." }, { "info": { "name": "Creates an External Connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/external_connections", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "List all log messages", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/log_messages", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Filter parameter for log messages (deepObject style). Supports filtering by external_connection_id and telephone_number with eq/contains operations." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Retrieve a list of log messages for all external connections associated with your account." }, { "info": { "name": "Retrieve a log message", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/log_messages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a log message for an external connection associated with your account." }, { "info": { "name": "Dismiss a log message", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/external_connections/log_messages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Dismiss a log message for an external connection associated with your account." }, { "info": { "name": "Retrieve an External Connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Return the details of an existing External Connection inside the 'data' attribute of the response." }, { "info": { "name": "Update an External Connection", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/external_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing External Connection based on the parameters of the request." }, { "info": { "name": "Deletes an External Connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/external_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "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." }, { "info": { "name": "List all civic addresses and locations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/civic_addresses", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "filter", "value": "", "type": "query", "description": "Filter parameter for civic addresses (deepObject style). Supports filtering by country." } ] }, "docs": "Returns the civic addresses and locations from Microsoft Teams." }, { "info": { "name": "Retrieve a Civic Address", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/civic_addresses/:address_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "address_id", "value": "", "type": "path", "description": "Identifies a civic address or a location." } ] }, "docs": "Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response." }, { "info": { "name": "Update a location's static emergency address", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/external_connections/:id/locations/:location_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the external connection" }, { "name": "location_id", "value": "", "type": "path", "description": "The ID of the location to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a location's static emergency address" }, { "info": { "name": "List all phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/phone_numbers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "filter", "value": "", "type": "query", "description": "Filter parameter for phone numbers (deepObject style). Supports filtering by phone_number, civic_address_id, and location_id with eq/contains operations." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns a list of all active phone numbers associated with the given external connection." }, { "info": { "name": "Retrieve a phone number", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/phone_numbers/:phone_number_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "phone_number_id", "value": "", "type": "path", "description": "A phone number's ID via the Telnyx API" } ] }, "docs": "Return the details of a phone number associated with the given external connection." }, { "info": { "name": "Update a phone number", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/external_connections/:id/phone_numbers/:phone_number_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "phone_number_id", "value": "", "type": "path", "description": "A phone number's ID via the Telnyx API" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Asynchronously update settings of the phone number associated with the given external connection." }, { "info": { "name": "List all Releases", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/releases", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "filter", "value": "", "type": "query", "description": "Filter parameter for releases (deepObject style). Supports filtering by status, civic_address_id, location_id, and phone_number with eq/contains operations." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "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." }, { "info": { "name": "Retrieve a Release request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/releases/:release_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "release_id", "value": "", "type": "path", "description": "Identifies a Release request" } ] }, "docs": "Return the details of a Release request and its phone numbers." }, { "info": { "name": "List all Upload requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/uploads", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "filter", "value": "", "type": "query", "description": "Filter parameter for uploads (deepObject style). Supports filtering by status, civic_address_id, location_id, and phone_number with eq/contains operations." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns a list of your Upload requests for the given external connection." }, { "info": { "name": "Creates an Upload request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/external_connections/:id/uploads", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Refresh the status of all Upload requests", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/external_connections/:id/uploads/refresh", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Forces a recheck of the status of all pending Upload requests for the given external connection in the background." }, { "info": { "name": "Get the count of pending upload requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/uploads/status", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Returns the count of all pending upload requests for the given external connection." }, { "info": { "name": "Retrieve an Upload request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/external_connections/:id/uploads/:ticket_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "ticket_id", "value": "", "type": "path", "description": "Identifies an Upload request" } ] }, "docs": "Return the details of an Upload request and its phone numbers." }, { "info": { "name": "Retry an Upload request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/external_connections/:id/uploads/:ticket_id/retry", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "ticket_id", "value": "", "type": "path", "description": "Identifies an Upload request" } ] }, "docs": "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." }, { "info": { "name": "Refresh Operator Connect integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/operator_connect/actions/refresh" }, "docs": "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-reference/external-connections/list-all-log-messages#list-all-log-messages)." } ] }, { "info": { "name": "Programmable Fax Applications", "type": "folder" }, "items": [ { "info": { "name": "List all Fax Applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/fax_applications", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[application_name][contains], filter[outbound_voice_profile_id]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." } ] }, "docs": "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." }, { "info": { "name": "Creates a Fax Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/fax_applications", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Retrieve a Fax Application", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/fax_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Return the details of an existing Fax Application inside the 'data' attribute of the response." }, { "info": { "name": "Update a Fax Application", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/fax_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing Fax Application based on the parameters of the request." }, { "info": { "name": "Deletes a Fax Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/fax_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers." } ] }, { "info": { "name": "Programmable Fax Commands", "type": "folder" }, "items": [ { "info": { "name": "View a list of faxes", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/faxes", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated pagination parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "View a list of faxes" }, { "info": { "name": "Send a fax", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/faxes", "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "View a fax", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/faxes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of a fax." } ] }, "docs": "View a fax" }, { "info": { "name": "Delete a fax", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/faxes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of a fax." } ] }, "docs": "Delete a fax" }, { "info": { "name": "Cancel a fax", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/faxes/:id/actions/cancel", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of a fax." } ] }, "docs": "Cancel the outbound fax that is in one of the following states: `queued`, `media.processed`, `originated` or `sending` " }, { "info": { "name": "Refresh a fax", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/faxes/:id/actions/refresh", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of a fax." } ] }, "docs": "Refreshes the inbound fax's media_url when it has expired" } ] }, { "info": { "name": "FQDN Connections", "type": "folder" }, "items": [ { "info": { "name": "List FQDN connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/fqdn_connections", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." } ] }, "docs": "Returns a list of your FQDN connections." }, { "info": { "name": "Create an FQDN connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/fqdn_connections", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a FQDN connection." }, { "info": { "name": "Retrieve an FQDN connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/fqdn_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieves the details of an existing FQDN connection." }, { "info": { "name": "Update an FQDN connection", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/fqdn_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing FQDN connection." }, { "info": { "name": "Delete an FQDN connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/fqdn_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Deletes an FQDN connection." } ] }, { "info": { "name": "FQDNs", "type": "folder" }, "items": [ { "info": { "name": "List FQDNs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/fqdns", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[connection_id], filter[fqdn], filter[port], filter[dns_record_type]" } ] }, "docs": "Get all FQDNs belonging to the user that match the given filters." }, { "info": { "name": "Create an FQDN", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/fqdns", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new FQDN object." }, { "info": { "name": "Retrieve an FQDN", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/fqdns/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Return the details regarding a specific FQDN." }, { "info": { "name": "Update an FQDN", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/fqdns/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the details of a specific FQDN." }, { "info": { "name": "Delete an FQDN", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/fqdns/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete an FQDN." } ] }, { "info": { "name": "Global IPs", "type": "folder" }, "items": [ { "info": { "name": "List all Global IP Allowed Ports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_allowed_ports" }, "docs": "List all Global IP Allowed Ports" }, { "info": { "name": "Global IP Assignment Health Check Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_assignment_health", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in], filter[global_ip_assignment_id][in]" } ] }, "docs": "Global IP Assignment Health Check Metrics" }, { "info": { "name": "List all Global IP assignments", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_assignments", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Global IP assignments." }, { "info": { "name": "Create a Global IP assignment", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/global_ip_assignments", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Global IP assignment." }, { "info": { "name": "Retrieve a Global IP", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_assignments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a Global IP assignment." }, { "info": { "name": "Update a Global IP assignment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/global_ip_assignments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Global IP assignment." }, { "info": { "name": "Delete a Global IP assignment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/global_ip_assignments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a Global IP assignment." }, { "info": { "name": "Global IP Assignment Usage Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_assignments_usage", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[global_ip_assignment_id][in], filter[global_ip_id][in]" } ] }, "docs": "Global IP Assignment Usage Metrics" }, { "info": { "name": "List all Global IP Health check types", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_health_check_types" }, "docs": "List all Global IP Health check types." }, { "info": { "name": "List all Global IP health checks", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_health_checks", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Global IP health checks." }, { "info": { "name": "Create a Global IP health check", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/global_ip_health_checks", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Global IP health check." }, { "info": { "name": "Retrieve a Global IP health check", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_health_checks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a Global IP health check." }, { "info": { "name": "Delete a Global IP health check", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/global_ip_health_checks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a Global IP health check." }, { "info": { "name": "Global IP Latency Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_latency", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in]" } ] }, "docs": "Global IP Latency Metrics" }, { "info": { "name": "List all Global IP Protocols", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_protocols" }, "docs": "List all Global IP Protocols" }, { "info": { "name": "Global IP Usage Metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ip_usage", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[global_ip_id][in]" } ] }, "docs": "Global IP Usage Metrics" }, { "info": { "name": "List all Global IPs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ips", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Global IPs." }, { "info": { "name": "Create a Global IP", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/global_ips", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Global IP." }, { "info": { "name": "Retrieve a Global IP", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/global_ips/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a Global IP." }, { "info": { "name": "Delete a Global IP", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/global_ips/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a Global IP." } ] }, { "info": { "name": "Inexplicit Number Orders", "type": "folder" }, "items": [ { "info": { "name": "List inexplicit number orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/inexplicit_number_orders", "params": [ { "name": "page_number", "value": "", "type": "query", "description": "The page number to load" }, { "name": "page_size", "value": "", "type": "query", "description": "The size of the page" } ] }, "docs": "Get a paginated list of inexplicit number orders." }, { "info": { "name": "Create an inexplicit number order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/inexplicit_number_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Create an inexplicit number order to programmatically purchase phone numbers without specifying exact numbers." }, { "info": { "name": "Retrieve an inexplicit number order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/inexplicit_number_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the inexplicit number order" } ] }, "docs": "Get an existing inexplicit number order by ID." } ] }, { "info": { "name": "Integration Secrets", "type": "folder" }, "items": [ { "info": { "name": "List integration secrets", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/integration_secrets", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[type]" } ] }, "docs": "Retrieve a list of all integration secrets configured by the user." }, { "info": { "name": "Create a secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/integration_secrets", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new secret with an associated identifier that can be used to securely integrate with other services." }, { "info": { "name": "Delete an integration secret", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/integration_secrets/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an integration secret given its ID." } ] }, { "info": { "name": "Inventory Level", "type": "folder" }, "items": [ { "info": { "name": "Create an inventory coverage request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/inventory_coverage", "params": [ { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "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." } ] }, { "info": { "name": "IP Connections", "type": "folder" }, "items": [ { "info": { "name": "List Ip connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ip_connections", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." } ] }, "docs": "Returns a list of your IP connections." }, { "info": { "name": "Create an Ip connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ip_connections", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an IP connection." }, { "info": { "name": "Retrieve an Ip connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ip_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "IP Connection ID" } ] }, "docs": "Retrieves the details of an existing ip connection." }, { "info": { "name": "Update an Ip connection", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/ip_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing IP connection." }, { "info": { "name": "Delete an Ip connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ip_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ] }, "docs": "Deletes an existing IP connection." } ] }, { "info": { "name": "IPs", "type": "folder" }, "items": [ { "info": { "name": "List Ips", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ips", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[connection_id], filter[ip_address], filter[port]" } ] }, "docs": "Get all IPs belonging to the user that match the given filters." }, { "info": { "name": "Create an Ip", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ips", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new IP object." }, { "info": { "name": "Retrieve an Ip", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ips/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ] }, "docs": "Return the details regarding a specific IP." }, { "info": { "name": "Update an Ip", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/ips/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the details of a specific IP." }, { "info": { "name": "Delete an Ip", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/ips/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ] }, "docs": "Delete an IP." } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Create a ledger billing group report", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/ledger_billing_group_reports", "body": { "type": "json", "data": "{}" } }, "docs": "Create a ledger billing group report" }, { "info": { "name": "Get a ledger billing group report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ledger_billing_group_reports/:id", "params": [ { "name": "id", "value": "f5586561-8ff0-4291-a0ac-84fe544797bd", "type": "path", "description": "The id of the ledger billing group report" } ] }, "docs": "Get a ledger billing group report" } ] }, { "info": { "name": "MDR Detailed Reports", "type": "folder" }, "items": [ { "info": { "name": "Get all MDR detailed report requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves all MDR detailed report requests for the authenticated user" }, { "info": { "name": "Create a new MDR detailed report request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new MDR detailed report request with the specified filters" }, { "info": { "name": "Get a specific MDR detailed report request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a specific MDR detailed report request by ID" }, { "info": { "name": "Delete a MDR detailed report request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/messaging/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a specific MDR detailed report request by ID" } ] }, { "info": { "name": "Speech to Text Batch Reports", "type": "folder" }, "items": [ { "info": { "name": "Get all Speech to Text batch report requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves all Speech to Text batch report requests for the authenticated user" }, { "info": { "name": "Create a new Speech to Text batch report request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new Speech to Text batch report request with the specified filters" }, { "info": { "name": "Get a specific Speech to Text batch report request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a specific Speech to Text batch report request by ID" }, { "info": { "name": "Delete a Speech to Text batch report request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a specific Speech to Text batch report request by ID" } ] }, { "info": { "name": "CDR Reports", "type": "folder" }, "items": [ { "info": { "name": "Get all CDR report requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves all CDR report requests for the authenticated user" }, { "info": { "name": "Create a new CDR report request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new CDR report request with the specified filters" }, { "info": { "name": "Get available CDR report fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/fields", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves all available fields that can be used in CDR reports" }, { "info": { "name": "Get a specific CDR report request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves a specific CDR report request by ID" }, { "info": { "name": "Delete a CDR report request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/voice/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a specific CDR report request by ID" } ] }, { "info": { "name": "MDR Usage Reports", "type": "folder" }, "items": [ { "info": { "name": "List MDR usage reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "", "type": "query", "description": "Size of the page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch all previous requests for MDR usage reports. " }, { "info": { "name": "Create a new legacy usage V2 MDR report request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new legacy usage V2 MDR report request with the specified filters" }, { "info": { "name": "Get an MDR usage report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch single MDR usage report by id." }, { "info": { "name": "Delete a V2 legacy usage MDR report request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/messaging/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a specific V2 legacy usage MDR report request by ID" }, { "info": { "name": "Fetch all Messaging usage reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/reports/mdr_usage_reports", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown" }, { "info": { "name": "Create MDR Usage Report", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/reports/mdr_usage_reports", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period. " }, { "info": { "name": "Generate and fetch MDR Usage Report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/reports/mdr_usage_reports/sync", "params": [ { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "aggregation_type", "value": "", "type": "query" }, { "name": "profiles", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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. " }, { "info": { "name": "Retrieve messaging report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/reports/mdr_usage_reports/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch a single messaging usage report by id" }, { "info": { "name": "Delete MDR Usage Report", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/reports/mdr_usage_reports/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete messaging usage report by id" } ] }, { "info": { "name": "Telco Data Usage Reports", "type": "folder" }, "items": [ { "info": { "name": "List telco data usage reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a paginated list of telco data usage reports" }, { "info": { "name": "Submit telco data usage report", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Submit a new telco data usage report" }, { "info": { "name": "Get telco data usage report by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a specific telco data usage report by its ID" }, { "info": { "name": "Delete telco data usage report", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/number_lookup/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a specific telco data usage report by its ID" } ] }, { "info": { "name": "Speech to text Usage Reports", "type": "folder" }, "items": [ { "info": { "name": "Get speech to text usage report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/speech_to_text", "params": [ { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate and fetch speech to text usage report synchronously. This endpoint will both generate and fetch the speech to text report over a specified time period. " } ] }, { "info": { "name": "CDR Usage Reports", "type": "folder" }, "items": [ { "info": { "name": "List CDR usage reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "per_page", "value": "", "type": "query", "description": "Size of the page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch all previous requests for cdr usage reports. " }, { "info": { "name": "Create a new legacy usage V2 CDR report request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Creates a new legacy usage V2 CDR report request with the specified filters" }, { "info": { "name": "Get a CDR usage report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch single cdr usage report by id." }, { "info": { "name": "Delete a V2 legacy usage CDR report request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/legacy/reporting/usage_reports/voice/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deletes a specific V2 legacy usage CDR report request by ID" }, { "info": { "name": "Generates and fetches CDR Usage Reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/reports/cdr_usage_reports/sync", "params": [ { "name": "start_date", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "aggregation_type", "value": "", "type": "query" }, { "name": "product_breakdown", "value": "", "type": "query" }, { "name": "connections", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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. " } ] }, { "info": { "name": "Managed Accounts", "type": "folder" }, "items": [ { "info": { "name": "Lists accounts managed by the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/managed_accounts", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[email][contains], filter[email][eq], filter[organization_name][contains], filter[organization_name][eq]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." }, { "name": "include_cancelled_accounts", "value": "", "type": "query", "description": "Specifies if cancelled accounts should be included in the results." } ] }, "docs": "Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts." }, { "info": { "name": "Create a new managed account.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/managed_accounts", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Display information about allocatable global outbound channels for the current user.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/managed_accounts/allocatable_global_outbound_channels" }, "docs": "Display information about allocatable global outbound channels for the current user. Only usable by account managers." }, { "info": { "name": "Retrieve a managed account", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/managed_accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Managed Account User ID" } ] }, "docs": "Retrieves the details of a single managed account." }, { "info": { "name": "Update a managed account", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/managed_accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Managed Account User ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a single managed account." }, { "info": { "name": "Disables a managed account", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/managed_accounts/:id/actions/disable", "params": [ { "name": "id", "value": "", "type": "path", "description": "Managed Account User ID" } ] }, "docs": "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." }, { "info": { "name": "Enables a managed account", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/managed_accounts/:id/actions/enable", "params": [ { "name": "id", "value": "", "type": "path", "description": "Managed Account User ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables a managed account and its sub-users to use Telnyx services." }, { "info": { "name": "Update the amount of allocatable global outbound channels allocated to a specific managed account.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/managed_accounts/:id/update_global_channel_limit", "params": [ { "name": "id", "value": "", "type": "path", "description": "Managed Account User ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the amount of allocatable global outbound channels allocated to a specific managed account." } ] }, { "info": { "name": "Media Storage API", "type": "folder" }, "items": [ { "info": { "name": "List uploaded media", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/media", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[content_type][]" } ] }, "docs": "Returns a list of stored media files." }, { "info": { "name": "Upload media", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/media", "body": { "type": "json", "data": "{}" } }, "docs": "Upload media file to Telnyx so it can be used with other Telnyx services" }, { "info": { "name": "Retrieve stored media", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/media/:media_name", "params": [ { "name": "media_name", "value": "", "type": "path", "description": "Uniquely identifies a media resource." } ] }, "docs": "Returns the information about a stored media file." }, { "info": { "name": "Update stored media", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/media/:media_name", "params": [ { "name": "media_name", "value": "", "type": "path", "description": "Uniquely identifies a media resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a stored media file." }, { "info": { "name": "Deletes stored media", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/media/:media_name", "params": [ { "name": "media_name", "value": "", "type": "path", "description": "Uniquely identifies a media resource." } ] }, "docs": "Deletes a stored media file." }, { "info": { "name": "Download stored media", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/media/:media_name/download", "params": [ { "name": "media_name", "value": "", "type": "path", "description": "Uniquely identifies a media resource." } ] }, "docs": "Downloads a stored media file." } ] }, { "info": { "name": "Messages", "type": "folder" }, "items": [ { "info": { "name": "Send a message", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages", "body": { "type": "json", "data": "{}" } }, "docs": "Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.\n\nThis endpoint allows you to send a message with any messaging resource.\nCurrent messaging resources include: long-code, short-code, number-pool, and\nalphanumeric-sender-id.\n" }, { "info": { "name": "Send a message using an alphanumeric sender ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages/alphanumeric_sender_id", "body": { "type": "json", "data": "{}" } }, "docs": "Send an SMS message using an alphanumeric sender ID. This is SMS only." }, { "info": { "name": "Retrieve group MMS messages", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messages/group/:message_id", "params": [ { "name": "message_id", "value": "", "type": "path", "description": "The group message ID." } ] }, "docs": "Retrieve all messages in a group MMS conversation by the group message ID." }, { "info": { "name": "Send a group MMS message", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages/group_mms", "body": { "type": "json", "data": "{}" } }, "docs": "Send a group MMS message" }, { "info": { "name": "Send a long code message", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages/long_code", "body": { "type": "json", "data": "{}" } }, "docs": "Send a long code message" }, { "info": { "name": "Send a message using number pool", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages/number_pool", "body": { "type": "json", "data": "{}" } }, "docs": "Send a message using number pool" }, { "info": { "name": "Schedule a message", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages/schedule", "body": { "type": "json", "data": "{}" } }, "docs": "Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.\n\nThis endpoint allows you to schedule a message with any messaging resource.\nCurrent messaging resources include: long-code, short-code, number-pool, and\nalphanumeric-sender-id.\n" }, { "info": { "name": "Send a short code message", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages/short_code", "body": { "type": "json", "data": "{}" } }, "docs": "Send a short code message" }, { "info": { "name": "Retrieve a message", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the message" } ] }, "docs": "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-reference/mdr-usage-reports/create-mdr-usage-report)" }, { "info": { "name": "Cancel a scheduled message", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/messages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the message to cancel" } ] }, "docs": "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." } ] }, { "info": { "name": "RCS", "type": "folder" }, "items": [ { "info": { "name": "Send an RCS message", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages/rcs", "body": { "type": "json", "data": "{}" } }, "docs": "Send an RCS message" }, { "info": { "name": "Generate RCS deeplink", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messages/rcs/deeplinks/:agent_id", "params": [ { "name": "agent_id", "value": "", "type": "path", "description": "RCS agent ID" }, { "name": "phone_number", "value": "%2B18445550001", "type": "query", "description": "Phone number in E164 format (URL encoded)" }, { "name": "body", "value": "hello%20world", "type": "query", "description": "Pre-filled message body (URL encoded)" } ] }, "docs": "Generate a deeplink URL that can be used to start an RCS conversation with a specific agent." }, { "info": { "name": "List all RCS agents", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging/rcs/agents", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all RCS agents" }, { "info": { "name": "Retrieve an RCS agent", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging/rcs/agents/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "RCS agent ID" } ] }, "docs": "Retrieve an RCS agent" }, { "info": { "name": "Modify an RCS agent", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/messaging/rcs/agents/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "RCS agent ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an RCS agent" }, { "info": { "name": "Check RCS capabilities (batch)", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging/rcs/bulk_capabilities", "body": { "type": "json", "data": "{}" } }, "docs": "Check RCS capabilities (batch)" }, { "info": { "name": "Check RCS capabilities", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging/rcs/capabilities/:agent_id/:phone_number", "params": [ { "name": "agent_id", "value": "", "type": "path", "description": "RCS agent ID" }, { "name": "phone_number", "value": "", "type": "path", "description": "Phone number in E164 format" } ] }, "docs": "Check RCS capabilities" }, { "info": { "name": "Add RCS test number", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/messaging/rcs/test_number_invite/:id/:phone_number", "params": [ { "name": "id", "value": "", "type": "path", "description": "RCS agent ID" }, { "name": "phone_number", "value": "", "type": "path", "description": "Phone number in E164 format to invite for testing" } ] }, "docs": "Adds a test phone number to an RCS agent for testing purposes." } ] }, { "info": { "name": "Whatsapp messaging", "type": "folder" }, "items": [ { "info": { "name": "Send a Whatsapp message", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messages/whatsapp", "body": { "type": "json", "data": "{}" } }, "docs": "Send a Whatsapp message" } ] }, { "info": { "name": "Hosted Numbers", "type": "folder" }, "items": [ { "info": { "name": "List messaging hosted number orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_hosted_number_orders", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List messaging hosted number orders" }, { "info": { "name": "Create a messaging hosted number order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_hosted_number_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Create a messaging hosted number order" }, { "info": { "name": "Check hosted messaging eligibility", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_hosted_number_orders/eligibility_numbers_check", "body": { "type": "json", "data": "{}" } }, "docs": "Check hosted messaging eligibility" }, { "info": { "name": "Retrieve a messaging hosted number order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_hosted_number_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ] }, "docs": "Retrieve a messaging hosted number order" }, { "info": { "name": "Delete a messaging hosted number order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/messaging_hosted_number_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the messaging hosted number order to delete." } ] }, "docs": "Delete a messaging hosted number order and all associated phone numbers." }, { "info": { "name": "Upload hosted number document", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_hosted_number_orders/:id/actions/file_upload", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Upload hosted number document" }, { "info": { "name": "Validate hosted number codes", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_hosted_number_orders/:id/validation_codes", "params": [ { "name": "id", "value": "", "type": "path", "description": "Order ID related to the validation codes." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate the verification codes sent to the numbers of the hosted order. The verification codes must be created in the verification codes endpoint." }, { "info": { "name": "Create hosted number verification codes", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_hosted_number_orders/:id/verification_codes", "params": [ { "name": "id", "value": "", "type": "path", "description": "Order ID to have a verification code created." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create verification codes to validate numbers of the hosted order. The verification codes will be sent to the numbers of the hosted order." }, { "info": { "name": "Delete a messaging hosted number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/messaging_hosted_numbers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ] }, "docs": "Delete a messaging hosted number" } ] }, { "info": { "name": "Number Settings", "type": "folder" }, "items": [ { "info": { "name": "Bulk update phone number profiles", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_numbers_bulk_updates", "body": { "type": "json", "data": "{}" } }, "docs": "Bulk update phone number profiles" }, { "info": { "name": "Retrieve bulk update status", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_numbers_bulk_updates/:order_id", "params": [ { "name": "order_id", "value": "", "type": "path", "description": "Order ID to verify bulk update status." } ] }, "docs": "Retrieve bulk update status" }, { "info": { "name": "List phone numbers with messaging settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/messaging", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter[messaging_profile_id]", "value": "", "type": "query", "description": "Filter by messaging profile ID." }, { "name": "filter[phone_number]", "value": "", "type": "query", "description": "Filter by exact phone number (supports comma-separated list)." }, { "name": "filter[phone_number][contains]", "value": "", "type": "query", "description": "Filter by phone number substring." }, { "name": "filter[type]", "value": "", "type": "query", "description": "Filter by phone number type." }, { "name": "sort[phone_number]", "value": "", "type": "query", "description": "Sort by phone number." } ] }, "docs": "List phone numbers with messaging settings" }, { "info": { "name": "Retrieve a phone number with messaging settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/:id/messaging", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ] }, "docs": "Retrieve a phone number with messaging settings" }, { "info": { "name": "Update the messaging profile and/or messaging product of a phone number", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/phone_numbers/:id/messaging", "params": [ { "name": "id", "value": "", "type": "path", "description": "The phone number to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the messaging profile and/or messaging product of a phone number" } ] }, { "info": { "name": "Opt-Out Management", "type": "folder" }, "items": [ { "info": { "name": "List opt-outs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_optouts", "params": [ { "name": "redaction_enabled", "value": "+447766****", "type": "query", "description": "If receiving address (+E.164 formatted phone number) should be redacted" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id], filter[from]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "created_at", "value": "", "type": "query", "description": "Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]" } ] }, "docs": "Retrieve a list of opt-out blocks." }, { "info": { "name": "List Auto-Response Settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profiles/:profile_id/autoresp_configs", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "country_code", "value": "", "type": "query" }, { "name": "created_at", "value": "", "type": "query", "description": "Consolidated created_at parameter (deepObject style). Originally: created_at[gte], created_at[lte]" }, { "name": "updated_at", "value": "", "type": "query", "description": "Consolidated updated_at parameter (deepObject style). Originally: updated_at[gte], updated_at[lte]" } ] }, "docs": "List Auto-Response Settings" }, { "info": { "name": "Create auto-response setting", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_profiles/:profile_id/autoresp_configs", "params": [ { "name": "profile_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create auto-response setting" }, { "info": { "name": "Get Auto-Response Setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profiles/:profile_id/autoresp_configs/:autoresp_cfg_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "autoresp_cfg_id", "value": "", "type": "path" } ] }, "docs": "Get Auto-Response Setting" }, { "info": { "name": "Update Auto-Response Setting", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/messaging_profiles/:profile_id/autoresp_configs/:autoresp_cfg_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "autoresp_cfg_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Auto-Response Setting" }, { "info": { "name": "Delete Auto-Response Setting", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/messaging_profiles/:profile_id/autoresp_configs/:autoresp_cfg_id", "params": [ { "name": "profile_id", "value": "", "type": "path" }, { "name": "autoresp_cfg_id", "value": "", "type": "path" } ] }, "docs": "Delete Auto-Response Setting" } ] }, { "info": { "name": "Profiles", "type": "folder" }, "items": [ { "info": { "name": "List messaging profiles", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profiles", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[name]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter[name][eq]", "value": "", "type": "query", "description": "Filter profiles by exact name match." }, { "name": "filter[name][contains]", "value": "", "type": "query", "description": "Filter profiles by name containing the given string." } ] }, "docs": "List messaging profiles" }, { "info": { "name": "Create a messaging profile", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_profiles", "body": { "type": "json", "data": "{}" } }, "docs": "Create a messaging profile" }, { "info": { "name": "Retrieve a messaging profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the messaging profile to retrieve" } ] }, "docs": "Retrieve a messaging profile" }, { "info": { "name": "Update a messaging profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/messaging_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the messaging profile to retrieve" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a messaging profile" }, { "info": { "name": "Delete a messaging profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/messaging_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the messaging profile to retrieve" } ] }, "docs": "Delete a messaging profile" }, { "info": { "name": "List phone numbers associated with a messaging profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profiles/:id/phone_numbers", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the messaging profile to retrieve" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List phone numbers associated with a messaging profile" }, { "info": { "name": "List short codes associated with a messaging profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_profiles/:id/short_codes", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the messaging profile to retrieve" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List short codes associated with a messaging profile" } ] }, { "info": { "name": "Verification Requests", "type": "folder" }, "items": [ { "info": { "name": "List Verification Requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests", "params": [ { "name": "page", "value": "", "type": "query" }, { "name": "page_size", "value": "", "type": "query", "description": "\n Request this many records per page\n\n This value is automatically clamped if the provided value is too large.\n " }, { "name": "date_start", "value": "", "type": "query" }, { "name": "date_end", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "phone_number", "value": "", "type": "query" }, { "name": "business_name", "value": "", "type": "query", "description": "Filter verification requests by business name" } ] }, "docs": "Get a list of previously-submitted tollfree verification requests" }, { "info": { "name": "Submit Verification Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests", "body": { "type": "json", "data": "{}" } }, "docs": "Submit a new tollfree verification request" }, { "info": { "name": "Get Verification Request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a single verification request by its ID." }, { "info": { "name": "Update Verification Request", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken." }, { "info": { "name": "Delete Verification Request", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a verification request\n\nA request may only be deleted when when the request is in the \"rejected\" state.\n\n* `HTTP 200`: request successfully deleted\n* `HTTP 400`: request exists but can't be deleted (i.e. not rejected)\n* `HTTP 404`: request unknown or already deleted" }, { "info": { "name": "Get Verification Request Status History", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_tollfree/verification/requests/:id/status_history", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "page[number]", "value": "", "type": "query" }, { "name": "page[size]", "value": "", "type": "query" } ] }, "docs": "Get the history of status changes for a verification request.\n\nReturns a paginated list of historical status changes including the reason for each change and when it occurred." } ] }, { "info": { "name": "Messaging URL Domains", "type": "folder" }, "items": [ { "info": { "name": "List messaging URL domains", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/messaging_url_domains", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List messaging URL domains" } ] }, { "info": { "name": "Mobile Network Operators", "type": "folder" }, "items": [ { "info": { "name": "List mobile network operators", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/mobile_network_operators", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "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." } ] }, { "info": { "name": "Mobile Number Settings", "type": "folder" }, "items": [ { "info": { "name": "List mobile phone numbers with messaging settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/mobile_phone_numbers/messaging", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List mobile phone numbers with messaging settings" }, { "info": { "name": "Retrieve a mobile phone number with messaging settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/mobile_phone_numbers/:id/messaging", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the type of resource." } ] }, "docs": "Retrieve a mobile phone number with messaging settings" } ] }, { "info": { "name": "Push Credentials", "type": "folder" }, "items": [ { "info": { "name": "List mobile push credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/mobile_push_credentials", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[type], filter[alias]" } ] }, "docs": "List mobile push credentials" }, { "info": { "name": "Creates a new mobile push credential", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/mobile_push_credentials", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new mobile push credential" }, { "info": { "name": "Retrieves a mobile push credential", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/mobile_push_credentials/:push_credential_id", "params": [ { "name": "push_credential_id", "value": "", "type": "path", "description": "The unique identifier of a mobile push credential" } ] }, "docs": "Retrieves mobile push credential based on the given `push_credential_id`" }, { "info": { "name": "Deletes a mobile push credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/mobile_push_credentials/:push_credential_id", "params": [ { "name": "push_credential_id", "value": "", "type": "path", "description": "The unique identifier of a mobile push credential" } ] }, "docs": "Deletes a mobile push credential based on the given `push_credential_id`" } ] }, { "info": { "name": "Coverage", "type": "folder" }, "items": [ { "info": { "name": "List network coverage locations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/network_coverage", "params": [ { "name": "filters", "value": "", "type": "query", "description": "Consolidated filters parameter (deepObject style). Originally: filters[available_services][contains]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[location.region], filter[location.site], filter[location.pop], filter[location.code]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all locations and the interfaces that region supports" } ] }, { "info": { "name": "Networks", "type": "folder" }, "items": [ { "info": { "name": "List all Networks", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/networks", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[name]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Networks." }, { "info": { "name": "Create a Network", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/networks", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Network." }, { "info": { "name": "Retrieve a Network", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/networks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a Network." }, { "info": { "name": "Update a Network", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/networks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Network." }, { "info": { "name": "Delete a Network", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/networks/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a Network." }, { "info": { "name": "Get Default Gateway status.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/networks/:id/default_gateway", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Get Default Gateway status." }, { "info": { "name": "Create Default Gateway.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/networks/:id/default_gateway", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Default Gateway." }, { "info": { "name": "Delete Default Gateway.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/networks/:id/default_gateway", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete Default Gateway." }, { "info": { "name": "List all Interfaces for a Network.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/networks/:id/network_interfaces", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[name], filter[type], filter[status]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Interfaces for a Network." } ] }, { "info": { "name": "Notifications", "type": "folder" }, "items": [ { "info": { "name": "List notification channels", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/notification_channels", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "List notification channels." }, { "info": { "name": "Create a notification channel", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/notification_channels", "body": { "type": "json", "data": "{}" } }, "docs": "Create a notification channel." }, { "info": { "name": "Get a notification channel", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/notification_channels/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource." } ] }, "docs": "Get a notification channel." }, { "info": { "name": "Update a notification channel", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/notification_channels/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a notification channel." }, { "info": { "name": "Delete a notification channel", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/notification_channels/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource." } ] }, "docs": "Delete a notification channel." }, { "info": { "name": "List all Notifications Events Conditions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/notification_event_conditions", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "Returns a list of your notifications events conditions." }, { "info": { "name": "List all Notifications Events", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/notification_events", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "Returns a list of your notifications events." }, { "info": { "name": "List all Notifications Profiles", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/notification_profiles", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "Returns a list of your notifications profiles." }, { "info": { "name": "Create a notification profile", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/notification_profiles", "body": { "type": "json", "data": "{}" } }, "docs": "Create a notification profile." }, { "info": { "name": "Get a notification profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/notification_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource." } ] }, "docs": "Get a notification profile." }, { "info": { "name": "Update a notification profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/notification_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a notification profile." }, { "info": { "name": "Delete a notification profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/notification_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource." } ] }, "docs": "Delete a notification profile." }, { "info": { "name": "List notification settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/notification_settings", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "List notification settings." }, { "info": { "name": "Add a Notification Setting", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/notification_settings", "body": { "type": "json", "data": "{}" } }, "docs": "Add a notification setting." }, { "info": { "name": "Get a notification setting", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/notification_settings/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource." } ] }, "docs": "Get a notification setting." }, { "info": { "name": "Delete a notification setting", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/notification_settings/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the resource." } ] }, "docs": "Delete a notification setting." } ] }, { "info": { "name": "Phone Number Block Orders", "type": "folder" }, "items": [ { "info": { "name": "List number block orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_block_orders", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers.starting_number]" } ] }, "docs": "Get a paginated list of number block orders." }, { "info": { "name": "Create a number block order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/number_block_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a phone number block order." }, { "info": { "name": "Retrieve a number block order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_block_orders/:number_block_order_id", "params": [ { "name": "number_block_order_id", "value": "", "type": "path", "description": "The number block order ID." } ] }, "docs": "Get an existing phone number block order." } ] }, { "info": { "name": "Number Lookup", "type": "folder" }, "items": [ { "info": { "name": "Lookup phone number data", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_lookup/:phone_number", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "The phone number to be looked up" }, { "name": "type", "value": "", "type": "query", "description": "Specifies the type of number lookup to be performed" } ] }, "docs": "Returns information about the provided phone number." } ] }, { "info": { "name": "Requirement Groups", "type": "folder" }, "items": [ { "info": { "name": "Update requirement group for a phone number order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/number_order_phone_numbers/:id/requirement_group", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique identifier of the number order phone number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update requirement group for a phone number order" }, { "info": { "name": "List requirement groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/requirement_groups", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[country_code], filter[phone_number_type], filter[action], filter[status], filter[customer_reference]" } ] }, "docs": "List requirement groups" }, { "info": { "name": "Create a new requirement group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/requirement_groups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new requirement group" }, { "info": { "name": "Get a single requirement group by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/requirement_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the requirement group to retrieve" } ] }, "docs": "Get a single requirement group by ID" }, { "info": { "name": "Update requirement values in requirement group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/requirement_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the requirement group" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update requirement values in requirement group" }, { "info": { "name": "Delete a requirement group by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/requirement_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the requirement group" } ] }, "docs": "Delete a requirement group by ID" }, { "info": { "name": "Submit a Requirement Group for Approval", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/requirement_groups/:id/submit_for_approval", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the requirement group to submit" } ] }, "docs": "Submit a Requirement Group for Approval" }, { "info": { "name": "Update requirement group for a sub number order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sub_number_orders/:id/requirement_group", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the sub number order" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update requirement group for a sub number order" } ] }, { "info": { "name": "Phone Number Reservations", "type": "folder" }, "items": [ { "info": { "name": "List number reservations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_reservations", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[status], filter[created_at], filter[phone_numbers.phone_number], filter[customer_reference]" } ] }, "docs": "Gets a paginated list of phone number reservations." }, { "info": { "name": "Create a number reservation", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/number_reservations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Phone Number Reservation for multiple numbers." }, { "info": { "name": "Retrieve a number reservation", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/number_reservations/:number_reservation_id", "params": [ { "name": "number_reservation_id", "value": "", "type": "path", "description": "The number reservation ID." } ] }, "docs": "Gets a single phone number reservation." }, { "info": { "name": "Extend a number reservation", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/number_reservations/:number_reservation_id/actions/extend", "params": [ { "name": "number_reservation_id", "value": "", "type": "path", "description": "The number reservation ID." } ] }, "docs": "Extends reservation expiry time on all phone numbers." } ] }, { "info": { "name": "numbers features", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the features for a list of numbers", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/numbers_features", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve the features for a list of numbers" } ] }, { "info": { "name": "OAuth Protocol", "type": "folder" }, "items": [ { "info": { "name": "OAuth authorization endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/oauth/authorize", "params": [ { "name": "response_type", "value": "", "type": "query", "description": "OAuth response type" }, { "name": "client_id", "value": "", "type": "query", "description": "OAuth client identifier" }, { "name": "redirect_uri", "value": "", "type": "query", "description": "Redirect URI" }, { "name": "scope", "value": "admin", "type": "query", "description": "Space-separated list of requested scopes" }, { "name": "state", "value": "", "type": "query", "description": "State parameter for CSRF protection" }, { "name": "code_challenge", "value": "", "type": "query", "description": "PKCE code challenge" }, { "name": "code_challenge_method", "value": "", "type": "query", "description": "PKCE code challenge method" } ] }, "docs": "OAuth 2.0 authorization endpoint for the authorization code flow" }, { "info": { "name": "Get OAuth consent token", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/oauth/consent/:consent_token", "params": [ { "name": "consent_token", "value": "", "type": "path", "description": "OAuth consent token" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve details about an OAuth consent token" }, { "info": { "name": "Create OAuth grant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/oauth/grants", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create an OAuth authorization grant" }, { "info": { "name": "Token introspection", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/oauth/introspect", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.telnyx.com/v2/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Introspect an OAuth access token to check its validity and metadata" }, { "info": { "name": "JSON Web Key Set", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/oauth/jwks" }, "docs": "Retrieve the JSON Web Key Set for token verification" }, { "info": { "name": "Dynamic client registration", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/oauth/register", "body": { "type": "json", "data": "{}" } }, "docs": "Register a new OAuth client dynamically (RFC 7591)" }, { "info": { "name": "OAuth token endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/oauth/token", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api.telnyx.com/v2/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Exchange authorization code, client credentials, or refresh token for access token" } ] }, { "info": { "name": "OAuth Clients", "type": "folder" }, "items": [ { "info": { "name": "List OAuth clients", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/oauth_clients", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number" }, { "name": "filter[client_type]", "value": "", "type": "query", "description": "Filter by client type" }, { "name": "filter[verified]", "value": "", "type": "query", "description": "Filter by verification status" }, { "name": "filter[allowed_grant_types][contains]", "value": "", "type": "query", "description": "Filter by allowed grant type" }, { "name": "filter[name]", "value": "", "type": "query", "description": "Filter by exact client name" }, { "name": "filter[name][contains]", "value": "", "type": "query", "description": "Filter by client name containing text" }, { "name": "filter[client_id]", "value": "", "type": "query", "description": "Filter by client ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a paginated list of OAuth clients for the authenticated user" }, { "info": { "name": "Create OAuth client", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/oauth_clients", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new OAuth client" }, { "info": { "name": "Get OAuth client", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/oauth_clients/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "OAuth client ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a single OAuth client by ID" }, { "info": { "name": "Update OAuth client", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/oauth_clients/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "OAuth client ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing OAuth client" }, { "info": { "name": "Delete OAuth client", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/oauth_clients/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "OAuth client ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an OAuth client" } ] }, { "info": { "name": "OAuth Grants", "type": "folder" }, "items": [ { "info": { "name": "List OAuth grants", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/oauth_grants", "params": [ { "name": "page[size]", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "page[number]", "value": "", "type": "query", "description": "Page number" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a paginated list of OAuth grants for the authenticated user" }, { "info": { "name": "Get OAuth grant", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/oauth_grants/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "OAuth grant ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a single OAuth grant by ID" }, { "info": { "name": "Revoke OAuth grant", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/oauth_grants/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "OAuth grant ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Revoke an OAuth grant" } ] }, { "info": { "name": "Organization Users", "type": "folder" }, "items": [ { "info": { "name": "List organization users", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/organizations/users", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load" }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page" }, { "name": "filter[user_status]", "value": "", "type": "query", "description": "Filter by user status" }, { "name": "filter[email]", "value": "", "type": "query", "description": "Filter by email address (partial match)" }, { "name": "include_groups", "value": "", "type": "query", "description": "When set to true, includes the groups array for each user in the response. The groups array contains objects with id and name for each group the user belongs to." } ] }, "docs": "Returns a list of the users in your organization." }, { "info": { "name": "Get organization users groups report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/organizations/users/users_groups_report", "headers": [ { "name": "Accept", "value": "" } ] }, "docs": "Returns a report of all users in your organization with their group memberships. This endpoint returns all users without pagination and always includes group information. The report can be retrieved in JSON or CSV format by sending specific content-type headers." }, { "info": { "name": "Get organization user", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/organizations/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Organization User ID" }, { "name": "include_groups", "value": "", "type": "query", "description": "When set to true, includes the groups array for each user in the response. The groups array contains objects with id and name for each group the user belongs to." } ] }, "docs": "Returns a user in your organization." }, { "info": { "name": "Delete organization user", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/organizations/users/:id/actions/remove", "params": [ { "name": "id", "value": "", "type": "path", "description": "Organization User ID" } ] }, "docs": "Deletes a user in your organization." } ] }, { "info": { "name": "OTA updates", "type": "folder" }, "items": [ { "info": { "name": "List OTA updates", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ota_updates", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter for OTA updates (deepObject style). Originally: filter[status], filter[sim_card_id], filter[type]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List OTA updates" }, { "info": { "name": "Get OTA update", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/ota_updates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "This API returns the details of an Over the Air (OTA) update." } ] }, { "info": { "name": "Outbound Voice Profiles", "type": "folder" }, "items": [ { "info": { "name": "Get all outbound voice profiles", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/outbound_voice_profiles", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[name][contains]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
" } ] }, "docs": "Get all outbound voice profiles belonging to the user that match the given filters." }, { "info": { "name": "Create an outbound voice profile", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/outbound_voice_profiles", "body": { "type": "json", "data": "{}" } }, "docs": "Create an outbound voice profile." }, { "info": { "name": "Retrieve an outbound voice profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/outbound_voice_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieves the details of an existing outbound voice profile." }, { "info": { "name": "Updates an existing outbound voice profile.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/outbound_voice_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing outbound voice profile." }, { "info": { "name": "Delete an outbound voice profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/outbound_voice_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Deletes an existing outbound voice profile." } ] }, { "info": { "name": "AutoRechargePreferences", "type": "folder" }, "items": [ { "info": { "name": "List auto recharge preferences", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/payment/auto_recharge_prefs" }, "docs": "Returns the payment auto recharge preferences." }, { "info": { "name": "Update auto recharge preferences", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/payment/auto_recharge_prefs", "body": { "type": "json", "data": "{}" } }, "docs": "Update payment auto recharge preferences." } ] }, { "info": { "name": "Phone Number Blocks Background Jobs", "type": "folder" }, "items": [ { "info": { "name": "Lists the phone number blocks jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_number_blocks/jobs", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order." }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[type], filter[status]" } ] }, "docs": "Lists the phone number blocks jobs" }, { "info": { "name": "Deletes all numbers associated with a phone number block", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/phone_number_blocks/jobs/delete_phone_number_block", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Retrieves a phone number blocks job", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_number_blocks/jobs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the Phone Number Blocks Job." } ] }, "docs": "Retrieves a phone number blocks job" } ] }, { "info": { "name": "Phone Number Configurations", "type": "folder" }, "items": [ { "info": { "name": "List phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order." }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "handle_messaging_profile_error", "value": "", "type": "query", "description": "Although it is an infrequent occurrence, due to the highly distributed nature of the Telnyx platform, it is possible that there will be an issue when loading in Messaging Profile information. As such, when this parameter is set to `true` and an error in fetching this information occurs, messaging profile related fields will be omitted in the response and an error message will be included instead of returning a 503 error." } ] }, "docs": "List phone numbers" }, { "info": { "name": "Verify ownership of phone numbers", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/phone_numbers/actions/verify_ownership", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Slim List phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/slim", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "include_connection", "value": "", "type": "query", "description": "Include the connection associated with the phone number." }, { "name": "include_tags", "value": "", "type": "query", "description": "Include the tags associated with the phone number." }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order." }, { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit." }, { "info": { "name": "List phone numbers with voice settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/voice", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order." }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[connection_name], filter[customer_reference], filter[voice.usage_payment_method]" } ] }, "docs": "List phone numbers with voice settings" }, { "info": { "name": "Retrieve a phone number", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a phone number" }, { "info": { "name": "Update a phone number", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/phone_numbers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a phone number" }, { "info": { "name": "Delete a phone number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/phone_numbers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a phone number" }, { "info": { "name": "Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/phone_numbers/:id/actions/bundle_status_change", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)" }, { "info": { "name": "Enable emergency for a phone number", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/phone_numbers/:id/actions/enable_emergency", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable emergency for a phone number" }, { "info": { "name": "Retrieve a phone number with voice settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/:id/voice", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a phone number with voice settings" }, { "info": { "name": "Update a phone number with voice settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/phone_numbers/:id/voice", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a phone number with voice settings" } ] }, { "info": { "name": "CSV Downloads", "type": "folder" }, "items": [ { "info": { "name": "List CSV downloads", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/csv_downloads", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "List CSV downloads" }, { "info": { "name": "Create a CSV download", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/phone_numbers/csv_downloads", "params": [ { "name": "csv_format", "value": "", "type": "query", "description": "Which format to use when generating the CSV file. The default for backwards compatibility is 'V1'" }, { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "Create a CSV download" }, { "info": { "name": "Retrieve a CSV download", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/csv_downloads/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the CSV download." } ] }, "docs": "Retrieve a CSV download" } ] }, { "info": { "name": "Bulk Phone Number Operations", "type": "folder" }, "items": [ { "info": { "name": "Lists the phone numbers jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/jobs", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order." }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[type]" } ] }, "docs": "Lists the phone numbers jobs" }, { "info": { "name": "Delete a batch of numbers", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/phone_numbers/jobs/delete_phone_numbers", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call." }, { "info": { "name": "Update the emergency settings from a batch of numbers", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/phone_numbers/jobs/update_emergency_settings", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update a batch of numbers", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/phone_numbers/jobs/update_phone_numbers", "params": [ { "name": "filter", "value": "", "type": "query", "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]" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 t" }, { "info": { "name": "Retrieve a phone numbers job", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/jobs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the Phone Numbers Job." } ] }, "docs": "Retrieve a phone numbers job" } ] }, { "info": { "name": "Voicemail", "type": "folder" }, "items": [ { "info": { "name": "Get voicemail", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers/:phone_number_id/voicemail", "params": [ { "name": "phone_number_id", "value": "123455678900", "type": "path", "description": "The ID of the phone number." } ] }, "docs": "Returns the voicemail settings for a phone number" }, { "info": { "name": "Create voicemail", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/phone_numbers/:phone_number_id/voicemail", "params": [ { "name": "phone_number_id", "value": "123455678900", "type": "path", "description": "The ID of the phone number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create voicemail settings for a phone number" }, { "info": { "name": "Update voicemail", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/phone_numbers/:phone_number_id/voicemail", "params": [ { "name": "phone_number_id", "value": "123455678900", "type": "path", "description": "The ID of the phone number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update voicemail settings for a phone number" } ] }, { "info": { "name": "Regulatory Requirements", "type": "folder" }, "items": [ { "info": { "name": "Retrieve regulatory requirements for a list of phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/phone_numbers_regulatory_requirements", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[phone_number]" } ] }, "docs": "Retrieve regulatory requirements for a list of phone numbers" }, { "info": { "name": "Retrieve regulatory requirements", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/regulatory_requirements", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[requirement_group_id], filter[country_code], filter[phone_number_type], filter[action]" } ] }, "docs": "Retrieve regulatory requirements" } ] }, { "info": { "name": "Phone Number Porting", "type": "folder" }, "items": [ { "info": { "name": "Run a portability check", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/portability_checks", "body": { "type": "json", "data": "{}" } }, "docs": "Runs a portability check, returning the results immediately." } ] }, { "info": { "name": "Porting Orders", "type": "folder" }, "items": [ { "info": { "name": "List all porting events", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/events", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[type], filter[porting_order_id], filter[created_at][gte], filter[created_at][lte]" } ] }, "docs": "Returns a list of all porting events." }, { "info": { "name": "Show a porting event", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/events/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the porting event." } ] }, "docs": "Show a specific porting event." }, { "info": { "name": "Republish a porting event", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting/events/:id/republish", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the porting event." } ] }, "docs": "Republish a specific porting event." }, { "info": { "name": "List LOA configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/loa_configurations", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "List the LOA configurations." }, { "info": { "name": "Create a LOA configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting/loa_configurations", "body": { "type": "json", "data": "{}" } }, "docs": "Create a LOA configuration." }, { "info": { "name": "Preview the LOA configuration parameters", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting/loa_configurations/preview", "body": { "type": "json", "data": "{}" } }, "docs": "Preview the LOA template that would be generated without need to create LOA configuration." }, { "info": { "name": "Retrieve a LOA configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/loa_configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a LOA configuration." } ] }, "docs": "Retrieve a specific LOA configuration." }, { "info": { "name": "Update a LOA configuration", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/porting/loa_configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a LOA configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a specific LOA configuration." }, { "info": { "name": "Delete a LOA configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting/loa_configurations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a LOA configuration." } ] }, "docs": "Delete a specific LOA configuration." }, { "info": { "name": "Preview a LOA configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/loa_configurations/:id/preview", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a LOA configuration." } ] }, "docs": "Preview a specific LOA configuration." }, { "info": { "name": "List porting related reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/reports", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]" } ] }, "docs": "List the reports generated about porting operations." }, { "info": { "name": "Create a porting related report", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting/reports", "body": { "type": "json", "data": "{}" } }, "docs": "Generate reports about porting operations." }, { "info": { "name": "Retrieve a report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a report." } ] }, "docs": "Retrieve a specific report generated." }, { "info": { "name": "List available carriers in the UK", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting/uk_carriers" }, "docs": "List available carriers in the UK." }, { "info": { "name": "List all porting orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "include_phone_numbers", "value": "", "type": "query", "description": "Include the first 50 phone number objects in the results" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[customer_reference], filter[customer_group_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]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of your porting order." }, { "info": { "name": "Create a porting order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new porting order object." }, { "info": { "name": "List all exception types", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/exception_types" }, "docs": "Returns a list of all possible exception types for a porting order." }, { "info": { "name": "List all phone number configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/phone_number_configurations", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[porting_order.status][in][], filter[porting_phone_number][in][], filter[user_bundle_id][in][]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of phone number configurations paginated." }, { "info": { "name": "Create a list of phone number configurations", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/phone_number_configurations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of phone number configurations." }, { "info": { "name": "Retrieve a porting order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "include_phone_numbers", "value": "", "type": "query", "description": "Include the first 50 phone number objects in the results" } ] }, "docs": "Retrieves the details of an existing porting order." }, { "info": { "name": "Edit a porting order", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/porting_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits the details of an existing porting order.\n\nAny or all of a porting orders attributes may be included in the resource object included in a PATCH request.\n\nIf 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." }, { "info": { "name": "Delete a porting order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Deletes an existing porting order. This operation is restrict to porting orders in draft state." }, { "info": { "name": "Activate every number in a porting order asynchronously.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/actions/activate", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only." }, { "info": { "name": "Cancel a porting order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/actions/cancel", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Cancel a porting order" }, { "info": { "name": "Submit a porting order.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/actions/confirm", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Confirm and submit your porting order." }, { "info": { "name": "Share a porting order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/actions/share", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users." }, { "info": { "name": "List all porting activation jobs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/activation_jobs", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns a list of your porting activation jobs." }, { "info": { "name": "Retrieve a porting activation job", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/activation_jobs/:activationJobId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "activationJobId", "value": "", "type": "path", "description": "Activation Job Identifier" } ] }, "docs": "Returns a porting activation job." }, { "info": { "name": "Update a porting activation job", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/porting_orders/:id/activation_jobs/:activationJobId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "activationJobId", "value": "", "type": "path", "description": "Activation Job Identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the activation time of a porting activation job." }, { "info": { "name": "List additional documents", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/additional_documents", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[document_type]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of additional documents for a porting order." }, { "info": { "name": "Create a list of additional documents", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/additional_documents", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of additional documents for a porting order." }, { "info": { "name": "Delete an additional document", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:id/additional_documents/:additional_document_id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "additional_document_id", "value": "", "type": "path", "description": "Additional document identification." } ] }, "docs": "Deletes an additional document for a porting order." }, { "info": { "name": "List allowed FOC dates", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/allowed_foc_windows", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Returns a list of allowed FOC dates for a porting order." }, { "info": { "name": "List all comments of a porting order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/comments", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns a list of all comments of a porting order." }, { "info": { "name": "Create a comment for a porting order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/comments", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new comment for a porting order." }, { "info": { "name": "Download a porting order loa template", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/loa_template", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "loa_configuration_id", "value": "a36c2277-446b-4d11-b4ea-322e02a5c08d", "type": "query", "description": "The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration will be used." } ] }, "docs": "Download a porting order loa template" }, { "info": { "name": "List porting order requirements", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/requirements", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Returns a list of all requirements based on country/number type for this porting order." }, { "info": { "name": "Retrieve the associated V1 sub_request_id and port_request_id", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/sub_request", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ] }, "docs": "Retrieve the associated V1 sub_request_id and port_request_id" }, { "info": { "name": "List verification codes", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:id/verification_codes", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[verified]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of verification codes for a porting order." }, { "info": { "name": "Send the verification codes", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/verification_codes/send", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send the verification code for all porting phone numbers." }, { "info": { "name": "Verify the verification code for a list of phone numbers", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:id/verification_codes/verify", "params": [ { "name": "id", "value": "", "type": "path", "description": "Porting Order id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verifies the verification code for a list of phone numbers." }, { "info": { "name": "List action requirements for a porting order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/action_requirements", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "The ID of the porting order" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[id][in][], filter[requirement_type_id], filter[action_type], filter[status]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of action requirements for a specific porting order." }, { "info": { "name": "Initiate an action requirement", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/action_requirements/:id/initiate", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "The ID of the porting order" }, { "name": "id", "value": "", "type": "path", "description": "The ID of the action requirement" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiates a specific action requirement for a porting order." }, { "info": { "name": "List all associated phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/associated_phone_numbers", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone numbers" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[action]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "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." }, { "info": { "name": "Create an associated phone number", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/associated_phone_numbers", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete an associated phone number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/associated_phone_numbers/:id", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number" }, { "name": "id", "value": "", "type": "path", "description": "Identifies the associated phone number to be deleted" } ] }, "docs": "Deletes an associated phone number from a porting order." }, { "info": { "name": "List all phone number blocks", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_blocks", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number blocks" }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of all phone number blocks of a porting order." }, { "info": { "name": "Create a phone number block", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_blocks", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number block" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new phone number block." }, { "info": { "name": "Delete a phone number block", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_blocks/:id", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number block" }, { "name": "id", "value": "", "type": "path", "description": "Identifies the phone number block to be deleted" } ] }, "docs": "Deletes a phone number block." }, { "info": { "name": "List all phone number extensions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_extensions", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number extensions" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[porting_phone_number_id]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter (deepObject style). Originally: sort[value]" } ] }, "docs": "Returns a list of all phone number extensions of a porting order." }, { "info": { "name": "Create a phone number extension", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_extensions", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number extension" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new phone number extension." }, { "info": { "name": "Delete a phone number extension", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/porting_orders/:porting_order_id/phone_number_extensions/:id", "params": [ { "name": "porting_order_id", "value": "", "type": "path", "description": "Identifies the Porting Order associated with the phone number extension" }, { "name": "id", "value": "", "type": "path", "description": "Identifies the phone number extension to be deleted" } ] }, "docs": "Deletes a phone number extension." }, { "info": { "name": "List all porting phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/porting_phone_numbers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]" } ] }, "docs": "Returns a list of your porting phone numbers." } ] }, { "info": { "name": "Number Portout", "type": "folder" }, "items": [ { "info": { "name": "List portout requests", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "Returns the portout requests according to filters" }, { "info": { "name": "List all port-out events", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts/events", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[event_type], filter[portout_id], filter[created_at]" } ] }, "docs": "Returns a list of all port-out events." }, { "info": { "name": "Show a port-out event", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts/events/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the port-out event." } ] }, "docs": "Show a specific port-out event." }, { "info": { "name": "Republish a port-out event", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/portouts/events/:id/republish", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the port-out event." } ] }, "docs": "Republish a specific port-out event." }, { "info": { "name": "List eligible port-out rejection codes for a specific order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts/rejections/:portout_id", "params": [ { "name": "portout_id", "value": "", "type": "path", "description": "Identifies a port out order." }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[code], filter[code][in]" } ] }, "docs": "Given a port-out ID, list rejection codes that are eligible for that port-out" }, { "info": { "name": "List port-out related reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts/reports", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[report_type], filter[status]" } ] }, "docs": "List the reports generated about port-out operations." }, { "info": { "name": "Create a port-out related report", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/portouts/reports", "body": { "type": "json", "data": "{}" } }, "docs": "Generate reports about port-out operations." }, { "info": { "name": "Retrieve a report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts/reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies a report." } ] }, "docs": "Retrieve a specific report generated." }, { "info": { "name": "Get a portout request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Portout id" } ] }, "docs": "Returns the portout request based on the ID provided" }, { "info": { "name": "List all comments for a portout request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts/:id/comments", "params": [ { "name": "id", "value": "", "type": "path", "description": "Portout id" } ] }, "docs": "Returns a list of comments for a portout request." }, { "info": { "name": "Create a comment on a portout request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/portouts/:id/comments", "params": [ { "name": "id", "value": "", "type": "path", "description": "Portout id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a comment on a portout request." }, { "info": { "name": "List supporting documents on a portout request", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/portouts/:id/supporting_documents", "params": [ { "name": "id", "value": "", "type": "path", "description": "Portout id" } ] }, "docs": "List every supporting documents for a portout request." }, { "info": { "name": "Create a list of supporting documents on a portout request", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/portouts/:id/supporting_documents", "params": [ { "name": "id", "value": "", "type": "path", "description": "Portout id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a list of supporting documents on a portout request." }, { "info": { "name": "Update Status", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/portouts/:id/:status", "params": [ { "name": "id", "value": "", "type": "path", "description": "Portout id" }, { "name": "status", "value": "", "type": "path", "description": "Updated portout status" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Authorize or reject portout request" } ] }, { "info": { "name": "Private Wireless Gateways", "type": "folder" }, "items": [ { "info": { "name": "Get all Private Wireless Gateways", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/private_wireless_gateways", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "filter[name]", "value": "my private gateway", "type": "query", "description": "The name of the Private Wireless Gateway." }, { "name": "filter[ip_range]", "value": "192.168.0.0/24", "type": "query", "description": "The IP address range of the Private Wireless Gateway." }, { "name": "filter[region_code]", "value": "dc2", "type": "query", "description": "The name of the region where the Private Wireless Gateway is deployed." }, { "name": "filter[created_at]", "value": "2018-02-02T22:25:27.521Z", "type": "query", "description": "Private Wireless Gateway resource creation date." }, { "name": "filter[updated_at]", "value": "2018-02-02T22:25:27.521Z", "type": "query", "description": "When the Private Wireless Gateway was last updated." } ] }, "docs": "Get all Private Wireless Gateways belonging to the user." }, { "info": { "name": "Create a Private Wireless Gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/private_wireless_gateways", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get a Private Wireless Gateway", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/private_wireless_gateways/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the private wireless gateway." } ] }, "docs": "Retrieve information about a Private Wireless Gateway." }, { "info": { "name": "Delete a Private Wireless Gateway", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/private_wireless_gateways/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the private wireless gateway." } ] }, "docs": "Deletes the Private Wireless Gateway." } ] }, { "info": { "name": "Pronunciation Dictionaries", "type": "folder" }, "items": [ { "info": { "name": "List pronunciation dictionaries", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/pronunciation_dicts", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "Page number (1-based). Defaults to 1." }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of results per page. Defaults to 20, maximum 250." } ] }, "docs": "List all pronunciation dictionaries for the authenticated organization. Results are paginated using offset-based pagination." }, { "info": { "name": "Create a pronunciation dictionary", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/pronunciation_dicts", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new pronunciation dictionary for the authenticated organization. Each dictionary contains a list of items that control how specific words are spoken. Items can be alias type (text replacement) or phoneme type (IPA pronunciation notation).\n\nAs an alternative to providing items directly as JSON, you can upload a dictionary file (PLS/XML or plain text format, max 1MB) using multipart/form-data. PLS files use the standard W3C Pronunciation Lexicon Specification XML format. Text files use a " }, { "info": { "name": "Get a pronunciation dictionary", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/pronunciation_dicts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID of the pronunciation dictionary." } ] }, "docs": "Retrieve a single pronunciation dictionary by ID." }, { "info": { "name": "Update a pronunciation dictionary", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/pronunciation_dicts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID of the pronunciation dictionary." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the name and/or items of an existing pronunciation dictionary. Uses optimistic locking — if the dictionary was modified concurrently, the request returns 409 Conflict." }, { "info": { "name": "Delete a pronunciation dictionary", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/pronunciation_dicts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The UUID of the pronunciation dictionary." } ] }, "docs": "Permanently delete a pronunciation dictionary." } ] }, { "info": { "name": "Public Internet Gateways", "type": "folder" }, "items": [ { "info": { "name": "List all Public Internet Gateways", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/public_internet_gateways", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[network_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Public Internet Gateways." }, { "info": { "name": "Create a Public Internet Gateway", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/public_internet_gateways", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Public Internet Gateway." }, { "info": { "name": "Retrieve a Public Internet Gateway", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/public_internet_gateways/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a Public Internet Gateway." }, { "info": { "name": "Delete a Public Internet Gateway", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/public_internet_gateways/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a Public Internet Gateway." } ] }, { "info": { "name": "Queue Commands", "type": "folder" }, "items": [ { "info": { "name": "List queues", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/queues", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load" }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page" } ] }, "docs": "List all queues for the authenticated user." }, { "info": { "name": "Create a queue", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/queues", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new call queue." }, { "info": { "name": "Retrieve a call queue", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/queues/:queue_name", "params": [ { "name": "queue_name", "value": "", "type": "path", "description": "Uniquely identifies the queue by name" } ] }, "docs": "Retrieve an existing call queue" }, { "info": { "name": "Update a queue", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/queues/:queue_name", "params": [ { "name": "queue_name", "value": "", "type": "path", "description": "Uniquely identifies the queue by name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update properties of an existing call queue." }, { "info": { "name": "Delete a queue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/queues/:queue_name", "params": [ { "name": "queue_name", "value": "", "type": "path", "description": "Uniquely identifies the queue by name" } ] }, "docs": "Delete an existing call queue." }, { "info": { "name": "Retrieve calls from a queue", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/queues/:queue_name/calls", "params": [ { "name": "queue_name", "value": "", "type": "path", "description": "Uniquely identifies the queue by name" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[after], page[before], page[limit], page[size], page[number]" } ] }, "docs": "Retrieve the list of calls in an existing queue" }, { "info": { "name": "Retrieve a call from a queue", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/queues/:queue_name/calls/:call_control_id", "params": [ { "name": "queue_name", "value": "", "type": "path", "description": "Uniquely identifies the queue by name" }, { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ] }, "docs": "Retrieve an existing call from an existing queue" }, { "info": { "name": "Update queued call", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/queues/:queue_name/calls/:call_control_id", "params": [ { "name": "queue_name", "value": "", "type": "path", "description": "Uniquely identifies the queue by name" }, { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update queued call's keep_after_hangup flag" }, { "info": { "name": "Force remove a call from a queue", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/queues/:queue_name/calls/:call_control_id", "params": [ { "name": "queue_name", "value": "", "type": "path", "description": "Uniquely identifies the queue by name" }, { "name": "call_control_id", "value": "", "type": "path", "description": "Unique identifier and token for controlling the call" } ] }, "docs": "Removes an inactive call from a queue. If the call is no longer active, use this command to remove it from the queue." } ] }, { "info": { "name": "Regions", "type": "folder" }, "items": [ { "info": { "name": "List all Regions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/regions" }, "docs": "List all regions and the interfaces that region supports" } ] }, { "info": { "name": "MDR Detail Reports", "type": "folder" }, "items": [ { "info": { "name": "Fetch all Mdr records", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/reports/mdrs", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Pagination start date" }, { "name": "end_date", "value": "", "type": "query", "description": "Pagination end date" }, { "name": "id", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" }, { "name": "profile", "value": "", "type": "query" }, { "name": "cld", "value": "", "type": "query" }, { "name": "cli", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "message_type", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch all Mdr records " } ] }, { "info": { "name": "WDR Detail Reports", "type": "folder" }, "items": [ { "info": { "name": "Fetches all Wdr records", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/reports/wdrs", "params": [ { "name": "start_date", "value": "", "type": "query", "description": "Start date" }, { "name": "end_date", "value": "", "type": "query", "description": "End date" }, { "name": "id", "value": "", "type": "query" }, { "name": "mcc", "value": "", "type": "query" }, { "name": "mnc", "value": "", "type": "query" }, { "name": "imsi", "value": "", "type": "query" }, { "name": "sim_group_name", "value": "", "type": "query" }, { "name": "sim_group_id", "value": "", "type": "query" }, { "name": "sim_card_id", "value": "", "type": "query" }, { "name": "phone_number", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "Fetch all Wdr records " } ] }, { "info": { "name": "Requirement Types", "type": "folder" }, "items": [ { "info": { "name": "List all requirement types", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/requirement_types", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter for requirement types (deepObject style). Originally: filter[name]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter for requirement types (deepObject style). Originally: sort[]" } ] }, "docs": "List all requirement types ordered by created_at descending" }, { "info": { "name": "Retrieve a requirement types", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/requirement_types/:id", "params": [ { "name": "id", "value": "a38c217a-8019-48f8-bff6-0fdd9939075b", "type": "path", "description": "Uniquely identifies the requirement_type record" } ] }, "docs": "Retrieve a requirement type by id" } ] }, { "info": { "name": "Requirements", "type": "folder" }, "items": [ { "info": { "name": "List all requirements", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/requirements", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter for requirements (deepObject style). Originally: filter[country_code], filter[phone_number_type], filter[action]" }, { "name": "sort", "value": "", "type": "query", "description": "Consolidated sort parameter for requirements (deepObject style). Originally: sort[]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "List all requirements with filtering, sorting, and pagination" }, { "info": { "name": "Retrieve a document requirement", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/requirements/:id", "params": [ { "name": "id", "value": "a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa", "type": "path", "description": "Uniquely identifies the requirement_type record" } ] }, "docs": "Retrieve a document requirement record" } ] }, { "info": { "name": "Room Compositions", "type": "folder" }, "items": [ { "info": { "name": "View a list of room compositions.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_compositions", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "View a list of room compositions." }, { "info": { "name": "Create a room composition.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/room_compositions", "body": { "type": "json", "data": "{}" } }, "docs": "Asynchronously create a room composition." }, { "info": { "name": "View a room composition.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_compositions/:room_composition_id", "params": [ { "name": "room_composition_id", "value": "", "type": "path", "description": "The unique identifier of a room composition." } ] }, "docs": "View a room composition." }, { "info": { "name": "Delete a room composition.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/room_compositions/:room_composition_id", "params": [ { "name": "room_composition_id", "value": "", "type": "path", "description": "The unique identifier of a room composition." } ] }, "docs": "Synchronously delete a room composition." } ] }, { "info": { "name": "Room Participants", "type": "folder" }, "items": [ { "info": { "name": "View a list of room participants.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_participants", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "View a list of room participants." }, { "info": { "name": "View a room participant.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_participants/:room_participant_id", "params": [ { "name": "room_participant_id", "value": "", "type": "path", "description": "The unique identifier of a room participant." } ] }, "docs": "View a room participant." } ] }, { "info": { "name": "Room Recordings", "type": "folder" }, "items": [ { "info": { "name": "View a list of room recordings.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_recordings", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "View a list of room recordings." }, { "info": { "name": "Delete several room recordings in a bulk.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/room_recordings", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Delete several room recordings in a bulk." }, { "info": { "name": "View a room recording.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_recordings/:room_recording_id", "params": [ { "name": "room_recording_id", "value": "", "type": "path", "description": "The unique identifier of a room recording." } ] }, "docs": "View a room recording." }, { "info": { "name": "Delete a room recording.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/room_recordings/:room_recording_id", "params": [ { "name": "room_recording_id", "value": "", "type": "path", "description": "The unique identifier of a room recording." } ] }, "docs": "Synchronously delete a Room Recording." } ] }, { "info": { "name": "Room Sessions", "type": "folder" }, "items": [ { "info": { "name": "View a list of room sessions.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_sessions", "params": [ { "name": "include_participants", "value": "", "type": "query", "description": "To decide if room participants should be included in the response." }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "View a list of room sessions." }, { "info": { "name": "View a room session.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_sessions/:room_session_id", "params": [ { "name": "room_session_id", "value": "", "type": "path", "description": "The unique identifier of a room session." }, { "name": "include_participants", "value": "", "type": "query", "description": "To decide if room participants should be included in the response." } ] }, "docs": "View a room session." }, { "info": { "name": "End a room session.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/room_sessions/:room_session_id/actions/end", "params": [ { "name": "room_session_id", "value": "", "type": "path", "description": "The unique identifier of a room session." } ] }, "docs": "Note: this will also kick all participants currently present in the room" }, { "info": { "name": "Kick participants from a room session.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/room_sessions/:room_session_id/actions/kick", "params": [ { "name": "room_session_id", "value": "", "type": "path", "description": "The unique identifier of a room session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Kick participants from a room session." }, { "info": { "name": "Mute participants in room session.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/room_sessions/:room_session_id/actions/mute", "params": [ { "name": "room_session_id", "value": "", "type": "path", "description": "The unique identifier of a room session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mute participants in room session." }, { "info": { "name": "Unmute participants in room session.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/room_sessions/:room_session_id/actions/unmute", "params": [ { "name": "room_session_id", "value": "", "type": "path", "description": "The unique identifier of a room session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unmute participants in room session." }, { "info": { "name": "View a list of room participants.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/room_sessions/:room_session_id/participants", "params": [ { "name": "room_session_id", "value": "", "type": "path", "description": "The unique identifier of a room session." }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "View a list of room participants." } ] }, { "info": { "name": "Rooms", "type": "folder" }, "items": [ { "info": { "name": "View a list of rooms.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/rooms", "params": [ { "name": "include_sessions", "value": "", "type": "query", "description": "To decide if room sessions should be included in the response." }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "View a list of rooms." }, { "info": { "name": "Create a room.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/rooms", "body": { "type": "json", "data": "{}" } }, "docs": "Synchronously create a Room." }, { "info": { "name": "View a room.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/rooms/:room_id", "params": [ { "name": "room_id", "value": "", "type": "path", "description": "The unique identifier of a room." }, { "name": "include_sessions", "value": "", "type": "query", "description": "To decide if room sessions should be included in the response." } ] }, "docs": "View a room." }, { "info": { "name": "Update a room.", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/rooms/:room_id", "params": [ { "name": "room_id", "value": "", "type": "path", "description": "The unique identifier of a room." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Synchronously update a Room." }, { "info": { "name": "Delete a room.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/rooms/:room_id", "params": [ { "name": "room_id", "value": "", "type": "path", "description": "The unique identifier of a room." } ] }, "docs": "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." }, { "info": { "name": "View a list of room sessions.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/rooms/:room_id/sessions", "params": [ { "name": "room_id", "value": "", "type": "path", "description": "The unique identifier of a room." }, { "name": "include_participants", "value": "", "type": "query", "description": "To decide if room participants should be included in the response." }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "View a list of room sessions." } ] }, { "info": { "name": "Rooms Client Tokens", "type": "folder" }, "items": [ { "info": { "name": "Create Client Token to join a room.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/rooms/:room_id/actions/generate_join_client_token", "params": [ { "name": "room_id", "value": "", "type": "path", "description": "The unique identifier of a room." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`." }, { "info": { "name": "Refresh Client Token to join a room.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/rooms/:room_id/actions/refresh_client_token", "params": [ { "name": "room_id", "value": "", "type": "path", "description": "The unique identifier of a room." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`." } ] }, { "info": { "name": "Session Analysis", "type": "folder" }, "items": [ { "info": { "name": "Get metadata overview", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/session_analysis/metadata" }, "docs": "Returns all available record types and supported query parameters for session analysis." }, { "info": { "name": "Get record type metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/session_analysis/metadata/:record_type", "params": [ { "name": "record_type", "value": "", "type": "path", "description": "The record type identifier (e.g. \"call-control\")." } ] }, "docs": "Returns detailed metadata for a specific record type, including relationships and examples." }, { "info": { "name": "Get session analysis", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/session_analysis/:record_type/:event_id", "params": [ { "name": "record_type", "value": "", "type": "path", "description": "The record type identifier." }, { "name": "event_id", "value": "", "type": "path", "description": "The event identifier (UUID)." }, { "name": "include_children", "value": "", "type": "query", "description": "Whether to include child events in the response." }, { "name": "max_depth", "value": "", "type": "query", "description": "Maximum traversal depth for the event tree." }, { "name": "expand", "value": "", "type": "query", "description": "Controls what data to expand on each event node." }, { "name": "date_time", "value": "", "type": "query", "description": "ISO 8601 timestamp or date to narrow index selection for faster lookups. Accepts full datetime (e.g., 2026-03-17T10:00:00Z) or date-only format (e.g., 2026-03-17)." } ] }, "docs": "Retrieves a full session analysis tree for a given event, including costs, child events, and product linkages." } ] }, { "info": { "name": "SETI Observability", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Black Box Test Results", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/seti/black_box_test_results", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[product]" } ] }, "docs": "Returns the results of the various black box tests" } ] }, { "info": { "name": "Short Codes", "type": "folder" }, "items": [ { "info": { "name": "List short codes", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/short_codes", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[messaging_profile_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List short codes" }, { "info": { "name": "Retrieve a short code", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/short_codes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the short code" } ] }, "docs": "Retrieve a short code" }, { "info": { "name": "Update short code", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/short_codes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the short code" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\nTo add or update tags, include the tags field as an array of strings." } ] }, { "info": { "name": "SIM Card Group Actions", "type": "folder" }, "items": [ { "info": { "name": "List SIM card group actions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_group_actions", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "filter[sim_card_group_id]", "value": "", "type": "query", "description": "A valid SIM card group ID." }, { "name": "filter[status]", "value": "", "type": "query", "description": "Filter by a specific status of the resource's lifecycle." }, { "name": "filter[type]", "value": "", "type": "query", "description": "Filter by action type." } ] }, "docs": "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." }, { "info": { "name": "Get SIM card group action details", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_group_actions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation." } ] }, { "info": { "name": "SIM Card Groups", "type": "folder" }, "items": [ { "info": { "name": "Get all SIM card groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_groups", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "filter[name]", "value": "", "type": "query", "description": "A valid SIM card group name." }, { "name": "filter[private_wireless_gateway_id]", "value": "", "type": "query", "description": "A Private Wireless Gateway ID associated with the group." }, { "name": "filter[wireless_blocklist_id]", "value": "", "type": "query", "description": "A Wireless Blocklist ID associated with the group." } ] }, "docs": "Get all SIM card groups belonging to the user that match the given filters." }, { "info": { "name": "Create a SIM card group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_card_groups", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new SIM card group object" }, { "info": { "name": "Get SIM card group", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM group." }, { "name": "include_iccids", "value": "", "type": "query", "description": "It includes a list of associated ICCIDs." } ] }, "docs": "Returns the details regarding a specific SIM card group" }, { "info": { "name": "Update a SIM card group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/sim_card_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a SIM card group" }, { "info": { "name": "Delete a SIM card group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/sim_card_groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM group." } ] }, "docs": "Permanently deletes a SIM card group" }, { "info": { "name": "Request Private Wireless Gateway removal from SIM card group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_card_groups/:id/actions/remove_private_wireless_gateway", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM group." } ] }, "docs": "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." }, { "info": { "name": "Request Wireless Blocklist removal from SIM card group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_card_groups/:id/actions/remove_wireless_blocklist", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM group." } ] }, "docs": "This action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group." }, { "info": { "name": "Request Private Wireless Gateway assignment for SIM card group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_card_groups/:id/actions/set_private_wireless_gateway", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Request Wireless Blocklist assignment for SIM card group", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_card_groups/:id/actions/set_wireless_blocklist", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the SIM group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group." } ] }, { "info": { "name": "SIM Card Orders", "type": "folder" }, "items": [ { "info": { "name": "Preview SIM card orders", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_card_order_preview", "body": { "type": "json", "data": "{}" } }, "docs": "Preview SIM card order purchases." }, { "info": { "name": "Get all SIM card orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_orders", "params": [ { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated pagination parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "Get all SIM card orders according to filters." }, { "info": { "name": "Create a SIM card order", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/sim_card_orders", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new order for SIM cards." }, { "info": { "name": "Get a single SIM card order", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/sim_card_orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Get a single SIM card order by its ID." } ] }, { "info": { "name": "SIPREC Connectors", "type": "folder" }, "items": [ { "info": { "name": "Create a SIPREC connector", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/siprec_connectors", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new SIPREC connector configuration." }, { "info": { "name": "Retrieve a SIPREC connector", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/siprec_connectors/:connector_name", "params": [ { "name": "connector_name", "value": "", "type": "path", "description": "Uniquely identifies a SIPREC connector." } ] }, "docs": "Returns details of a stored SIPREC connector." }, { "info": { "name": "Update a SIPREC connector", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/siprec_connectors/:connector_name", "params": [ { "name": "connector_name", "value": "", "type": "path", "description": "Uniquely identifies a SIPREC connector." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a stored SIPREC connector configuration." }, { "info": { "name": "Delete a SIPREC connector", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/siprec_connectors/:connector_name", "params": [ { "name": "connector_name", "value": "", "type": "path", "description": "Uniquely identifies a SIPREC connector." } ] }, "docs": "Deletes a stored SIPREC connector." } ] }, { "info": { "name": "Speech To Text over WebSockets", "type": "folder" }, "items": [ { "info": { "name": "Speech to text over WebSocket", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/speech-to-text/transcription", "params": [ { "name": "transcription_engine", "value": "Telnyx", "type": "query", "description": "The transcription engine to use for processing the audio stream." }, { "name": "input_format", "value": "mp3", "type": "query", "description": "The format of input audio stream." }, { "name": "language", "value": "en-US", "type": "query", "description": "The language spoken in the audio stream." }, { "name": "interim_results", "value": "true", "type": "query", "description": "Whether to receive interim transcription results." }, { "name": "model", "value": "", "type": "query", "description": "The specific model to use within the selected transcription engine." }, { "name": "endpointing", "value": "500", "type": "query", "description": "Silence duration (in milliseconds) that triggers end-of-speech detection. When set, the engine uses this value to determine when a speaker has stopped talking. Supported by `xAI`, `Deepgram`, `Google`, and `Speechmatics`. Other engines may not support this parameter." }, { "name": "redact", "value": "pci", "type": "query", "description": "Enable redaction of sensitive information (e.g., PCI data, SSN) from transcription results. Supported values depend on the transcription engine." }, { "name": "keyterm", "value": "Telnyx", "type": "query", "description": "A key term to boost in the transcription. The engine will be more likely to recognize this term. Can be specified multiple times for multiple terms." }, { "name": "keywords", "value": "Telnyx,SIP,WebRTC", "type": "query", "description": "Comma-separated list of keywords to boost in the transcription. The engine will prioritize recognition of these words." } ] }, "docs": "Open a WebSocket connection to stream audio and receive transcriptions in real-time. Authentication is provided via the standard `Authorization: Bearer ` header.\n\nSupported engines: `Azure`, `Deepgram`, `Google`, `Telnyx`, `xAI`, `Speechmatics`.\n\n**Connection flow:**\n1. Open WebSocket with query parameters specifying engine, input format, and language.\n2. Send binary audio frames (mp3/wav format).\n3. Receive JSON transcript frames with `transcript`, `is_final`, and `confidence` fields.\n" } ] }, { "info": { "name": "Bucket SSL Certificate", "type": "folder" }, "items": [ { "info": { "name": "Get Bucket SSL Certificate", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/storage/buckets/:bucketName/ssl_certificate", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket" } ] }, "docs": "Returns the stored certificate detail of a bucket, if applicable." }, { "info": { "name": "Add SSL Certificate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telnyx.com/v2/storage/buckets/:bucketName/ssl_certificate", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket" } ], "body": { "type": "multipart-form", "data": [ { "name": "certificate", "type": "text", "value": "" }, { "name": "private_key", "type": "text", "value": "" } ] } }, "docs": "Uploads an SSL certificate and its matching secret so that you can use Telnyx's storage as your CDN." }, { "info": { "name": "Remove SSL Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/storage/buckets/:bucketName/ssl_certificate", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "Bucket Name" } ] }, "docs": "Deletes an SSL certificate and its matching secret." } ] }, { "info": { "name": "Bucket Usage", "type": "folder" }, "items": [ { "info": { "name": "Get API Usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/storage/buckets/:bucketName/usage/api", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket" }, { "name": "filter", "value": "[object Object]", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[start_time], filter[end_time]" } ] }, "docs": "Returns the detail on API usage on a bucket of a particular time period, group by method category." }, { "info": { "name": "Get Bucket Usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/storage/buckets/:bucketName/usage/storage", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket" } ] }, "docs": "Returns the amount of storage space and number of files a bucket takes up." } ] }, { "info": { "name": "Presigned Object URLs", "type": "folder" }, "items": [ { "info": { "name": "Create Presigned Object URL", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/storage/buckets/:bucketName/:objectName/presigned_url", "params": [ { "name": "bucketName", "value": "", "type": "path", "description": "The name of the bucket" }, { "name": "objectName", "value": "", "type": "path", "description": "The name of the object" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns a timed and authenticated URL to download (GET) or upload (PUT) an object. This is the equivalent to AWS S3’s “presigned” 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" } ] }, { "info": { "name": "Data Migration", "type": "folder" }, "items": [ { "info": { "name": "List Migration Source coverage", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/storage/migration_source_coverage" }, "docs": "List Migration Source coverage" }, { "info": { "name": "List all Migration Sources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/storage/migration_sources" }, "docs": "List all Migration Sources" }, { "info": { "name": "Create a Migration Source", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/storage/migration_sources", "body": { "type": "json", "data": "{}" } }, "docs": "Create a source from which data can be migrated from." }, { "info": { "name": "Get a Migration Source", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/storage/migration_sources/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the data migration source." } ] }, "docs": "Get a Migration Source" }, { "info": { "name": "Delete a Migration Source", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/storage/migration_sources/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the data migration source." } ] }, "docs": "Delete a Migration Source" }, { "info": { "name": "List all Migrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/storage/migrations" }, "docs": "List all Migrations" }, { "info": { "name": "Create a Migration", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/storage/migrations", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate a migration of data from an external provider into Telnyx Cloud Storage. Currently, only S3 is supported." }, { "info": { "name": "Get a Migration", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/storage/migrations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the data migration." } ] }, "docs": "Get a Migration" }, { "info": { "name": "Stop a Migration", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/storage/migrations/:id/actions/stop", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier for the data migration." } ] }, "docs": "Stop a Migration" } ] }, { "info": { "name": "Credentials", "type": "folder" }, "items": [ { "info": { "name": "List all credentials", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/telephony_credentials", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[tag], filter[name], filter[status], filter[resource_id], filter[sip_username]" } ] }, "docs": "List all On-demand Credentials." }, { "info": { "name": "Create a credential", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/telephony_credentials", "body": { "type": "json", "data": "{}" } }, "docs": "Create a credential." }, { "info": { "name": "Get a credential", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/telephony_credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Get the details of an existing On-demand Credential." }, { "info": { "name": "Update a credential", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/telephony_credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing credential." }, { "info": { "name": "Delete a credential", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/telephony_credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete an existing credential." } ] }, { "info": { "name": "Access Tokens", "type": "folder" }, "items": [ { "info": { "name": "Create an Access Token.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/telephony_credentials/:id/token", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Create an Access Token (JWT) for the credential." } ] }, { "info": { "name": "Terms of Service", "type": "folder" }, "items": [ { "info": { "name": "Agree to Number Reputation Terms of Service", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/terms_of_service/number_reputation/agree" }, "docs": "Accept the Terms of Service for the Number Reputation product. Must be called before using Number Reputation endpoints.\n\nReturns `400` with error code `10015` if the user has already agreed to the current ToS version." } ] }, { "info": { "name": "TeXML REST Commands", "type": "folder" }, "items": [ { "info": { "name": "Fetch multiple call resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "Page", "value": "1", "type": "query", "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" }, { "name": "PageToken", "value": "", "type": "query", "description": "Used to request the next page of results." }, { "name": "To", "value": "+1312345678", "type": "query", "description": "Filters calls by the to number." }, { "name": "From", "value": "+1312345678", "type": "query", "description": "Filters calls by the from number." }, { "name": "Status", "value": "no-answer", "type": "query", "description": "Filters calls by status." }, { "name": "StartTime", "value": "2023-05-22", "type": "query", "description": "Filters calls by their start date. Expected format is YYYY-MM-DD." }, { "name": "StartTime_gt", "value": "2023-05-22", "type": "query", "description": "Filters calls by their start date (after). Expected format is YYYY-MM-DD" }, { "name": "StartTime_lt", "value": "2023-05-22", "type": "query", "description": "Filters calls by their start date (before). Expected format is YYYY-MM-DD" }, { "name": "EndTime", "value": "2023-05-22", "type": "query", "description": "Filters calls by their end date. Expected format is YYYY-MM-DD" }, { "name": "EndTime_gt", "value": "2023-05-22", "type": "query", "description": "Filters calls by their end date (after). Expected format is YYYY-MM-DD" }, { "name": "EndTime_lt", "value": "2023-05-22", "type": "query", "description": "Filters calls by their end date (before). Expected format is YYYY-MM-DD" } ] }, "docs": "Returns multiple call resouces for an account. This endpoint is eventually consistent." }, { "info": { "name": "Initiate an outbound call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal." }, { "info": { "name": "Fetch a call", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid", "params": [ { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." } ] }, "docs": "Returns an individual call identified by its CallSid. This endpoint is eventually consistent." }, { "info": { "name": "Update call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid", "params": [ { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example." }, { "info": { "name": "Fetch recordings for a call", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Recordings.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." } ] }, "docs": "Returns recordings for a call identified by call_sid." }, { "info": { "name": "Request recording for a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Recordings.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Starts recording with specified parameters for call idientified by call_sid." }, { "info": { "name": "Update recording on a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Recordings/:recording_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "recording_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording by id." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates recording resource for particular call." }, { "info": { "name": "Request siprec session for a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Siprec.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Starts siprec session with specified parameters for call idientified by call_sid." }, { "info": { "name": "Updates siprec session for a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Siprec/:siprec_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "siprec_sid", "value": "", "type": "path", "description": "The SiprecSid that uniquely identifies the Sip Recording." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates siprec session identified by siprec_sid." }, { "info": { "name": "Start streaming media from a call.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Streams.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Starts streaming media from a call to a specific WebSocket address." }, { "info": { "name": "Update streaming on a call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid/Streams/:streaming_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "call_sid", "value": "", "type": "path", "description": "The CallSid that identifies the call to update." }, { "name": "streaming_sid", "value": "", "type": "path", "description": "Uniquely identifies the streaming by id." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates streaming resource for particular call." }, { "info": { "name": "List conference resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "Page", "value": "1", "type": "query", "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" }, { "name": "PageToken", "value": "", "type": "query", "description": "Used to request the next page of results." }, { "name": "FriendlyName", "value": "weekly_review_call", "type": "query", "description": "Filters conferences by their friendly name." }, { "name": "Status", "value": "in-progress", "type": "query", "description": "Filters conferences by status." }, { "name": "DateCreated", "value": ">=2023-05-22", "type": "query", "description": "Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateCreated>=2023-05-22." }, { "name": "DateUpdated", "value": ">=2023-05-22", "type": "query", "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." } ] }, "docs": "Lists conference resources." }, { "info": { "name": "Fetch a conference resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ] }, "docs": "Returns a conference resource." }, { "info": { "name": "Update a conference resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates a conference resource." }, { "info": { "name": "List conference participants", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ] }, "docs": "Lists conference participants" }, { "info": { "name": "Dial a new conference participant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Dials a new conference participant" }, { "info": { "name": "Get conference participant resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid_or_participant_label", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." }, { "name": "call_sid_or_participant_label", "value": "", "type": "path", "description": "CallSid or Label of the Participant to update." } ] }, "docs": "Gets conference participant resource" }, { "info": { "name": "Update a conference participant", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid_or_participant_label", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." }, { "name": "call_sid_or_participant_label", "value": "", "type": "path", "description": "CallSid or Label of the Participant to update." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates a conference participant" }, { "info": { "name": "Delete a conference participant", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Participants/:call_sid_or_participant_label", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." }, { "name": "call_sid_or_participant_label", "value": "", "type": "path", "description": "CallSid or Label of the Participant to update." } ] }, "docs": "Deletes a conference participant" }, { "info": { "name": "List conference recordings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Recordings", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ] }, "docs": "Lists conference recordings" }, { "info": { "name": "Fetch recordings for a conference", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Conferences/:conference_sid/Recordings.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "conference_sid", "value": "", "type": "path", "description": "The ConferenceSid that uniquely identifies a conference." } ] }, "docs": "Returns recordings for a conference identified by conference_sid." }, { "info": { "name": "List queue resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "Page", "value": "1", "type": "query", "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" }, { "name": "PageToken", "value": "", "type": "query", "description": "Used to request the next page of results." }, { "name": "DateCreated", "value": ">=2023-05-22", "type": "query", "description": "Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateCreated>=2023-05-22." }, { "name": "DateUpdated", "value": ">=2023-05-22", "type": "query", "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." } ] }, "docs": "Lists queue resources." }, { "info": { "name": "Create a new queue", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Creates a new queue resource." }, { "info": { "name": "Fetch a queue resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues/:queue_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "queue_sid", "value": "", "type": "path", "description": "The QueueSid that identifies the call queue." } ] }, "docs": "Returns a queue resource." }, { "info": { "name": "Update a queue resource", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues/:queue_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "queue_sid", "value": "", "type": "path", "description": "The QueueSid that identifies the call queue." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates a queue resource." }, { "info": { "name": "Delete a queue resource", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Queues/:queue_sid", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "queue_sid", "value": "", "type": "path", "description": "The QueueSid that identifies the call queue." } ] }, "docs": "Delete a queue resource." }, { "info": { "name": "Fetch multiple recording resources", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Recordings.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "Page", "value": "1", "type": "query", "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" }, { "name": "DateCreated", "value": "", "type": "query", "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." } ] }, "docs": "Returns multiple recording resources for an account." }, { "info": { "name": "Fetch recording resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Recordings/:recording_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "recording_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording by id." } ] }, "docs": "Returns recording resource identified by recording id." }, { "info": { "name": "Delete recording resource", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Recordings/:recording_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "recording_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording by id." } ] }, "docs": "Deletes recording resource identified by recording id." }, { "info": { "name": "List recording transcriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Transcriptions.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "PageToken", "value": "", "type": "query", "description": "Used to request the next page of results." }, { "name": "PageSize", "value": "10", "type": "query", "description": "The number of records to be displayed on a page" } ] }, "docs": "Returns multiple recording transcription resources for an account." }, { "info": { "name": "Fetch a recording transcription resource", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Transcriptions/:recording_transcription_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "recording_transcription_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording transcription by id." } ] }, "docs": "Returns the recording transcription resource identified by its ID." }, { "info": { "name": "Delete a recording transcription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml/Accounts/:account_sid/Transcriptions/:recording_transcription_sid.json", "params": [ { "name": "account_sid", "value": "", "type": "path", "description": "The id of the account the resource belongs to." }, { "name": "recording_transcription_sid", "value": "", "type": "path", "description": "Uniquely identifies the recording transcription by id." } ] }, "docs": "Permanently deletes a recording transcription." }, { "info": { "name": "Initiate an outbound AI call", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/ai_calls/:connection_id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "The ID of the TeXML connection to use for the call." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate an outbound AI call with warm-up support. Validates parameters, builds an internal TeXML with an AI Assistant configuration, encodes instructions into client state, and calls the dial API. The Twiml, Texml, and Url parameters are not allowed and will result in a 422 error." }, { "info": { "name": "Create a TeXML secret", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml/secrets", "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] }, { "info": { "name": "TeXML Applications", "type": "folder" }, "items": [ { "info": { "name": "List all TeXML Applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml_applications", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[outbound_voice_profile_id], filter[friendly_name]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
If not given, results are sorted by created_at in descending order." } ] }, "docs": "Returns a list of your TeXML Applications." }, { "info": { "name": "Creates a TeXML Application", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/texml_applications", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a TeXML Application." }, { "info": { "name": "Retrieve a TeXML Application", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/texml_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieves the details of an existing TeXML Application." }, { "info": { "name": "Update a TeXML Application", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/texml_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing TeXML Application." }, { "info": { "name": "Deletes a TeXML Application", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/texml_applications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Deletes a TeXML Application." } ] }, { "info": { "name": "Text To Speech Commands", "type": "folder" }, "items": [ { "info": { "name": "Stream text to speech over WebSocket", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/text-to-speech/speech", "params": [ { "name": "voice", "value": "", "type": "query", "description": "Voice identifier in the format `provider.model_id.voice_id` or `provider.voice_id` (e.g. `telnyx.NaturalHD.Telnyx_Alloy`, `Telnyx.Ultra.`, or `azure.en-US-AvaMultilingualNeural`). When provided, the `provider`, `model_id`, and `voice_id` are extracted automatically. Takes precedence over individual `provider`/`model_id`/`voice_id` parameters." }, { "name": "provider", "value": "", "type": "query", "description": "TTS provider. Defaults to `telnyx` if not specified. Ignored when `voice` is provided." }, { "name": "model_id", "value": "", "type": "query", "description": "Model identifier for the chosen provider. Examples: `Natural`, `NaturalHD`, `Ultra` (Telnyx); `Polly.Generative` (AWS)." }, { "name": "voice_id", "value": "", "type": "query", "description": "Voice identifier for the chosen provider." }, { "name": "disable_cache", "value": "", "type": "query", "description": "When `true`, bypass the audio cache and generate fresh audio." }, { "name": "audio_format", "value": "", "type": "query", "description": "Audio output format override. Supported for Telnyx models. `pcm` and `wav` are available for `Natural`/`NaturalHD` models. The `Ultra` model outputs PCM at 24kHz s16le or MP3 at 128kbps 24kHz." }, { "name": "socket_id", "value": "", "type": "query", "description": "Client-provided socket identifier for tracking. If not provided, one is generated server-side." } ] }, "docs": "Open a WebSocket connection to stream text and receive synthesized audio in real time. Authentication is provided via the standard `Authorization: Bearer ` header. Send JSON frames with text to synthesize; receive JSON frames containing base64-encoded audio chunks.\n\nSupported providers: `aws`, `telnyx`, `azure`, `murfai`, `minimax`, `rime`, `resemble`, `elevenlabs`, `xai`.\n\n**Connection flow:**\n1. Open WebSocket with query parameters specifying provider, voice, and model.\n2. Send an ini" }, { "info": { "name": "Generate speech from text", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/text-to-speech/speech", "body": { "type": "json", "data": "{}" } }, "docs": "Generate synthesized speech audio from text input. Returns audio in the requested format (binary audio stream, base64-encoded JSON, or an audio URL for later retrieval).\n\nAuthentication is provided via the standard `Authorization: Bearer ` header.\n\nThe `voice` parameter provides a convenient shorthand to specify provider, model, and voice in a single string (e.g. `telnyx.NaturalHD.Alloy` or `Telnyx.Ultra.`). Alternatively, specify `provider` explicitly along with provider-spec" }, { "info": { "name": "List available voices", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/text-to-speech/voices", "params": [ { "name": "provider", "value": "", "type": "query", "description": "Filter voices by provider. If omitted, voices from all providers are returned." }, { "name": "api_key", "value": "", "type": "query", "description": "API key for providers that require one to list voices (e.g. ElevenLabs)." } ] }, "docs": "Retrieve a list of available voices from one or all TTS providers. When `provider` is specified, returns voices for that provider only. Otherwise, returns voices from all providers.\n\nSome providers (ElevenLabs, Resemble) require an API key to list voices." } ] }, { "info": { "name": "Traffic Policy Profiles", "type": "folder" }, "items": [ { "info": { "name": "Get all traffic policy profiles", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/traffic_policy_profiles", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "filter[type]", "value": "whitelist", "type": "query", "description": "Filter by traffic policy profile type." }, { "name": "filter[service]", "value": "service_123", "type": "query", "description": "Filter by service ID." }, { "name": "sort", "value": "", "type": "query", "description": "Sorts traffic policy profiles by the given field. Defaults to ascending order unless field is prefixed with a minus sign." } ] }, "docs": "Get all traffic policy profiles belonging to the user that match the given filters." }, { "info": { "name": "Create a traffic policy profile", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/traffic_policy_profiles", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new traffic policy profile. At least one of `services`, `ip_ranges`, or `domains` must be provided." }, { "info": { "name": "Get all available traffic policy profile services", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/traffic_policy_profiles/services", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "filter[group]", "value": "Social Media", "type": "query", "description": "Filter services by group." }, { "name": "filter[name]", "value": "Netflix", "type": "query", "description": "Filter services by name." } ] }, "docs": "Get all available PCEF services that can be used in traffic policy profiles." }, { "info": { "name": "Get a traffic policy profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/traffic_policy_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the traffic policy profile." } ] }, "docs": "Returns the details regarding a specific traffic policy profile." }, { "info": { "name": "Update a traffic policy profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/traffic_policy_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the traffic policy profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a traffic policy profile." }, { "info": { "name": "Delete a traffic policy profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/traffic_policy_profiles/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the traffic policy profile." } ] }, "docs": "Deletes the traffic policy profile." } ] }, { "info": { "name": "UAC Connections", "type": "folder" }, "items": [ { "info": { "name": "List UAC connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/uac_connections", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
    \n
  • \n connection_name: sorts the result by the\n connection_name field in ascending order.\n
    • \n\n
  • \n -connection_name: sorts the result by the\n connection_name field in descending order.\n
    • \n

If not given, results are sorted by created_at in descending order." } ] }, "docs": "Returns a list of your UAC connections. A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration." }, { "info": { "name": "Create a UAC connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/uac_connections", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a UAC connection. A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration." }, { "info": { "name": "Retrieve a UAC connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/uac_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieves the details of an existing UAC connection." }, { "info": { "name": "Update a UAC connection", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/uac_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings of an existing UAC connection." }, { "info": { "name": "Delete a UAC connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/uac_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Deletes an existing UAC connection." }, { "info": { "name": "Check a UAC Connection Registration Status", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/uac_connections/:id/actions/check_registration_status", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Checks the registration status for a UAC connection (`registration_status`) as well as the timestamp for the last SIP registration event (`registration_status_updated_at`)." } ] }, { "info": { "name": "Usage Reports (BETA)", "type": "folder" }, "items": [ { "info": { "name": "Get Telnyx product usage data (BETA)", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/usage_reports", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "product", "value": "", "type": "query", "description": "Telnyx product" }, { "name": "dimensions", "value": "", "type": "query", "description": "Breakout by specified product dimensions" }, { "name": "metrics", "value": "", "type": "query", "description": "Specified product usage values" }, { "name": "start_date", "value": "", "type": "query", "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" }, { "name": "end_date", "value": "", "type": "query", "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" }, { "name": "date_range", "value": "", "type": "query", "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." }, { "name": "filter", "value": "", "type": "query", "description": "Filter records on dimensions" }, { "name": "managed_accounts", "value": "", "type": "query", "description": "Return the aggregations for all Managed Accounts under the user making the request." }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results" }, { "name": "format", "value": "", "type": "query", "description": "Specify the response format (csv or json). JSON is returned by default, even if not specified." }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get Telnyx usage data by product, broken out by the specified dimensions" }, { "info": { "name": "Get Usage Reports query options (BETA)", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/usage_reports/options", "headers": [ { "name": "authorization_bearer", "value": "" } ], "params": [ { "name": "product", "value": "", "type": "query", "description": "Options (dimensions and metrics) for a given product. If none specified, all products will be returned." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions" } ] }, { "info": { "name": "UserAddresses", "type": "folder" }, "items": [ { "info": { "name": "List all user addresses", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/user_addresses", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" }, { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[customer_reference][eq], filter[customer_reference][contains], filter[street_address][contains]" }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
    \n
  • \n street_address: sorts the result by the\n street_address field in ascending order.\n
    • \n\n
  • \n -street_address: sorts the result by the\n street_address field in descending order.\n
    • \n

If not given, results are sorted by created_at in descending order." } ] }, "docs": "Returns a list of your user addresses." }, { "info": { "name": "Creates a user address", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/user_addresses", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a user address." }, { "info": { "name": "Retrieve a user address", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/user_addresses/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "user address ID" } ] }, "docs": "Retrieves the details of an existing user address." } ] }, { "info": { "name": "User Tags", "type": "folder" }, "items": [ { "info": { "name": "List User Tags", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/user_tags", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[starts_with]" } ] }, "docs": "List all user tags." } ] }, { "info": { "name": "Mobile Phone Numbers", "type": "folder" }, "items": [ { "info": { "name": "List Mobile Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/mobile_phone_numbers", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load" }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page" } ] }, "docs": "List Mobile Phone Numbers" }, { "info": { "name": "Retrieve a Mobile Phone Number", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/mobile_phone_numbers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the mobile phone number" } ] }, "docs": "Retrieve a Mobile Phone Number" }, { "info": { "name": "Update a Mobile Phone Number", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/v2/mobile_phone_numbers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the mobile phone number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Mobile Phone Number" } ] }, { "info": { "name": "Mobile Voice Connections", "type": "folder" }, "items": [ { "info": { "name": "List Mobile Voice Connections", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/mobile_voice_connections", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load" }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page" }, { "name": "filter[connection_name][contains]", "value": "", "type": "query", "description": "Filter by connection name containing the given string" }, { "name": "sort", "value": "", "type": "query", "description": "Sort by field (e.g., created_at, connection_name, active). Prefix with - for descending order." } ] }, "docs": "List Mobile Voice Connections" }, { "info": { "name": "Create a Mobile Voice Connection", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/mobile_voice_connections", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Mobile Voice Connection" }, { "info": { "name": "Retrieve a Mobile Voice Connection", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/mobile_voice_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the mobile voice connection" } ] }, "docs": "Retrieve a Mobile Voice Connection" }, { "info": { "name": "Update a Mobile Voice Connection", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/v2/mobile_voice_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the mobile voice connection" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Mobile Voice Connection" }, { "info": { "name": "Delete a Mobile Voice Connection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/v2/mobile_voice_connections/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the mobile voice connection" } ] }, "docs": "Delete a Mobile Voice Connection" } ] }, { "info": { "name": "Stored Payment Transactions", "type": "folder" }, "items": [ { "info": { "name": "Create a stored payment transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/payment/stored_payment_transactions", "body": { "type": "json", "data": "{}" } }, "docs": "Create a stored payment transaction" } ] }, { "info": { "name": "Whatsapp Business Accounts", "type": "folder" }, "items": [ { "info": { "name": "List Whatsapp Business Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/business_accounts", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List Whatsapp Business Accounts" }, { "info": { "name": "Get a single Whatsapp Business Account", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/business_accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp Business Account ID" } ] }, "docs": "Get a single Whatsapp Business Account" }, { "info": { "name": "Delete a Whatsapp Business Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/v2/whatsapp/business_accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp Business Account ID" } ] }, "docs": "Delete a Whatsapp Business Account" }, { "info": { "name": "List phone numbers for a WABA", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/business_accounts/:id/phone_numbers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp Business Account ID" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List phone numbers for a WABA" }, { "info": { "name": "Get WABA settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/business_accounts/:id/settings", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp Business Account ID" } ] }, "docs": "Get WABA settings" }, { "info": { "name": "Update WABA settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/v2/whatsapp/business_accounts/:id/settings", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp Business Account ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update WABA settings" } ] }, { "info": { "name": "Whatsapp Phone Numbers", "type": "folder" }, "items": [ { "info": { "name": "Initialize Whatsapp phone number verification", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/whatsapp/business_accounts/:id/phone_numbers", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp Business Account ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initialize Whatsapp phone number verification" }, { "info": { "name": "List Whatsapp phone numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List Whatsapp phone numbers" }, { "info": { "name": "Delete a Whatsapp phone number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ] }, "docs": "Delete a Whatsapp phone number" }, { "info": { "name": "Get calling settings for a phone number", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/calling_settings", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ] }, "docs": "Get calling settings for a phone number" }, { "info": { "name": "Enable or disable Whatsapp calling for a phone number", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/calling_settings", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable or disable Whatsapp calling for a phone number" }, { "info": { "name": "Get phone number business profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/profile", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ] }, "docs": "Get phone number business profile" }, { "info": { "name": "Update phone number business profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/profile", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update phone number business profile" }, { "info": { "name": "Get Whatsapp profile photo", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/profile/photo", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ] }, "docs": "Get Whatsapp profile photo" }, { "info": { "name": "Upload Whatsapp profile photo", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/profile/photo", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Upload Whatsapp profile photo" }, { "info": { "name": "Delete Whatsapp profile photo", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/profile/photo", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ] }, "docs": "Delete Whatsapp profile photo" }, { "info": { "name": "Resend verification code", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/resend_verification", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resend verification code" }, { "info": { "name": "Submit verification code for a phone number", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/whatsapp/phone_numbers/:phone_number/verify", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "Phone number (E.164 format)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit verification code for a phone number" } ] }, { "info": { "name": "Whatsapp Message Templates", "type": "folder" }, "items": [ { "info": { "name": "List Whatsapp message templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp/message_templates", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter[waba_id]", "value": "", "type": "query", "description": "Filter by WABA ID" }, { "name": "filter[category]", "value": "", "type": "query", "description": "Filter by category" }, { "name": "filter[status]", "value": "", "type": "query", "description": "Filter by template status" }, { "name": "filter[search]", "value": "", "type": "query", "description": "Search templates by name" } ] }, "docs": "List Whatsapp message templates" }, { "info": { "name": "Create a Whatsapp message template", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/whatsapp/message_templates", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Whatsapp message template" }, { "info": { "name": "Get a Whatsapp message template by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/v2/whatsapp_message_templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp message template ID" } ] }, "docs": "Get a Whatsapp message template by ID" }, { "info": { "name": "Update a Whatsapp message template", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/v2/whatsapp_message_templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp message template ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Whatsapp message template" }, { "info": { "name": "Delete a Whatsapp message template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/v2/whatsapp_message_templates/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Whatsapp message template ID" } ] }, "docs": "Delete a Whatsapp message template" } ] }, { "info": { "name": "x402 Payment Transactions", "type": "folder" }, "items": [ { "info": { "name": "Settle a payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/x402/credit_account", "headers": [ { "name": "PAYMENT-SIGNATURE", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Settles an x402 payment using the quote ID and a signed payment authorization. The payment signature can be provided via the `PAYMENT-SIGNATURE` header or the `payment_signature` body parameter. Settlement is idempotent — submitting the same quote ID multiple times returns the existing transaction." }, { "info": { "name": "Create a payment quote", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/v2/x402/credit_account/quote", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a payment quote for the specified USD amount. Returns payment details including the x402 payment requirements, network, and expiration time. The quote must be settled before it expires." } ] }, { "info": { "name": "Verify", "type": "folder" }, "items": [ { "info": { "name": "List verifications by phone number", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/verifications/by_phone_number/:phone_number", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "The phone number associated with the verifications to retrieve." } ] }, "docs": "List verifications by phone number" }, { "info": { "name": "Verify verification code by phone number", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verifications/by_phone_number/:phone_number/actions/verify", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "The phone number associated with the verification code being verified." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify verification code by phone number" }, { "info": { "name": "Trigger Call verification", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verifications/call", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger Call verification" }, { "info": { "name": "Trigger Flash call verification", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verifications/flashcall", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger Flash call verification" }, { "info": { "name": "Trigger SMS verification", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verifications/sms", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger SMS verification" }, { "info": { "name": "Trigger WhatsApp verification", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verifications/whatsapp", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger WhatsApp verification" }, { "info": { "name": "Retrieve verification", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/verifications/:verification_id", "params": [ { "name": "verification_id", "value": "", "type": "path", "description": "The identifier of the verification to retrieve." } ] }, "docs": "Retrieve verification" }, { "info": { "name": "Verify verification code by ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verifications/:verification_id/actions/verify", "params": [ { "name": "verification_id", "value": "", "type": "path", "description": "The identifier of the verification to retrieve." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Verify verification code by ID" }, { "info": { "name": "List all Verify profiles", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/verify_profiles", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[name]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[size], page[number]" } ] }, "docs": "Gets a paginated list of Verify profiles." }, { "info": { "name": "Create a Verify profile", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verify_profiles", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Verify profile to associate verifications with." }, { "info": { "name": "Retrieve Verify profile message templates", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/verify_profiles/templates" }, "docs": "List all Verify profile message templates." }, { "info": { "name": "Create message template", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verify_profiles/templates", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Verify profile message template." }, { "info": { "name": "Update message template", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/verify_profiles/templates/:template_id", "params": [ { "name": "template_id", "value": "", "type": "path", "description": "The identifier of the message template to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Verify profile message template." }, { "info": { "name": "Retrieve Verify profile", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/verify_profiles/:verify_profile_id", "params": [ { "name": "verify_profile_id", "value": "", "type": "path", "description": "The identifier of the Verify profile to retrieve." } ] }, "docs": "Gets a single Verify profile." }, { "info": { "name": "Update Verify profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/verify_profiles/:verify_profile_id", "params": [ { "name": "verify_profile_id", "value": "", "type": "path", "description": "The identifier of the Verify profile to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Verify profile" }, { "info": { "name": "Delete Verify profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/verify_profiles/:verify_profile_id", "params": [ { "name": "verify_profile_id", "value": "", "type": "path", "description": "The identifier of the Verify profile to delete." } ] }, "docs": "Delete Verify profile" } ] }, { "info": { "name": "Verified Numbers", "type": "folder" }, "items": [ { "info": { "name": "List all Verified Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/verified_numbers", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Use page[size] and page[number] in the query string. Originally: page[size], page[number]" } ] }, "docs": "Gets a paginated list of Verified Numbers." }, { "info": { "name": "Request phone number verification", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verified_numbers", "body": { "type": "json", "data": "{}" } }, "docs": "Initiates phone number verification procedure. Supports DTMF extension dialing for voice calls to numbers behind IVR systems." }, { "info": { "name": "Retrieve a verified number", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/verified_numbers/:phone_number", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "The phone number being requested." } ] }, "docs": "Retrieve a verified number" }, { "info": { "name": "Delete a verified number", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/verified_numbers/:phone_number", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "The phone number being deleted." } ] }, "docs": "Delete a verified number" }, { "info": { "name": "Submit verification code", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/verified_numbers/:phone_number/actions/verify", "params": [ { "name": "phone_number", "value": "", "type": "path", "description": "The phone number being verified." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Submit verification code" } ] }, { "info": { "name": "Virtual Cross Connects", "type": "folder" }, "items": [ { "info": { "name": "List all Virtual Cross Connects", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/virtual_cross_connects", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[network_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all Virtual Cross Connects." }, { "info": { "name": "Create a Virtual Cross Connect", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/virtual_cross_connects", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Virtual Cross Connect.

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." }, { "info": { "name": "Retrieve a Virtual Cross Connect", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/virtual_cross_connects/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a Virtual Cross Connect." }, { "info": { "name": "Update the Virtual Cross Connect", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/virtual_cross_connects/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the Virtual Cross Connect.

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.

Once the Virtual Cross Connect has moved to `provisioned` and you are ready to enable routing, you can toggle the routing announcements to `true`." }, { "info": { "name": "Delete a Virtual Cross Connect", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/virtual_cross_connects/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a Virtual Cross Connect." }, { "info": { "name": "List Virtual Cross Connect Cloud Coverage", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/virtual_cross_connects_coverage", "params": [ { "name": "filters", "value": "", "type": "query", "description": "Consolidated filters parameter (deepObject style). Originally: filters[available_bandwidth][contains]" }, { "name": "filter", "value": "", "type": "query", "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]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List Virtual Cross Connects Cloud Coverage.

This endpoint shows which cloud regions are available for the `location_code` your Virtual Cross Connect will be provisioned in." } ] }, { "info": { "name": "Voice Clones", "type": "folder" }, "items": [ { "info": { "name": "List voice clones", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/voice_clones", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "Page number for pagination (1-based)." }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of results per page." }, { "name": "filter[name]", "value": "", "type": "query", "description": "Case-insensitive substring filter on the name field." }, { "name": "filter[provider]", "value": "", "type": "query", "description": "Filter by voice synthesis provider. Case-insensitive." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order. Prefix with `-` for descending. Defaults to `-created_at`." } ] }, "docs": "Returns a paginated list of voice clones belonging to the authenticated account." }, { "info": { "name": "Create a voice clone from a voice design", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/voice_clones", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new voice clone by capturing the voice identity of an existing voice design. The clone can then be used for text-to-speech synthesis." }, { "info": { "name": "Create a voice clone from an audio file upload", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/voice_clones/from_upload", "body": { "type": "multipart-form", "data": [] } }, "docs": "Creates a new voice clone by uploading an audio file directly. Supported formats: WAV, MP3, FLAC, OGG, M4A. For best results, provide 5–10 seconds of clear speech. Maximum file size: 5MB for Telnyx, 20MB for Minimax." }, { "info": { "name": "Update a voice clone", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/voice_clones/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice clone UUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name, language, or gender of a voice clone." }, { "info": { "name": "Delete a voice clone", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/voice_clones/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice clone UUID." } ] }, "docs": "Permanently deletes a voice clone. This action cannot be undone." }, { "info": { "name": "Download voice clone audio sample", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/voice_clones/:id/sample", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice clone UUID." } ] }, "docs": "Downloads the WAV audio sample that was used to create the voice clone." } ] }, { "info": { "name": "Voice Designs", "type": "folder" }, "items": [ { "info": { "name": "List voice designs", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/voice_designs", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "Page number for pagination (1-based)." }, { "name": "page[size]", "value": "", "type": "query", "description": "Number of results per page." }, { "name": "filter[name]", "value": "", "type": "query", "description": "Case-insensitive substring filter on the name field." }, { "name": "sort", "value": "", "type": "query", "description": "Sort order. Prefix with `-` for descending. Defaults to `-created_at`." } ] }, "docs": "Returns a paginated list of voice designs belonging to the authenticated account." }, { "info": { "name": "Create or add a version to a voice design", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/voice_designs", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new voice design (version 1) when `voice_design_id` is omitted. When `voice_design_id` is provided, adds a new version to the existing design instead. A design can have at most 50 versions." }, { "info": { "name": "Get a voice design", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/voice_designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." }, { "name": "version", "value": "", "type": "query", "description": "Specific version number to retrieve. Defaults to the latest version." } ] }, "docs": "Returns the latest version of a voice design, or a specific version when `?version=N` is provided. The `id` parameter accepts either a UUID or the design name." }, { "info": { "name": "Rename a voice design", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/voice_designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name of a voice design. All versions retain their other properties." }, { "info": { "name": "Delete a voice design", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/voice_designs/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." } ] }, "docs": "Permanently deletes a voice design and all of its versions. This action cannot be undone." }, { "info": { "name": "Download voice design audio sample", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/voice_designs/:id/sample", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." }, { "name": "version", "value": "", "type": "query", "description": "Specific version number to download the sample for. Defaults to the latest version." } ] }, "docs": "Downloads the WAV audio sample for the voice design. Returns the latest version's sample by default, or a specific version when `?version=N` is provided. The `id` parameter accepts either a UUID or the design name." }, { "info": { "name": "Delete a specific version of a voice design", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/voice_designs/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "The voice design UUID or name." }, { "name": "version", "value": "", "type": "path", "description": "The version number to delete." } ] }, "docs": "Permanently deletes a specific version of a voice design. The version number must be a positive integer." } ] }, { "info": { "name": "Webhooks", "type": "folder" }, "items": [ { "info": { "name": "List webhook deliveries", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/webhook_deliveries", "params": [ { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" }, { "name": "filter", "value": "", "type": "query", "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]" } ] }, "docs": "Lists webhook_deliveries for the authenticated user" }, { "info": { "name": "Find webhook_delivery details by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/webhook_deliveries/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the webhook_delivery." } ] }, "docs": "Provides webhook_delivery debug data, such as timestamps, delivery status and attempts." } ] }, { "info": { "name": "WireGuard Interfaces", "type": "folder" }, "items": [ { "info": { "name": "List all WireGuard Interfaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireguard_interfaces", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[network_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all WireGuard Interfaces." }, { "info": { "name": "Create a WireGuard Interface", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/wireguard_interfaces", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created." }, { "info": { "name": "Retrieve a WireGuard Interfaces", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireguard_interfaces/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve a WireGuard Interfaces." }, { "info": { "name": "Delete a WireGuard Interface", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/wireguard_interfaces/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete a WireGuard Interface." }, { "info": { "name": "List all WireGuard Peers", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireguard_peers", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Consolidated filter parameter (deepObject style). Originally: filter[wireguard_interface_id]" }, { "name": "page", "value": "", "type": "query", "description": "Consolidated page parameter (deepObject style). Originally: page[number], page[size]" } ] }, "docs": "List all WireGuard peers." }, { "info": { "name": "Create a WireGuard Peer", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/wireguard_peers", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created." }, { "info": { "name": "Retrieve the WireGuard Peer", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireguard_peers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve the WireGuard peer." }, { "info": { "name": "Update the WireGuard Peer", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/wireguard_peers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the WireGuard peer." }, { "info": { "name": "Delete the WireGuard Peer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/wireguard_peers/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Delete the WireGuard peer." }, { "info": { "name": "Retrieve Wireguard config template for Peer", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireguard_peers/:id/config", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Retrieve Wireguard config template for Peer" } ] }, { "info": { "name": "Reporting", "type": "folder" }, "items": [ { "info": { "name": "Get all Wireless Detail Records (WDRs) Reports", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireless/detail_records_reports", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." } ] }, "docs": "Returns the WDR Reports that match the given parameters." }, { "info": { "name": "Create a Wireless Detail Records (WDRs) Report", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/wireless/detail_records_reports", "body": { "type": "json", "data": "{}" } }, "docs": "Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.\n" }, { "info": { "name": "Get a Wireless Detail Record (WDR) Report", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireless/detail_records_reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Returns one specific WDR report" }, { "info": { "name": "Delete a Wireless Detail Record (WDR) Report", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/wireless/detail_records_reports/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the resource." } ] }, "docs": "Deletes one specific WDR report." } ] }, { "info": { "name": "Wireless Regions", "type": "folder" }, "items": [ { "info": { "name": "Get all wireless regions", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireless/regions", "params": [ { "name": "product", "value": "", "type": "query", "description": "The product for which to list regions (e.g., 'public_ips', 'private_wireless_gateways')." } ] }, "docs": "Retrieve all wireless regions for the given product." } ] }, { "info": { "name": "Wireless Blocklists", "type": "folder" }, "items": [ { "info": { "name": "Get all possible wireless blocklist values", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireless_blocklist_values", "params": [ { "name": "type", "value": "", "type": "query", "description": "The Wireless Blocklist type for which to list possible values (e.g., `country`, `mcc`, `plmn`)." } ] }, "docs": "Retrieve all wireless blocklist values for a given blocklist type." }, { "info": { "name": "Get all Wireless Blocklists", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireless_blocklists", "params": [ { "name": "page[number]", "value": "", "type": "query", "description": "The page number to load." }, { "name": "page[size]", "value": "", "type": "query", "description": "The size of the page." }, { "name": "filter[name]", "value": "my private gateway", "type": "query", "description": "The name of the Wireless Blocklist." }, { "name": "filter[type]", "value": "country", "type": "query", "description": "When the Private Wireless Gateway was last updated." }, { "name": "filter[values]", "value": "US,CA", "type": "query", "description": "Values to filter on (inclusive)." } ] }, "docs": "Get all Wireless Blocklists belonging to the user." }, { "info": { "name": "Create a Wireless Blocklist", "type": "http" }, "http": { "method": "POST", "url": "https://api.telnyx.com/v2/wireless_blocklists", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Wireless Blocklist to prevent SIMs from connecting to certain networks." }, { "info": { "name": "Get a Wireless Blocklist", "type": "http" }, "http": { "method": "GET", "url": "https://api.telnyx.com/v2/wireless_blocklists/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the wireless blocklist." } ] }, "docs": "Retrieve information about a Wireless Blocklist." }, { "info": { "name": "Update a Wireless Blocklist", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.telnyx.com/v2/wireless_blocklists/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the wireless blocklist." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Wireless Blocklist." }, { "info": { "name": "Delete a Wireless Blocklist", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telnyx.com/v2/wireless_blocklists/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifies the wireless blocklist." } ] }, "docs": "Deletes the Wireless Blocklist." } ] } ], "bundled": true }