{ "openapi": "3.0.0", "info": { "title": "Telnyx 10DLC API", "description": "# Overview\nThe Telnyx 10DLC API facilitates interaction with The Campaign Registry (TCR), allowing the creation and registration of brands and campaigns with TCR.\n\n# API Interaction\n## Request Authorization\nTelnyx 10DLC API endpoints require authorization for each request. To properly authorize requests, send an Authorization header with `Bearer ` plus your Telnyx API key as the value. See the following curl request for example usage:\n\n```sh\ncurl --location --request GET 'https://api.telnyx.com/10dlc/example/endpoint' \\ \n--header 'Authorization: Bearer YOUR_API_KEY_GOES_HERE' \\ \n--data-raw ''\n```\n\nYou can obtain your API key by logging into your Telnyx portal account and clicking the \"API Keys\" tab. From there, you can copy your desired API key for use in your requests, similar to the above example curl request.\n\n## The 10DLC Work Flow\n1. Create a brand\n\n2. Apply for brand vetting\n\n3. Create a campaign or campaigns (associated with the created brand)\n\n4. Assign a phone number or phone numbers to the created campaign\n## 10DLC Costs\n**Brands:**\n1. Brand registration: $4 one time charge\n\n2. Brand vetting: $40 one time charge\n\n**Campaigns:**\n\n1. Campaign registration T-Mobile: $50 one time charge\n\n2. Campaign creation: first 3 month's charge upfront. After the first 3 months, this charge will change to a once a month recurring charge (see charge values below, based on campaign use case)\n\n a. Charity Campaign Use Case: $15 upfront (first 3 months), and $5 month to month after\n\n b. Low Mixed Volume Campaign Use Case: $6 upfront (first 3 months), and $2 month to month after\n\n c. Any Other Campaign Use Case: $30 upfront (first 3 months), and $10 month to month after\n3. Phone number to campaign assignment: $0.03 one time charge for each assignment\n\n## Frequently Asked Questions\nFor frequently asked questions, visit Telnyx 10DLC FAQs.", "version": "0.1" }, "servers": [ { "url": "/v2", } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Access Tokens", "description": "Access Tokens creation" }, { "name": "Addresses", "description": "Address operations" }, { "name": "Advanced OptIn/OptOut", "description": "Advanced OptIn/OptOut" }, { "name": "Authentication Providers", "description": "Authentication Provider operations" }, { "name": "AutoRechargePreferences", "description": "V2 Auto Recharge Preferences API" }, { "name": "Billing", "description": "Billing operations" }, { "name": "Billing Groups", "description": "Billing groups operations" }, { "name": "Brands", "description": "Brand operations" }, { "name": "Bucket SSL Certificate", "description": "SSL certificate operations" }, { "name": "Bucket Usage", "description": "Bucket Usage operations" }, { "name": "Bulk Credentials", "description": "Bulk operations over Credentials" }, { "name": "Bulk Phone Number Campaigns", "description": "Phone number campaign bulk assignment" }, { "name": "Bulk Phone Number Operations", "description": "Background jobs performed over a batch of phone numbers" }, { "name": "Bulk Small Business", "description": "Endpoints for creating and checking the status of campaigns, brands, and phone numbers" }, { "name": "Business Identity", "description": "Business Identity related endpoints" }, { "name": "Call Commands", "description": "Call Control command operations" }, { "name": "Call Control Applications", "description": "Call Control applications operations" }, { "name": "Call Information", "description": "Call information" }, { "name": "Call Recordings", "description": "Call Recordings operations." }, { "name": "Campaign", "description": "Campaign operations" }, { "name": "Channel zones", "description": "Channel zones" }, { "name": "Conference Commands", "description": "Conference command operations" }, { "name": "Connections", "description": "Connections operations" }, { "name": "Credential Connections", "description": "Credential connection operations" }, { "name": "Credentials", "description": "Credentials operations" }, { "name": "Customer Service Record", "description": "Customer Service Record operations" }, { "name": "Debugging", "description": "Call Control debugging" }, { "name": "Detail Records", "description": "Detail Records operations" }, { "name": "Dialogflow Integration", "description": "Dialogflow Connection Operations." }, { "name": "Documents", "description": "Documents" }, { "name": "Dynamic Emergency Addresses", "description": "Dynamic emergency address operations" }, { "name": "Dynamic Emergency Endpoints", "description": "Dynamic Emergency Endpoints" }, { "name": "External Connections", "description": "External Connections operations" }, { "name": "FQDN Connections", "description": "FQDN connection operations" }, { "name": "FQDNs", "description": "FQDN operations" }, { "name": "Global IPs", "description": "Global IPs" }, { "name": "IP Addresses", "description": "IP Address Operations" }, { "name": "IP Connections", "description": "IP connection operations" }, { "name": "IP Ranges", "description": "IP Range Operations" }, { "name": "IPs", "description": "IP operations" }, { "name": "Inbound Channels", "description": "Inbound channels operations" }, { "name": "Inventory Level", "description": "Inventory Level" }, { "name": "Managed Accounts", "description": "Managed Accounts operations" }, { "name": "Media Storage API", "description": "Media Storage operations" }, { "name": "Messages", "description": "Messages" }, { "name": "Messaging Hosted Number", "description": "Manage your messaging hosted numbers" }, { "name": "Messaging Profiles", "description": "Messaging profiles" }, { "name": "Messaging Tollfree Verification", "description": "Manage your tollfree verification requests" }, { "name": "Messaging URL Domains", "description": "Messaging URL Domains" }, { "name": "Mobile Network Operators", "description": "Mobile network operators operations" }, { "name": "Networks", "description": "Network operations" }, { "name": "Notifications", "description": "Notification settings operations" }, { "name": "Number Configurations", "description": "Configure your phone numbers" }, { "name": "Number Lookup", "description": "Look up phone number data" }, { "name": "Number Portout", "description": "Number portout operations" }, { "name": "OTA updates", "description": "OTA updates operations" }, { "name": "Outbound Voice Profiles", "description": "Outbound voice profiles operations" }, { "name": "Phone Number Blocks Background Jobs", "description": "Background jobs performed over a phone-numbers block's phone numbers" }, { "name": "Phone Number Campaigns", "description": "Phone number campaign assignment" }, { "name": "Phone Number Configurations", "description": "Configure your phone numbers" }, { "name": "Phone Number Order Documents", "description": "Number order documents" }, { "name": "Phone Number Orders", "description": "Number orders" }, { "name": "Phone Number Porting", "description": "Determining portability of phone numbers" }, { "name": "Phone Number Reservations", "description": "Number reservations" }, { "name": "Phone Number Search", "description": "Number search" }, { "name": "Porting Order", "description": "Porting Order operation" }, { "name": "Presigned Object URLs", "description": "Presigned object URL operations" }, { "name": "Private Wireless Gateways", "description": "Private Wireless Gateways operations" }, { "name": "Programmable Fax Applications", "description": "Fax Applications operations" }, { "name": "Programmable Fax Commands", "description": "Programmable fax command operations" }, { "name": "Public Internet Gateways", "description": "Public Internet Gateway operations" }, { "name": "Push Credentials", "description": "Mobile push credential management" }, { "name": "Queue Commands", "description": "Queue commands operations" }, { "name": "Recordings Commands", "description": "Recordings commands operations" }, { "name": "Regions", "description": "Regions" }, { "name": "Register Call", "description": "Register Call commands" }, { "name": "Reporting", "description": "Wireless reporting operations" }, { "name": "Requirement Types", "description": "Types of requirements for international numbers and porting orders" }, { "name": "Requirements", "description": "Requirements for international numbers and porting orders" }, { "name": "Room Compositions", "description": "Rooms Compositions operations." }, { "name": "Room Participants", "description": "Rooms Participants operations." }, { "name": "Room Recordings", "description": "Rooms Recordings operations." }, { "name": "Room Sessions", "description": "Rooms Sessions operations." }, { "name": "Rooms", "description": "Rooms operations." }, { "name": "Rooms Client Tokens", "description": "Rooms Client Tokens operations." }, { "name": "SIM Card Actions", "description": "View SIM card actions, their progress and timestamps using the SIM Card Actions API" }, { "name": "SIM Card Group Actions", "description": "SIM Card Group actions operations" }, { "name": "SIM Card Groups", "description": "SIM Card Groups operations" }, { "name": "SIM Card Orders", "description": "SIM Card Orders operations" }, { "name": "SIM Cards", "description": "SIM Cards operations" }, { "name": "Short Codes", "description": "Short codes" }, { "name": "TeXML Applications", "description": "TeXML Applications operations" }, { "name": "TeXML REST Commands", "description": "TeXML REST Commands" }, { "name": "Verified Calls Display Profile", "description": "Verified Calls Display Profile related endpoints" }, { "name": "Verified Numbers", "description": "" }, { "name": "Verify", "description": "Two factor authentication API" }, { "name": "Virtual Cross Connects", "description": "Virtual Cross Connect operations" }, { "name": "Webhooks", "description": "Webhooks operations" }, { "name": "WireGuard Interfaces", "description": "WireGuard Interface operations" }, { "name": "Wireless", "description": "Wireless operations" } ], "paths": { "/": { "get": { "tags": [ "Bucket" ], "summary": "ListBuckets", "operationId": "ListBuckets", "description": "List all Buckets.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html" }, "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ListBucketsResponse" } } } } }, "x-latency-category": "responsive" } }, "/access_ip_address": { "get": { "summary": "List all Access IP Addresses", "operationId": "ListAccessIpAddresses", "tags": [ "IP Addresses" ], "parameters": [ { "required": false, "schema": { "type": "string" }, "name": "filter[ip_source]", "in": "query" }, { "required": false, "schema": { "type": "string" }, "name": "filter[ip_address]", "in": "query" }, { "required": false, "schema": { "type": "string", "format": "date-time" }, "name": "filter[created_at][gt]", "in": "query" }, { "required": false, "schema": { "type": "string", "format": "date-time" }, "name": "filter[created_at][lt]", "in": "query" }, { "required": false, "schema": { "type": "integer", "default": 1 }, "name": "page[number]", "in": "query" }, { "required": false, "schema": { "maximum": 250, "type": "integer", "default": 20 }, "name": "page[size]", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPAddressListResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "x-latency-category": "responsive" }, "post": { "summary": "Create new Access IP Address", "operationId": "CreateAccessIpAddress", "tags": [ "IP Addresses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPAddressPOST" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPAddressResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "x-latency-category": "responsive" } }, "/access_ip_address/{access_ip_address_id}": { "delete": { "summary": "Delete access IP address", "operationId": "DeleteAccessIpAddress", "tags": [ "IP Addresses" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "access_ip_address_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPAddressResponseSchema" } } } } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve an access IP address", "operationId": "GetAccessIpAddress", "tags": [ "IP Addresses" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "access_ip_address_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPAddressResponseSchema" } } } } }, "x-latency-category": "responsive" } }, "/access_ip_ranges": { "get": { "summary": "List all Access IP Ranges", "operationId": "ListAccessIpRanges", "tags": [ "IP Ranges" ], "parameters": [ { "required": false, "schema": { "type": "string" }, "name": "filter[cidr_block]", "in": "query" }, { "required": false, "schema": { "type": "string" }, "name": "filter[cidr_block][startswith]", "in": "query" }, { "required": false, "schema": { "type": "string" }, "name": "filter[cidr_block][endswith]", "in": "query" }, { "required": false, "schema": { "type": "string" }, "name": "filter[cidr_block][contains]", "in": "query" }, { "required": false, "schema": { "type": "string", "format": "date-time" }, "name": "filter[created_at][gt]", "in": "query" }, { "required": false, "schema": { "type": "string", "format": "date-time" }, "name": "filter[created_at][lt]", "in": "query" }, { "required": false, "schema": { "type": "integer", "default": 1 }, "name": "page[number]", "in": "query" }, { "required": false, "schema": { "maximum": 250, "type": "integer", "default": 20 }, "name": "page[size]", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPRangeListResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "x-latency-category": "responsive" }, "post": { "summary": "Create new Access IP Range", "operationId": "CreateAccessIPRange", "tags": [ "IP Ranges" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPRangePOST" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPRangeResponseSchema" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "x-latency-category": "responsive" } }, "/access_ip_ranges/{access_ip_range_id}": { "delete": { "summary": "Delete access IP ranges", "tags": [ "IP Ranges" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "access_ip_range_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessIPRangeResponseSchema" } } } } }, "x-latency-category": "responsive" } }, "/actions/bulk/telephony_credentials": { "delete": { "description": "Delete several credentials in bulk.", "summary": "Delete several credentials", "operationId": "DeleteTelephonyCredentials", "tags": [ "Bulk Credentials" ], "parameters": [ { "$ref": "#/components/parameters/RequiredTag" } ], "responses": { "201": { "$ref": "#/components/responses/BulkCredentialResponse" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "patch": { "description": "Update several credentials in bulk.", "summary": "Update several credentials", "operationId": "UpdateBulkTelephonyCredential", "tags": [ "Bulk Credentials" ], "parameters": [ { "$ref": "#/components/parameters/RequiredTag" } ], "requestBody": { "description": "Parameters to update credentials on bulk", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCredentialRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/BulkCredentialResponse" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates several credentials in bulk.", "summary": "Creates several credentials", "operationId": "CreateBulkTelephonyCredentials", "tags": [ "Bulk Credentials" ], "parameters": [], "requestBody": { "description": "Requested parameters to create credentials on bulk", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCredentialRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/BulkCredentialResponse" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/actions/network_preferences/sim_cards": { "put": { "x-latency-category": "background", "summary": "Bulk Network Preferences for SIM cards", "description": "This API allows dispatching the same operation described for the PUT sim_cards/:sim_card_id/network_preferences API for multiple SIM cards at once.

\nAlthough, a SIM card network preference may fail individually under any validation triggered as a consequence of its state. For example, a SIM can't have an in-progress OTA update for applying a Network Preference, so they'll fail when requested in this API. In that scenario, the specific error will be present in the response along with the successful definitions in the \"errors\" response node.\n", "operationId": "BulkSimCardNetworkPreferences", "tags": [ "SIM Cards" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sim_card_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "example": [ "6b14e151-8493-4fa1-8664-1cc4e6d14158", "6b14e151-8493-4fa1-8664-1cc4e6d14158" ] }, "mobile_network_operators_preferences": { "$ref": "#/components/schemas/MobileNetworkOperatorsPreferencesRequest" } } } } } }, "responses": { "202": { "$ref": "#/components/responses/BulkSIMCardNetworkPreferenceResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" } } } }, "/actions/purchase/esims": { "post": { "x-latency-category": "background", "summary": "Purchase eSIMs", "description": "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", "operationId": "PurchaseESim", "tags": [ "SIM Cards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ESimPurchase" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/RegisterSimCardsResponse" } } } }, "/actions/register/sim_cards": { "post": { "x-latency-category": "background", "summary": "Register SIM cards", "description": "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", "operationId": "RegisterSimCards", "tags": [ "SIM Cards" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIMCardRegistration" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/RegisterSimCardsResponse" } } } }, "/actions/{action}/telephony_credentials": { "post": { "description": "Perform activate or deactivate action on all credentials filtered by the provided tag. Activate action will change the status to active, making it possible to connect calls with the credential. Deactivate action will change the status to inactive, making it impossible to connect calls with the credential.", "summary": "Perform activate or deactivate action on all credentials filtered by the provided tag.", "operationId": "BulkCredentialAction", "tags": [ "Bulk Credentials" ], "parameters": [ { "name": "action", "in": "path", "description": "Identifies the action to be taken. Activate will change the status to active. Deactivate will change the status to inactive.", "required": true, "schema": { "type": "string", "enum": [ "activate", "deactivate" ] } }, { "$ref": "#/components/parameters/RequiredTag" } ], "responses": { "200": { "$ref": "#/components/responses/BulkCredentialResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/addresses": { "get": { "description": "Returns a list of your addresses.", "summary": "List all addresses", "operationId": "FindAddresses", "tags": [ "Addresses" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterCustomerReferenceEquals" }, { "$ref": "#/components/parameters/FilterCustomerReferenceContains" }, { "$ref": "#/components/parameters/FilterUsedAsEmergency" }, { "$ref": "#/components/parameters/FilterStreetAddress" }, { "$ref": "#/components/parameters/FilterAddressBook" }, { "$ref": "#/components/parameters/SortAddress" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllAddressResponse" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates an address.", "summary": "Creates an address", "operationId": "CreateAddress", "tags": [ "Addresses" ], "x-endpoint-cost": "medium", "parameters": [], "requestBody": { "description": "Parameters that can be defined during address creation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCreate" } } } }, "responses": { "200": { "$ref": "#/components/responses/AddressResponse" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/addresses/actions/validate": { "post": { "description": "Validates an address for emergency services.", "summary": "Validate an address", "operationId": "ValidateAddress", "tags": [ "Addresses" ], "parameters": [], "requestBody": { "description": "Parameters that can be defined during address validation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateAddressRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ValidateAddressResponse" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/addresses/{id}": { "delete": { "description": "Deletes an existing address.", "summary": "Deletes an address", "operationId": "DeleteAddress", "tags": [ "Addresses" ], "parameters": [ { "name": "id", "in": "path", "description": "address ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/AddressResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "get": { "description": "Retrieves the details of an existing address.", "summary": "Retrieve an address", "operationId": "GetAddress", "tags": [ "Addresses" ], "parameters": [ { "name": "id", "in": "path", "description": "address ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/AddressResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/addresses/{id}/actions/accept_suggestions": { "post": { "summary": "Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.", "operationId": "acceptAddressSuggestions", "tags": [ "Addresses" ], "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The UUID of the address that should be accepted." } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptSuggestionsRequest" } } } }, "responses": { "200": { "description": "This address suggestion has already been accepted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressSuggestionResponse" } } } }, "202": { "description": "This address suggestion was accepted. The numbers associated to it will resume processing in the background.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressSuggestionResponse" } } } }, "404": { "description": "Address not found or not accessible by the user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } }, "x-latency-category": "responsive" } }, "/ai/embeddings": { "post": { "tags": [ "Public Endpoints" ], "summary": "Embedding", "description": "Perform embedding on a Telnyx Storage Bucket using the a embedding model.\nThe current supported file types are:\n- PDF\n- HTML\n- txt/unstructured text files\n- json\n- csv\n- audio / video (mp3, mp4, mpeg, mpga, m4a, wav, or webm ) - Max of 20mb file size.\n\nAny files not matching the above types will be attempted to be embedded as unstructured text.\n\nThis process can be slow, so it runs in the background and the user can check\nthe status of the task using the endpoint `/ai/embeddings/{task_id}`.\n\n **Important Note**: When you update documents in a Telnyx Storage bucket, their associated embeddings are automatically kept up to date. If you add or update a file, it is automatically embedded. If you delete a file, the embeddings are deleted for that particular file.\n\nYou can also specify a custom `loader` param. Currently the only supported loader value is\n`intercom` which loads Intercom article jsons as specified by [the Intercom article API](https://developers.intercom.com/docs/references/rest-api/api.intercom.io/Articles/article/)\nThis loader will split each article into paragraphs and save additional parameters relevant to Intercom docs, such as\n`article_url` and `heading`. These values will be returned by the `/v2/ai/embeddings/similarity-search` endpoint in the `loader_metadata` field.", "operationId": "PostEmbedding", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingBucketRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/ai/embeddings/buckets": { "get": { "tags": [ "Public Endpoints" ], "summary": "Embedding Buckets", "description": "Get all embedding buckets for a user.", "operationId": "GetEmbeddingBuckets", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEmbeddedBucketsData" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/ai/embeddings/buckets/{bucket_name}": { "delete": { "tags": [ "Public Endpoints" ], "summary": "Disable an Embedded Bucket", "description": "Deletes an entire bucket's embeddings and disables the bucket for AI-use, returning it to normal storage pricing.", "operationId": "embedding_bucket_files_public_embedding_buckets__bucket_name__delete", "parameters": [ { "required": true, "schema": { "type": "string", "title": "Bucket Name" }, "name": "bucket_name", "in": "path" } ], "responses": { "200": { "description": "Bucket Embeddings Deleted Successfully" }, "404": { "description": "Bucket Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BucketNotFoundError" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Public Endpoints" ], "summary": "Embedding Bucket Files", "description": "Get all embedded files for a given user bucket, including their processing status.", "operationId": "GetBucketName", "parameters": [ { "required": true, "schema": { "type": "string", "title": "Bucket Name" }, "name": "bucket_name", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingsBucketFilesData" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/ai/embeddings/similarity-search": { "post": { "tags": [ "Public Endpoints" ], "summary": "Similarity Search", "description": "Perform a similarity search on a Telnyx Storage Bucket, returning the most similar `num_docs` document chunks to the query.\n\nCurrently the only available distance metric is cosine similarity which will return a `distance` between 0 and 1.\nThe lower the distance, the more similar the returned document chunks are to the query.\nA `certainty` will also be returned, which is a value between 0 and 1 where the higher the certainty, the more similar the document.\nYou can read more about Weaviate distance metrics here: [Weaviate Docs](https://weaviate.io/developers/weaviate/config-refs/distances)\n\nIf a bucket was embedded using a custom loader, such as `intercom`, the additional metadata will be returned in the \n`loader_metadata` field.", "operationId": "PostEmbeddingSimilaritySearch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingSimilaritySearchRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingSimilaritySearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/ai/embeddings/{task_id}": { "get": { "tags": [ "Public Endpoints" ], "summary": "Embedding Task", "description": "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", "operationId": "GetEmbeddingTask", "parameters": [ { "required": true, "schema": { "type": "string", "title": "Task Id" }, "name": "task_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/ai/generate": { "post": { "tags": [ "Public Endpoints" ], "summary": "Inference", "description": "Generate text using an available LLM (Large Language Model).", "operationId": "PostInference", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InferenceRequest" }, "example": { "text": [ "Hello, World!" ] } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InferenceResponseData" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/ai/generate_stream": { "post": { "tags": [ "Public Endpoints" ], "summary": "Inference Stream", "description": "Generate text using an available LLM (Large Language Model) with streaming of tokens\nas they are generated. This allows for a faster response time and a better user experience\noverall as the user does not have to wait for the full output to complete before receiving\na response.", "operationId": "PostInferenceStream", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InferenceRequest" }, "example": { "text": [ "Hello, World!" ] } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/InferenceResponseStreamData" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/ai/summarize": { "post": { "tags": [ "Public Endpoints" ], "summary": "Summary", "description": "Summarize a bucket or a file.", "operationId": "PostSummary", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryResponseData" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/authentication_providers": { "get": { "description": "Returns a list of your SSO authentication providers.", "summary": "List all SSO authentication providers", "operationId": "FindAuthenticationProviders", "tags": [ "Authentication Providers" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/SortAuthenticationProvider" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllAuthenticationProviderResponse" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates an authentication provider.", "summary": "Creates an authentication provider", "operationId": "CreateAuthenticationProvider", "tags": [ "Authentication Providers" ], "parameters": [], "requestBody": { "description": "Parameters that can be defined during authentication provider creation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationProviderCreate" } } } }, "responses": { "200": { "$ref": "#/components/responses/AuthenticationProviderResponse" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/authentication_providers/{id}": { "delete": { "description": "Deletes an existing authentication provider.", "summary": "Deletes an authentication provider", "operationId": "DeleteAuthenticationProvider", "tags": [ "Authentication Providers" ], "parameters": [ { "name": "id", "in": "path", "description": "authentication provider ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/AuthenticationProviderResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "get": { "description": "Retrieves the details of an existing authentication provider.", "summary": "Retrieve an authentication provider", "operationId": "GetAuthenticationProvider", "tags": [ "Authentication Providers" ], "parameters": [ { "name": "id", "in": "path", "description": "authentication provider ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/AuthenticationProviderResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "patch": { "description": "Updates settings of an existing authentication provider.", "summary": "Update a authentication provider", "operationId": "UpdateAuthenticationProvider", "tags": [ "Authentication Providers" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters that can be updated in a authentication provider", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAuthenticationProviderRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/AuthenticationProviderResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/available_phone_number_blocks": { "get": { "summary": "List available phone number blocks", "operationId": "ListAvailablePhoneNumberBlocks", "tags": [ "Phone Number Search" ], "parameters": [ { "name": "filter[phone_number][starts_with]", "in": "query", "description": "Filter number blocks that start with a pattern (meant to be used after `national_destination_code` filter has been set).", "schema": { "type": "string", "example": "201" } }, { "name": "filter[phone_number][ends_with]", "in": "query", "description": "Filter numbers ending with a pattern.", "schema": { "type": "string", "example": "8000" } }, { "name": "filter[phone_number][contains]", "in": "query", "description": "Filter numbers containing a pattern.", "schema": { "type": "string", "example": "456" } }, { "name": "filter[locality]", "in": "query", "description": "Filter phone numbers by city.", "schema": { "type": "string" }, "examples": { "US": { "value": "Chicago" }, "CA": { "value": "Toronto" }, "AU": { "value": "Canberra" } } }, { "name": "filter[administrative_area]", "in": "query", "description": "Filter phone numbers by US state/CA province.", "schema": { "type": "string", "example": "IL" } }, { "name": "filter[country_code]", "in": "query", "description": "Filter phone numbers by ISO alpha-2 country code.", "schema": { "type": "string", "example": "US" } }, { "name": "filter[national_destination_code]", "in": "query", "description": "Filter by the national destination code of the number. This filter is only applicable to North American numbers.", "schema": { "type": "string" }, "examples": { "US": { "value": "312" }, "CA": { "value": "437" }, "AU": { "value": "0251" } } }, { "name": "filter[rate_center]", "in": "query", "description": "Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers.", "schema": { "type": "string", "example": "CHICAGO HEIGHTS" } }, { "name": "filter[number_type]", "in": "query", "description": "Filter phone numbers by number type.", "schema": { "type": "string", "enum": [ "toll-free" ], "example": "toll-free" } }, { "name": "filter[features]", "in": "query", "description": "Filter if the phone number should be used for voice, fax, mms, sms, emergency.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "sms", "mms", "voice", "fax", "emergency" ] }, "example": "voice,sms" } }, { "name": "filter[minimum_block_size]", "in": "query", "description": "Filter number blocks by minimum blocks size", "schema": { "type": "integer", "example": 100 } }, { "name": "filter[limit]", "in": "query", "description": "Limits the number of results.", "schema": { "type": "integer", "example": 100 } } ], "responses": { "200": { "$ref": "#/components/responses/ListAvailablePhoneNumbersBlockResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/available_phone_numbers": { "get": { "summary": "List available phone numbers", "operationId": "ListAvailablePhoneNumbers", "tags": [ "Phone Number Search" ], "x-group-parameters": "true", "x-endpoint-cost": "heavy", "parameters": [ { "name": "filter[phone_number][starts_with]", "in": "query", "description": "Filter numbers starting with a pattern (exclude NDC from start of this filter if used with `national_destination_code` filter).", "schema": { "type": "string" }, "examples": { "generic": { "value": "FREE", "summary": "Find numbers starting with the prefix 'FREE'" } } }, { "name": "filter[phone_number][ends_with]", "in": "query", "description": "Filter numbers ending with a pattern (max length of 4 digits if used with `national_destination_code` filter).", "schema": { "type": "string" }, "examples": { "generic": { "value": "CALL", "summary": "Find numbers ending with the suffix 'CALL'" } } }, { "name": "filter[phone_number][contains]", "in": "query", "description": "Filter numbers containing a pattern (must be used with `national_destination_code` filter and only searches within last 4 digits).", "schema": { "type": "string" }, "examples": { "generic": { "value": "FOO", "summary": "Find numbers that contain the word 'FOO' within the last 4 digits" } } }, { "name": "filter[locality]", "in": "query", "description": "Filter phone numbers by city.", "schema": { "type": "string" }, "examples": { "US": { "value": "Chicago" }, "CA": { "value": "Toronto" }, "AU": { "value": "Canberra" } } }, { "name": "filter[administrative_area]", "in": "query", "description": "Filter phone numbers by US state/CA province.", "schema": { "type": "string", "example": "IL" } }, { "name": "filter[country_code]", "in": "query", "description": "Filter phone numbers by ISO alpha-2 country code.", "schema": { "type": "string", "example": "US" } }, { "name": "filter[national_destination_code]", "in": "query", "description": "Filter by the national destination code of the number. This filter is only applicable to North American numbers.", "schema": { "type": "string" }, "examples": { "US": { "value": "312" }, "CA": { "value": "437" }, "AU": { "value": "0251" } } }, { "name": "filter[rate_center]", "in": "query", "description": "Filter phone numbers by NANP rate center. This filter is only applicable to North American numbers.", "schema": { "type": "string", "example": "CHICAGO HEIGHTS" } }, { "name": "filter[phone_number_type]", "in": "query", "description": "Filter phone numbers by number type.", "schema": { "type": "string", "enum": [ "local", "toll_free", "mobile", "national", "shared_cost", "landline" ], "example": "local" } }, { "name": "filter[features]", "in": "query", "description": "Filter if the phone number should be used for voice, fax, mms, sms, emergency.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "sms", "mms", "voice", "fax", "emergency" ] }, "example": "voice,sms" } }, { "name": "filter[limit]", "in": "query", "description": "Limits the number of results.", "schema": { "type": "integer", "example": 100 } }, { "name": "filter[best_effort]", "in": "query", "description": "Filter to determine if best effort results should be included. Only available in NANPA countries.", "schema": { "type": "boolean", "example": false } }, { "name": "filter[quickship]", "in": "query", "description": "Filter to exclude phone numbers that need additional time after to purchase to receive phone calls. Only available for toll-free numbers.", "schema": { "type": "boolean", "example": true } }, { "name": "filter[reservable]", "in": "query", "description": "Filter to exclude phone numbers that cannot be reserved before purchase.", "schema": { "type": "boolean", "example": true } }, { "name": "filter[exclude_held_numbers]", "in": "query", "description": "Filter to exclude phone numbers that are currently on hold for your account.", "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "$ref": "#/components/responses/ListAvailablePhoneNumbersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/balance": { "get": { "summary": "Get user balance details", "operationId": "GetUserBalance", "tags": [ "Billing" ], "responses": { "200": { "$ref": "#/components/responses/UserBalanceResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/billing_groups": { "get": { "summary": "List all billing groups", "operationId": "ListBillingGroups", "tags": [ "Billing Groups" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListBillingGroupsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a billing group", "operationId": "CreateBillingGroup", "tags": [ "Billing Groups" ], "requestBody": { "description": "New billing group object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBillingGroup" } } } }, "responses": { "200": { "$ref": "#/components/responses/CreateBillingGroupResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/billing_groups/{id}": { "delete": { "summary": "Delete a billing group", "operationId": "DeleteBillingGroup", "tags": [ "Billing Groups" ], "parameters": [ { "$ref": "#/components/parameters/BillingGroupId" } ], "responses": { "200": { "$ref": "#/components/responses/DeleteBillingGroupResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Get a billing group", "operationId": "GetBillingGroup", "tags": [ "Billing Groups" ], "parameters": [ { "$ref": "#/components/parameters/BillingGroupId" } ], "responses": { "200": { "$ref": "#/components/responses/RetrieveBillingGroupResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a billing group", "operationId": "UpdateBillingGroup", "tags": [ "Billing Groups" ], "parameters": [ { "$ref": "#/components/parameters/BillingGroupId" } ], "requestBody": { "description": "Update billing group object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBillingGroup" } } } }, "responses": { "200": { "$ref": "#/components/responses/UpdateBillingGroupResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/brand": { "get": { "tags": [ "Brands" ], "summary": "List Brands", "operationId": "GetBrands", "parameters": [ { "required": false, "schema": { "title": "Page", "minimum": 1.0, "type": "integer", "default": 1 }, "name": "page", "in": "query" }, { "description": "number of records per page. maximum of 500", "required": false, "schema": { "title": "Recordsperpage", "type": "integer", "description": "number of records per page. maximum of 500", "default": 10 }, "name": "recordsPerPage", "in": "query" }, { "required": false, "schema": { "title": "Displayname", "type": "string" }, "name": "displayName", "in": "query" }, { "required": false, "schema": { "title": "Entitytype", "type": "string" }, "name": "entityType", "in": "query" }, { "required": false, "schema": { "title": "State", "type": "string" }, "name": "state", "in": "query" }, { "required": false, "schema": { "title": "Country", "type": "string" }, "name": "country", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandRecordSetCSP" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "This endpoint is used to list all brands associated with your organization.", "x-latency-category": "responsive" }, "post": { "tags": [ "Brands" ], "summary": "Create Brand", "operationId": "CreateBrandPost", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBrand" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "This endpoint is used to create a new brand. A brand is an entity created by The Campaign Registry (TCR) that represents an organization or a company. It is this entity that TCR created campaigns will be associated with. Each brand creation will entail an upfront, non-refundable $4 expense.", "x-latency-category": "responsive" } }, "/brand/feedback/{brandId}": { "get": { "tags": [ "Brands" ], "summary": "Get Brand Feedback By Id", "description": "Get feedback about a brand by ID. This endpoint can be used after creating or revetting\na brand.\n\nPossible values for `.category[].id`:\n\n* `TAX_ID` - Data mismatch related to tax id and its associated properties.\n* `STOCK_SYMBOL` - Non public entity registered as a public for profit entity or\n the stock information mismatch.\n* `GOVERNMENT_ENTITY` - Non government entity registered as a government entity.\n Must be a U.S. government entity.\n* `NONPROFIT` - Not a recognized non-profit entity. No IRS tax-exempt status\n found.\n* `OTHERS` - Details of the data misrepresentation if any.", "operationId": "GetBrandFeedbackById", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandFeedback" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/brand/{brandId}": { "delete": { "tags": [ "Brands" ], "summary": "Delete Brand", "operationId": "DeleteBrand", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Brands" ], "summary": "Get Brand", "operationId": "GetBrand", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TelnyxBrand" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a brand by `brandId`.", "x-latency-category": "responsive" }, "put": { "tags": [ "Brands" ], "summary": "Update Brand", "operationId": "UpdateBrand", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBrand" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TelnyxBrand" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Update a brand's attributes by `brandId`.", "x-latency-category": "responsive" } }, "/brand/{brandId}/externalVetting": { "get": { "tags": [ "Brands" ], "summary": "List External Vettings", "description": "Get list of valid external vetting record for a given brand", "operationId": "ListExternalVettings", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Brands" ], "summary": "Order Brand External Vetting", "description": "Order new external vetting for a brand", "operationId": "PostOrderExternalVetting", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderExternalVetting" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" }, "put": { "tags": [ "Brands" ], "summary": "Import External Vetting Record", "description": "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.", "operationId": "PutExternalVettingRecord", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportExternalVetting" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalVetting" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/brand/{brandId}/revet": { "put": { "tags": [ "Brands" ], "summary": "Revet Brand", "operationId": "RevetBrand", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "This operation allows you to revet the brand. However, revetting is allowed once after the successful brand registration and thereafter limited to once every 3 months.", "x-latency-category": "responsive" } }, "/bulkCreation": { "get": { "tags": [ "Bulk Sole Proprietor Creation" ], "summary": "Get All Tasks", "operationId": "GetAllTasks", "parameters": [ { "required": false, "schema": { "title": "Recordsperpage", "default": 20 }, "name": "recordsPerPage", "in": "query" }, { "required": false, "schema": { "title": "Page", "default": 1 }, "name": "page", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreationTasksResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Get a list of all tasks ever submitted by your organization.", "x-latency-category": "responsive" }, "post": { "tags": [ "Bulk Sole Proprietor Creation" ], "summary": "Bulk Creation", "operationId": "PostBulkCreation", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreationRequest" } } }, "required": true }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Submit sets of data about brands, campaigns, and phone numbers to create and assign. Please note that sub-usecases, phone numbers, and sample messages are each limited to 5 per campaign.", "x-latency-category": "responsive" } }, "/bulkCreation/{taskId}": { "get": { "tags": [ "Bulk Sole Proprietor Creation" ], "summary": "Get Task Status", "operationId": "GetBulkCreationTaskStatus", "parameters": [ { "required": true, "schema": { "title": "Taskid", "type": "string" }, "name": "taskId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreationStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Get a simple overview of the status of a bulk creation task.", "x-latency-category": "responsive" } }, "/bulkCreation/{taskId}/detailedStatus": { "get": { "tags": [ "Bulk Sole Proprietor Creation" ], "summary": "Get Detailed Task Status", "operationId": "GetTaskDetailedStatus", "parameters": [ { "required": true, "schema": { "title": "Taskid", "type": "string" }, "name": "taskId", "in": "path" }, { "required": false, "schema": { "title": "Recordsperpage", "default": 20 }, "name": "recordsPerPage", "in": "query" }, { "required": false, "schema": { "title": "Page", "default": 1 }, "name": "page", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreationDetailedStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Get detailed information about the status of a bulk creation task.", "x-latency-category": "responsive" } }, "/bulk_sim_card_actions": { "get": { "operationId": "ListSimCardActions", "summary": "List bulk SIM card actions", "description": "This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.", "tags": [ "SIM Card Actions" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[action_type]", "description": "Filter by action type.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "bulk_set_public_ips" ], "example": "bulk_set_public_ips" } } ], "responses": { "200": { "$ref": "#/components/responses/BulkSIMCardActionCollectionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/bulk_sim_card_actions/{id}": { "get": { "operationId": "GetBulkSimCardAction", "summary": "Get bulk SIM card action details", "description": "This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions.", "tags": [ "SIM Card Actions" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/BulkSIMCardActionDetailedResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/business_identities": { "get": { "summary": "Lists the Business Identities owned by the current user/organization", "operationId": "ListBusinessIdentities", "tags": [ "Business Identity" ], "x-group-parameters": "true", "x-endpoint-cost": "light", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListBusinessIdentitiesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Creates a Business Identity", "description": "Creates a new Business Identity.", "operationId": "CreateBusinessIdentity", "tags": [ "Business Identity" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateBusinessIdentityRequest" } } } }, "responses": { "201": { "description": "Business Identity was created." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/business_identities/{id}": { "delete": { "summary": "Delete a Business Identity", "description": "Deletes the Business Identity. This action will fail if any verification requests have been made for any associated Display Profile. Please contact support@telnyx.com in case you want to delete a Business Identity in that situation.", "operationId": "DeleteBusinessIdentity", "tags": [ "Business Identity" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Business Identity", "required": true, "schema": { "type": "string" } } ], "x-group-parameters": "true", "x-endpoint-cost": "light", "responses": { "200": { "$ref": "#/components/responses/displayBusinessIdentityResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Display the Business Identity", "operationId": "DisplayBusinessIdentity", "tags": [ "Business Identity" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Business Identity", "required": true, "schema": { "type": "string" } } ], "x-group-parameters": "true", "x-endpoint-cost": "light", "responses": { "200": { "$ref": "#/components/responses/displayBusinessIdentityResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a Business Identity", "description": "Update an existing Business Identity.", "operationId": "UpdateBusinessIdentity", "tags": [ "Business Identity" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Business Identity", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateBusinessIdentityRequest" } } } }, "responses": { "200": { "description": "Business Identity was updated." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/call_control_applications": { "get": { "description": "Return a list of call control applications.", "summary": "List call control applications", "operationId": "ListCallControlApplications", "tags": [ "Call Control Applications" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterApplicationName" }, { "$ref": "#/components/parameters/FilterOutboundVoiceProfileId" }, { "$ref": "#/components/parameters/SortConnection" } ], "responses": { "200": { "$ref": "#/components/responses/ListCallControlApplicationsResponse" }, "400": { "description": "Bad request" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" } }, "x-latency-category": "interactive" }, "post": { "summary": "Create a call control application", "description": "Create a call control application.", "operationId": "CreateCallControlApplication", "tags": [ "Call Control Applications" ], "x-endpoint-cost": "medium", "requestBody": { "description": "Create call control application request.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCallControlApplicationRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/CallControlApplicationResponse" }, "422": { "description": "Bad Request" } }, "x-latency-category": "interactive" } }, "/call_control_applications/{id}": { "delete": { "description": "Deletes a call control application.", "summary": "Delete a call control application", "operationId": "DeleteCallControlApplication", "tags": [ "Call Control Applications" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string", "format": "int64", "example": "1293384261075731499" } } ], "responses": { "200": { "$ref": "#/components/responses/CallControlApplicationResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "interactive" }, "get": { "description": "Retrieves the details of an existing call control application.", "summary": "Retrieve a call control application", "operationId": "RetrieveCallControlApplication", "tags": [ "Call Control Applications" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string", "format": "int64", "example": "1293384261075731499" } } ], "responses": { "200": { "$ref": "#/components/responses/CallControlApplicationResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "interactive" }, "patch": { "summary": "Update a call control application", "description": "Updates settings of an existing call control application.", "operationId": "UpdateCallControlApplication", "tags": [ "Call Control Applications" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string", "format": "int64", "example": "1293384261075731499" } } ], "requestBody": { "description": "Update call control application request.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCallControlApplicationRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlApplicationResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "interactive" } }, "/call_events": { "get": { "summary": "List call events", "description": "Filters call events by given filter parameters. Events are ordered by `event_timestamp`. If filter for `call_leg_id` or `call_session_id` is not present, it only filters events from the last 24 hours.\n\n**Note**: Only one `filter[event_timestamp]` can be passed.\n", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "ListCallEvents", "tags": [ "Debugging" ], "parameters": [ { "$ref": "#/components/parameters/FilterCallLegId" }, { "$ref": "#/components/parameters/FilterCallSessionId" }, { "$ref": "#/components/parameters/FilterCallEventStatus" }, { "$ref": "#/components/parameters/FilterCallEventType" }, { "$ref": "#/components/parameters/FilterCallEventTimestampGreaterThan" }, { "$ref": "#/components/parameters/FilterCallEventTimestampGreaterThanOrEqualTo" }, { "$ref": "#/components/parameters/FilterCallEventTimestampLessThan" }, { "$ref": "#/components/parameters/FilterCallEventTimestampLessThanOrEqualTo" }, { "$ref": "#/components/parameters/FilterCallEventTimestampEqualTo" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListCallEventsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/calls": { "post": { "summary": "Dial", "description": "Dial a number or SIP URI from a given connection. A successful response will include a `call_leg_id` which can be used to correlate the command with subsequent webhooks.\n\n**Expected Webhooks:**\n\n- `call.initiated`\n- `call.answered` or `call.hangup`\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 greeting\n- `call.machine.premium.detection.ended` if `answering_machine_detection=premium` was requested\n- `call.machine.premium.greeting.ended` if `answering_machine_detection=premium` was requested and a beep was detected\n- `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url` was set\n", "operationId": "DialCall", "tags": [ "Call Commands" ], "requestBody": { "description": "Call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/RetrieveCallStatusResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callInitiated": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallInitiatedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callBridged": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallBridgedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callAnswered": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallAnsweredEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callHangup": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallHangupEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callMachinePremiumDetectionEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallMachinePremiumDetectionEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callMachinePremiumGreetingEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallMachinePremiumGreetingEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callMachineDetectionEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallMachineDetectionEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callMachineGreetingEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallMachineGreetingEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "streamingStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "streamingStopped": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingStoppedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "streamingFailed": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingFailedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/register": { "post": { "summary": "Register the call for Google Verified Calls", "description": "Register the call before dialing to show your brand on callee's phone.", "operationId": "RegisterCall", "tags": [ "Register Call" ], "parameters": [], "requestBody": { "description": "Register call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterCallRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/RegisterCallResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/calls/{call_control_id}": { "get": { "summary": "Retrieve a call status", "description": "Returns the status of a call (data is available 10 minutes after call ended).", "operationId": "RetrieveCallStatus", "tags": [ "Call Information" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "responses": { "200": { "$ref": "#/components/responses/RetrieveCallStatusResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/answer": { "post": { "summary": "Answer call", "description": "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- `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url` was set\n", "operationId": "AnswerCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Answer call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnswerRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callAnswered": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallAnsweredEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "streamingStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "streamingStopped": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingStoppedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "streamingFailed": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingFailedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/bridge": { "post": { "summary": "Bridge calls", "description": "Bridge two call control calls.\n\n**Expected Webhooks:**\n\n- `call.bridged` for Leg A\n- `call.bridged` for Leg B\n", "operationId": "BridgeCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Bridge call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BridgeRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callBridged": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallBridgedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/client_state_update": { "put": { "summary": "Update client state", "description": "Updates client state", "operationId": "UpdateClientState", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Updates client state for every subsequent webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientStateUpdateRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": {}, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/enqueue": { "post": { "summary": "Enqueue call", "description": "Put the call in a queue.", "operationId": "EnqueueCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Enqueue call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnqueueRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callEnqueued": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallEnqueuedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callLeftQueue": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLeftQueueEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/fork_start": { "post": { "summary": "Forking start", "description": "Call forking allows you to stream the media from a call to a specific target in realtime. \nThis stream can be used to enable realtime audio analysis to support a \nvariety of use cases, including fraud detection, or the creation of AI-generated audio responses. \nRequests must specify either the `target` attribute or the `rx` and `tx` attributes.\n\n**Expected Webhooks:**\n\n- `call.fork.started`\n- `call.fork.stopped`\n\n**Simple Telnyx RTP Encapsulation Protocol (STREP)**\n\n*Note: This header/encapsulation is not used when the `rx` and `tx`\nparameters have been specified; it only applies when media is forked\nusing the `target` attribute.*\n\nIf the destination for forked media is specified using the \"target\"\nattribute, the RTP will be encapsulated in an extra Telnyx protocol,\nwhich adds a 24 byte header to the RTP payload in each packet. The STREP\nheader includes the Call Control `call_leg_id` for stream\nidentification, along with bits that represent the direction (inbound or\noutbound) of the media. This 24-byte header sits between the UDP header\nand the RTP header.\n\nThe STREP header makes it possible to fork RTP for multiple calls (or\ntwo RTP streams for the same call) to the same IP:port, where the\nstreams can be demultiplexed by your application using the information\nin the header. Of course, it's still possible to ignore this header\ncompletely, for example, if sending forked media for different calls to\ndifferent ports or IP addresses. In this case, simply strip 24 bytes\n(or use the second byte to find the header length) from the received UDP\npayload to get the RTP (RTP header and payload).\n\n```\nSTREP Specification\n\n 0 1 2 3\n 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1\n +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\n |1 1|Version|L|D| HeaderLen | reserved (2 bytes) |\n +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\n | reserved (4 bytes, for UDP ports or anything else) |\n +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\n | The call_leg_id |\n | from Call Control |\n | (128 bits / 16 bytes) |\n | (this is binary data) |\n +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+\n\n 11\n Static bits 11, always set to 11 to easily distinguish forked media\n from RTP (10) and T.38 media (usually 00) and SIP (which begins\n with a capital letter, so begins with bits 01). This is a magic number.\n\n Version\n Four bits to indicate the version number of the protocol, starting at 0001.\n\n L\n One bit to represent the leg of the call (A or B).\n 0 represents the A (first) leg of the call.\n 1 represents the B (second) leg of the call.\n\n D\n One bit to represent the direction of this RTP stream.\n 0 represents media received by Telnyx.\n 1 represents media transmitted by Telnyx.\n\n HeaderLen (1 byte)\n The length of the header in bytes.\n Note that this value does not include the length of the payload. The total\n size of the RTP can be calculated by subtracting the HeaderLen from the UDP\n length (minus 8 for the UDP header).\n In version 1, this value will always be 24.\n\n Reserved (6 bytes)\n Reserved for future use and to make sure that the header is a multiple of 32 bits\n\n Call Leg ID\n A 128-bit identifier for the call leg.\n This is the call_leg_id from Call Control.\n```\n", "operationId": "StartCallFork", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Fork media request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartForkingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callForkStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallForkStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callForkStopped": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallForkStoppedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/fork_stop": { "post": { "summary": "Forking stop", "description": "Stop forking a call.\n\n**Expected Webhooks:**\n\n- `call.fork.stopped`\n", "operationId": "StopCallFork", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Stop forking media request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopForkingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callForkStopped": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallForkStoppedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/gather": { "post": { "summary": "Gather", "description": "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", "operationId": "GatherCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Gather", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatherRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callDtmfReceived": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallDtmfReceivedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callGatherEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallGatherEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/gather_stop": { "post": { "summary": "Gather stop", "description": "Stop current gather.\n\n**Expected Webhooks:**\n\n- `call.gather.ended`\n", "operationId": "StopCallGather", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Stop current gather", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopGatherRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callGatherEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallGatherEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/gather_using_audio": { "post": { "summary": "Gather using audio", "description": "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 webhooks)\n- `call.gather.ended`\n", "operationId": "GatherUsingAudio", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Gather using audio request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatherUsingAudioRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callPlaybackStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallPlaybackStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callPlaybackEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallPlaybackEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callDtmfReceived": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallDtmfReceivedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callGatherEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallGatherEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/gather_using_speak": { "post": { "summary": "Gather using speak", "description": "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", "operationId": "GatherUsingSpeak", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Gather using speak request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatherUsingSpeakRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callDtmfReceived": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallDtmfReceivedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callGatherEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallGatherEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/hangup": { "post": { "summary": "Hangup call", "description": "Hang up the call.\n\n**Expected Webhooks:**\n\n- `call.hangup`\n- `call.recording.saved`\n", "operationId": "HangupCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Hangup request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HangupRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callHangup": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallHangupEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callRecordingSaved": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallRecordingSavedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callRecordingError": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/callRecordingErrorEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/leave_queue": { "post": { "summary": "Remove call from a queue", "description": "Removes the call from a queue.", "operationId": "LeaveQueue", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Removes the call from the queue, the call currently is enqueued in.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaveQueueRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callLeftQueue": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLeftQueueEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/playback_start": { "post": { "summary": "Play audio URL", "description": "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", "operationId": "StartCallPlayback", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Play audio URL request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlayAudioUrlRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callPlaybackStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallPlaybackStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callPlaybackEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallPlaybackEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/playback_stop": { "post": { "summary": "Stop audio playback", "description": "Stop audio being played on the call.\n\n**Expected Webhooks:**\n\n- `call.playback.ended` or `call.speak.ended`\n", "operationId": "StopCallPlayback", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Stop audio playback request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlaybackStopRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callPlaybackEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallPlaybackEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callSpeakEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallSpeakEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/record_pause": { "post": { "summary": "Record pause", "description": "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", "operationId": "PauseCallRecording", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Pause recording call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseRecordingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/record_resume": { "post": { "summary": "Record resume", "description": "Resume recording the call.\n\n**Expected Webhooks:**\n\nThere are no webhooks associated with this command.\n", "operationId": "ResumeCallRecording", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Resume recording call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeRecordingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/record_start": { "post": { "summary": "Recording start", "description": "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", "operationId": "StartCallRecord", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Start recording audio request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartRecordingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/record_stop": { "post": { "summary": "Recording stop", "description": "Stop recording the call.\n\n**Expected Webhooks:**\n\n- `call.recording.saved`\n", "operationId": "StopCallRecording", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Stop recording call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopRecordingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callRecordingSaved": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallRecordingSavedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callRecordingError": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/callRecordingErrorEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/refer": { "post": { "summary": "SIP Refer a call", "description": "Initiate a SIP Refer on a Call Control call. You can initiate a SIP Refer at any point in the duration of a call.\n\n**Expected Webhooks:**\n\n- `call.refer.started`\n- `call.refer.completed`\n- `call.refer.failed`\n", "operationId": "ReferCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Refer request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callReferStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallReferStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callReferCompleted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallReferCompletedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callReferFailed": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallReferFailedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/reject": { "post": { "summary": "Reject a call", "description": "Reject an incoming call.\n\n**Expected Webhooks:**\n\n- `call.hangup`\n", "operationId": "RejectCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Reject request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callHangup": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallHangupEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/send_dtmf": { "post": { "summary": "Send DTMF", "description": "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", "operationId": "SendDTMF", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Send DTMF request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendDTMFRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/speak": { "post": { "summary": "Speak text", "description": "Convert text to speech and play it back on the call. If multiple speak text commands are issued consecutively, the audio files will be placed in a queue awaiting playback.\n\n**Expected Webhooks:**\n\n- `call.speak.started`\n- `call.speak.ended`\n", "operationId": "SpeakCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Speak request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callSpeakStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallSpeakStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callSpeakEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallSpeakEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/streaming_start": { "post": { "summary": "Streaming start", "description": "Start streaming the media from a call to a specific WebSocket address or Dialogflow connection in near-realtime. Audio will be delivered as base64-encoded RTP payload (raw audio), wrapped in JSON payloads. \n\n**Example: Starting a stream to a Websocket address**\n\n The `stream_url` param is mandatory.\n\n```\ncurl -X POST \\ \n --header \"Content-Type: application/json\" \\ \n --header \"Accept: application/json\" \\ \n --header \"Authorization: Bearer YOUR_API_KEY\" \\ \n --data '{\n \"stream_url\": \"wss://www.example.com/websocket\",\\ \n\"client_state\":\"aGF2ZSBhIG5pY2UgZGF5ID1d\",\\ \n\"command_id\":\"891510ac-f3e4-11e8-af5b-de00688a4901\" \\ \n}' \\ \n https://api.telnyx.com/v2/calls/{call_control_id}/actions/streaming_start \n``` \n\n **Example: Starting a stream to a Dialogflow connection** \n\n Enable the Dialogflow integration by sending `\"enable_dialogflow\": true` in the request. You need to have a Dialogflow connection associated with your Call Control application first, [click here for instructions](https://developers.telnyx.com/docs/v2/call-control/tutorials/dialogflow-es).\n```\ncurl -X POST \\ \n --header \"Content-Type: application/json\" \\ \n --header \"Accept: application/json\" \\ \n --header \"Authorization: Bearer YOUR_API_KEY\" \\ \n --data '{\n \"client_state\":\"aGF2ZSBhIG5pY2UgZGF5ID1d\", \\ \n\"command_id\":\"891510ac-f3e4-11e8-af5b-de00688a4901\", \\ \n\"enable_dialogflow\": true \\ \n}' \\ \n https://api.telnyx.com/v2/calls/{call_control_id}/actions/streaming_start \n```\n\n**Expected Webhooks:**\n\n- `streaming.started`\n- `streaming.stopped`\n- `streaming.failed`\n\n**WebSocket events**\n\nWhen the WebSocket connection is established, the following event is being sent over it:\n```\n{\n \"event\": \"connected\",\n \"version\": \"1.0.0\"\n}\n```\nAnd when the call is started, an event which contains information about the encoding and `stream_id` that identifies a particular stream:\n```\n{\n \"event\": \"start\",\n \"sequence_number\": \"1\",\n \"start\": {\n \"user_id\": \"3e6f995f-85f7-4705-9741-53b116d28237\",\n \"call_control_id\": \"v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg\", \n \"client_state\": \"aGF2ZSBhIG5pY2UgZGF5ID1d\",\n \"media_format\": {\n \"encoding\": \"PCMU\",\n \"sample_rate\": 8000,\n \"channels\": 1\n }\n },\n \"stream_id\": \"32de0dea-53cb-4b21-89a4-9e1819c043bc\"\n}\n```\nThe start event is followed by the following media events that contain base64-encoded RTP payload (raw audio, no RTP headers) (:\n```\n{ \n \"event\": \"media\",\n \"sequence_number\": \"4\",\n \"media\": { \n \"track\": \"inbound/outbound\", \n \"chunk\": \"2\",\n \"timestamp\": \"5\",\n \"payload\": \"no+JhoaJjpzSHxAKBgYJD...IsSbjomGhoqQn1Ic\" \n },\n \"stream_id\": \"32de0dea-53cb-4b21-89a4-9e1819c043bc\" \n}\n```\nPlease note that the order of events is not guaranteed and the chunk number can be used to reorder the events.\n\nWhen the call ends, the stop event over WebSockets connection is sent:\n```\n{ \n \"event\": \"stop\",\n \"sequence_number\": \"5\",\n \"stop\": {\n \"user_id\": \"3e6f995f-85f7-4705-9741-53b116d28237\",\n \"call_control_id\": \"v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQ\"\n },\n \"stream_id\": \"32de0dea-53cb-4b21-89a4-9e1819c043bc\" \n }\n```\n\n**Bidirectional Media Streaming**\n\nMedia can be sent back to the call through the websocket as well. This is done in a way very similar to the [playback_start](https://developers.telnyx.com/docs/api/v2/call-control/Call-Commands#callPlaybackStart)\ncommand, when using a base64 encoded mp3 file in the payload. Simply send a packet to the websocket connection as follows:\n\n```\n{\n \"event\": \"media\",\n \"media\": {\n \"payload\" : \n }\n}\n```\n\nThe payload, which is a base64-encoded mp3 file, will be played on the call.\n\nSome limitations to be aware of:\n\n- Media payloads can only be submitted once per second.\n- Media _must_ be base64 encoded mp3\n\n**Stream Errors**\n\nAny errors in the media packet, including when a rate limit is reached, will result in an error frame being\nsent to your websocket server. The error frame will appear as follows:\n\n```\n{\n \"stream_id\": \"32de0dea-53cb-4b21-89a4-9e1819c043bc\",\n \"event\": \"error\",\n \"sequence_number\": \"6\",\n \"error\": {\n \"title\": \"rate_limit_reached\",\n \"code\": \"100005\",\n \"detail\": \"Too many requests\"\n }\n}\n```\n\nPossible errors are as follows:\n\n- Error 100002: `\"unknown_error\"`\n- Error 100003: `\"malformed_frame\"`\n- Error 100004: `\"invalid_media\"`\n- Error 100005: `\"rate_limit_reached\"`\n", "operationId": "StartCallStreaming", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Start streaming media request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartStreamingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callStreamingStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callStreamingStopped": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingStoppedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callStreamingFailed": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingFailedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/streaming_stop": { "post": { "summary": "Streaming stop", "description": "Stop streaming a call to a WebSocket.\n\n**Expected Webhooks:**\n\n- `streaming.stopped`\n", "operationId": "StopCallStreaming", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Stop streaming media request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopStreamingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callStreamingStopped": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallStreamingStoppedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/suppression_start": { "post": { "operationId": "noiseSuppressionStart", "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoiseSuppressionStart" } } }, "description": "Start streaming media request", "required": true }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "summary": "Noise Suppression Start (BETA)", "tags": [ "Call Commands" ], "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/suppression_stop": { "post": { "operationId": "noiseSuppressionStop", "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoiseSuppressionStop" } } }, "description": "Start streaming media request", "required": true }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "summary": "Noise Suppression Stop (BETA)", "tags": [ "Call Commands" ], "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/transcription_start": { "post": { "summary": "Transcription start", "description": "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", "operationId": "StartCallTranscription", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Transcription start request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionStartRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "transcription": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/transcription_stop": { "post": { "summary": "Transcription stop", "description": "Stop real-time transcription.", "operationId": "StopCallTranscription", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Transcription stop request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TranscriptionStopRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/calls/{call_control_id}/actions/transfer": { "post": { "summary": "Transfer call", "description": "Transfer a call to a new destination. If the transfer is unsuccessful, a `call.hangup` webhook for the other call (Leg B) will be sent indicating that the transfer could not be completed. The original call will remain active and may be issued additional commands, potentially transfering the call to an alternate destination.\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 requested\n- `call.machine.greeting.ended` if `answering_machine_detection` was requested to detect the end of machine greeting\n- `call.machine.premium.detection.ended` if `answering_machine_detection=premium` was requested\n- `call.machine.premium.greeting.ended` if `answering_machine_detection=premium` was requested and a beep was detected\n", "operationId": "TransferCall", "tags": [ "Call Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallControlId" } ], "requestBody": { "description": "Transfer call request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferCallRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CallControlCommandResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "callInitiated": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallInitiatedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callBridged": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallBridgedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callAnswered": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallAnsweredEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callHangup": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallHangupEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callMachinePremiumDetectionEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallMachinePremiumDetectionEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callMachinePremiumGreetingEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallMachinePremiumGreetingEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callMachineDetectionEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallMachineDetectionEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "callMachineGreetingEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallMachineGreetingEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/campaign": { "get": { "tags": [ "Campaign" ], "summary": "List Campaigns", "operationId": "GetCampaigns", "parameters": [ { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "query" }, { "description": "The 1-indexed page number to get. The default value is `1`.", "required": false, "schema": { "title": "Page", "type": "integer", "description": "The 1-indexed page number to get. The default value is `1`.", "default": 1 }, "name": "page", "in": "query" }, { "description": "The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.", "required": false, "schema": { "title": "Recordsperpage", "type": "integer", "description": "The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.", "default": 10 }, "name": "recordsPerPage", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignRecordSet_CSP" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve a list of campaigns associated with a supplied `brandId`.", "x-latency-category": "responsive" } }, "/campaign/acceptSharing/{campaignId}": { "post": { "tags": [ "Campaign" ], "summary": "Accept Shared Campaign", "description": "Manually accept a campaign shared with Telnyx", "operationId": "AcceptCampaign", "parameters": [ { "description": "TCR's ID for the campaign to import", "required": true, "schema": { "title": "Campaignid", "pattern": "^C[A-Z0-9]{5,8}$", "type": "string", "description": "TCR's ID for the campaign to import" }, "name": "campaignId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/campaign/usecase/cost": { "get": { "tags": [ "Campaign" ], "summary": "Get Campaign Cost", "operationId": "GetCampaignCost", "parameters": [ { "required": true, "schema": { "title": "Usecase", "type": "string" }, "name": "usecase", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCost" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/campaign/{campaignId}": { "delete": { "tags": [ "Campaign" ], "summary": "Deactivate My Campaign", "description": "Terminate a campaign. Note that once deactivated, a campaign cannot be restored.", "operationId": "DeactivateCampaign", "parameters": [ { "required": true, "schema": { "title": "Campaignid", "type": "string" }, "name": "campaignId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignDeletionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Campaign" ], "summary": "Get My Campaign", "operationId": "GetCampaign", "parameters": [ { "required": true, "schema": { "title": "Campaignid", "type": "string" }, "name": "campaignId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign_CSP" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve campaign details by `campaignId`.", "x-latency-category": "responsive" }, "put": { "tags": [ "Campaign" ], "summary": "Update My Campaign", "operationId": "UpdateCampaign", "parameters": [ { "required": true, "schema": { "title": "Campaignid", "type": "string" }, "name": "campaignId", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCampaign" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Update a campaign's properties by `campaignId`. **Please note:** only sample messages are editable.", "x-latency-category": "responsive" } }, "/campaign/{campaignId}/mnoMetadata": { "get": { "tags": [ "Campaign" ], "summary": "Get Campaign Mno Metadata", "description": "Get the campaign metadata for each MNO it was submitted to", "operationId": "GetCampaignMnoMetadata", "parameters": [ { "description": "ID of the campaign in question", "required": true, "schema": { "title": "Campaignid", "type": "string", "description": "ID of the campaign in question" }, "name": "campaignId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Get Campaign Mno Metadata Public Campaign Campaignid Mnometadata Get", "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/campaign/{campaignId}/operationStatus": { "get": { "tags": [ "Campaign" ], "summary": "Get My Campaign Operation Status", "operationId": "GetCampaignOperationStatus", "parameters": [ { "required": true, "schema": { "title": "Campaignid", "type": "string" }, "name": "campaignId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Get My Campaign Operation Status Public Campaign Campaignid Operationstatus Get", "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve campaign's operation status at MNO level.", "x-latency-category": "responsive" } }, "/campaign/{campaignId}/osr/attributes": { "get": { "tags": [ "Campaign" ], "summary": "Get My Osr Campaign Attributes", "operationId": "GetCampaignOsrAttributes", "parameters": [ { "required": true, "schema": { "title": "Campaignid", "type": "string" }, "name": "campaignId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Get My Osr Campaign Attributes Public Campaign Campaignid Osr Attributes Get", "type": "object" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/campaign/{campaignId}/sharing": { "get": { "tags": [ "Campaign" ], "summary": "Get Sharing Status", "operationId": "GetCampaignSharingStatus", "parameters": [ { "description": "ID of the campaign in question", "required": true, "schema": { "title": "Campaignid", "type": "string", "description": "ID of the campaign in question" }, "name": "campaignId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignSharingChain" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/campaignBuilder": { "post": { "tags": [ "Campaign" ], "summary": "Submit Campaign", "operationId": "PostCampaign", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Submit Campaign Public Campaignbuilder Post", "anyOf": [ { "type": "object" }, { "$ref": "#/components/schemas/Campaign_CSP" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Before creating a campaign, use the [Qualify By Usecase endpoint](https://developers.telnyx.com/docs/api/v2/10dlc/Campaign#qualify_by_usecase_campaignBuilder_brand__brand_id__usecase__usecase__get) to ensure that the brand you want to assign a new campaign to is qualified for the desired use case of that campaign. **Please note:** After campaign creation, you'll only be able to edit the campaign's sample messages. Creating a campaign will entail an upfront, non-refundable three month's cost that will depend on the campaign's use case ([see 10DLC Costs section for details](https://developers.telnyx.com/docs/api/v2/10dlc)).", "callbacks": { "campaignStatusUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignStatusUpdateEvent" } } } }, "responses": { "200": { "description": "The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL." } } } } } }, "x-latency-category": "responsive" } }, "/campaignBuilder/brand/{brandId}/usecase/{usecase}": { "get": { "tags": [ "Campaign" ], "summary": "Qualify By Usecase", "operationId": "GetUsecaseQualification", "parameters": [ { "required": true, "schema": { "title": "Usecase", "type": "string" }, "name": "usecase", "in": "path" }, { "required": true, "schema": { "title": "Brandid", "type": "string" }, "name": "brandId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsecaseMetadata" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case.", "x-latency-category": "responsive" } }, "/channel_zones": { "get": { "summary": "Get list of channel zones", "description": "List of channel zones with their countries", "operationId": "GetChannelZones", "tags": [ "ChannelZones" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/GetGcbChannelZonesRequestResponse" } }, "x-latency-category": "interactive" } }, "/channel_zones/{channel_zone_id}": { "get": { "summary": "Get a specific channel zone", "description": "Get a specific channel zone", "operationId": "GetChannelZone", "tags": [ "ChannelZones" ], "responses": { "200": { "$ref": "#/components/responses/GetGcbChannelZoneRequestResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" }, "parameters": [ { "$ref": "#/components/parameters/GcbChannelZoneId" } ], "patch": { "summary": "Patch a channel zone", "description": "Change the amount of reserved channels at a given channel zone", "operationId": "PatchChannelZone", "tags": [ "ChannelZones" ], "requestBody": { "description": "Quantity of reserved channels", "content": { "application/json": { "schema": { "type": "object", "properties": { "channels": { "type": "integer", "format": "int64" } } } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/PatchGcbChannelZoneRequestResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-codegen-request-body-name": "body", "x-latency-category": "interactive" } }, "/channel_zones/{channel_zone_id}/channel_zone_phone_numbers": { "get": { "summary": "Get the list of phone numbers assigned to a channel zone", "description": "Retrieve the assigned phone numbers in a channel zone. Phone numbers assigned to a channel zone can receive concurrent calls up to the quantity reserved in that channel zone. Additional concurrent calls are rejected with a busy signal.", "operationId": "GetPhoneNumbers", "tags": [ "ChannelZones" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/GetGcbPhoneNumbersRequestResponse" } }, "x-latency-category": "interactive" }, "parameters": [ { "$ref": "#/components/parameters/GcbChannelZoneId" } ], "post": { "summary": "Assign a phone number to a channel zone", "description": "You should own the phone number being assigned to the channel zone. Remember that you should reserve channels in this channel zone, otherwise you won't be able to receive incoming calls.", "operationId": "AssignPhoneNumber", "tags": [ "ChannelZones" ], "requestBody": { "description": "Phone number to assign to the channel zone. The phone number should be in E.164 format.", "content": { "application/json": { "schema": { "required": [ "phone_number" ], "type": "object", "properties": { "phone_number": { "type": "string", "format": "+E.164", "example": "+15554441234" } } } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/PostGcbPhoneNumberRequestResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-codegen-request-body-name": "body", "x-latency-category": "interactive" } }, "/channel_zones/{channel_zone_id}/channel_zone_phone_numbers/{phone_number}": { "delete": { "summary": "Unassign a phone number from a channel zone", "operationId": "UnassignPhoneNumber", "tags": [ "ChannelZones" ], "responses": { "200": { "description": "The phone number is successfully deleted" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" }, "parameters": [ { "$ref": "#/components/parameters/GcbChannelZoneId" }, { "$ref": "#/components/parameters/GcbPhoneNumber" } ] }, "/comments": { "get": { "summary": "Retrieve all comments", "operationId": "ListComments", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "filter[comment_record_type]", "in": "query", "description": "Record type that the comment relates to i.e number_order, sub_number_order or number_order_phone_number", "schema": { "type": "string", "example": "sub_number_order" }, "required": true }, { "name": "filter[comment_record_id]", "in": "query", "description": "ID of the record the comments relate to", "schema": { "type": "string", "example": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" }, "required": true } ], "responses": { "200": { "$ref": "#/components/responses/listCommentsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a comment", "operationId": "CreateComment", "tags": [ "Phone Number Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } }, "responses": { "200": { "$ref": "#/components/responses/CommentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/comments/{id}": { "get": { "summary": "Retrieve a comment", "operationId": "RetrieveComment", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "id", "in": "path", "description": "The comment ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/CommentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/comments/{id}/read": { "patch": { "summary": "Mark a comment as read", "operationId": "MarkCommentRead", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "id", "in": "path", "description": "The comment ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ReadCommentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/conferences": { "get": { "x-group-parameters": "true", "x-latency-category": "responsive", "description": "Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by `expires_at`.", "summary": "List conferences", "operationId": "ListConferences", "tags": [ "Conference Commands" ], "parameters": [ { "$ref": "#/components/parameters/FilterConferenceName" }, { "$ref": "#/components/parameters/FilterConferenceStatus" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListConferencesResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } } }, "post": { "summary": "Create conference", "description": "Create a conference from an existing call leg using a `call_control_id` and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.\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.floor.changed`\n", "operationId": "CreateConference", "tags": [ "Conference Commands" ], "requestBody": { "description": "Create a conference", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConferenceRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "callbacks": { "conferenceCreated": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceCreatedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceParticipantJoined": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantJoinedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceParticipantLeft": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantLeftEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceFloorChanged": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceFloorChangedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/conferences/{conference_id}/participants": { "get": { "description": "Lists conference participants", "summary": "List conference participants", "operationId": "ListConferenceParticipants", "tags": [ "Conference Commands" ], "parameters": [ { "name": "conference_id", "description": "Uniquely identifies the conference by id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filter[muted]", "in": "query", "description": "If present, participants will be filtered to those who are/are not muted", "schema": { "type": "boolean" } }, { "name": "filter[on_hold]", "in": "query", "description": "If present, participants will be filtered to those who are/are not put on hold", "schema": { "type": "boolean" } }, { "name": "filter[whispering]", "in": "query", "description": "If present, participants will be filtered to those who are whispering or are not", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListParticipantsResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}": { "get": { "summary": "Retrieve a conference", "description": "Retrieve an existing conference", "operationId": "RetrieveConference", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ConferenceResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/hold": { "post": { "summary": "Hold conference participants", "description": "Hold a list of participants in a conference call", "operationId": "HoldConferenceParticipants", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceHoldRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/join": { "post": { "summary": "Join a conference", "description": "Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the `call_control_id` of the leg you wish to join to the conference as an attribute. The conference can have up to a certain amount of active participants, as set by the `max_participants` parameter in conference creation request. \n\n**Expected Webhooks:**\n\n- `conference.participant.joined`\n- `conference.participant.left`\n", "operationId": "JoinConference", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Join Conference request object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JoinConferenceRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "callbacks": { "conferenceParticipantJoined": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantJoinedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceParticipantLeft": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantLeftEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/leave": { "post": { "summary": "Leave a conference", "description": "Removes a call leg from a conference and moves it back to parked state. **Expected Webhooks:**\n\n- `conference.participant.left`\n", "operationId": "LeaveConference", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Leave Conference request object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaveConferenceRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "callbacks": { "conferenceParticipantLeft": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantLeftEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/mute": { "post": { "summary": "Mute conference participants", "description": "Mute a list of participants in a conference call", "operationId": "MuteConferenceParticipants", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceMuteRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/play": { "post": { "summary": "Play audio to conference participants", "description": "Play audio to all or some participants on a conference call.", "operationId": "PlayConferenceAudio", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferencePlayRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "callbacks": { "conferencePlaybackStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferencePlaybackStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferencePlaybackEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferencePlaybackEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceParticipantPlaybackStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantPlaybackStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceParticipantPlaybackEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantPlaybackEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/record_pause": { "post": { "summary": "Conference recording pause", "description": "Pause conference recording.", "operationId": "PauseConferenceRecording", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Specifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseConferenceRecordingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/record_resume": { "post": { "summary": "Conference recording resume", "description": "Resume conference recording.", "operationId": "ResumeConferenceRecording", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Specifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumeConferenceRecordingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/record_start": { "post": { "summary": "Conference recording start", "description": "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`", "operationId": "StartConferenceRecording", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Specifies the conference to record by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartConferenceRecordingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/record_stop": { "post": { "summary": "Conference recording stop", "description": "Stop recording the conference.\n\n**Expected Webhooks:**\n\n- `conference.recording.saved`\n", "operationId": "StopConferenceRecording", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Specifies the conference to stop the recording for by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Stop recording conference request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopRecordingRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "callbacks": { "conferenceRecordingSaved": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceRecordingSavedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/speak": { "post": { "summary": "Speak text to conference participants", "description": "Convert text to speech and play it to all or some participants.", "operationId": "SpeakTextToConference", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Specifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceSpeakRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "callbacks": { "conferenceSpeakStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceSpeakStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceSpeakEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceSpeakEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceParticipantSpeakStarted": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantSpeakStartedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "conferenceParticipantSpeakEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantSpeakEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/stop": { "post": { "summary": "Stop audio being played on the conference", "description": "Stop audio being played to all or some participants on a conference call.", "operationId": "StopConferenceAudio", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceStopRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "callbacks": { "conferenceParticipantPlaybackEnded": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceParticipantPlaybackEndedEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/unhold": { "post": { "summary": "Unhold conference participants", "description": "Unhold a list of participants in a conference call", "operationId": "UnholdConferenceParticipants", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceUnholdRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/unmute": { "post": { "summary": "Unmute conference participants", "description": "Unmute a list of participants in a conference call", "operationId": "UnmuteConferenceParticipants", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConferenceUnmuteRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/conferences/{id}/actions/update": { "post": { "summary": "Update conference participant", "description": "Update conference participant supervisor_role", "operationId": "UpdateConference", "tags": [ "Conference Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the conference by id or name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Update Conference request object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateConferenceRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ConferenceCommandResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "interactive" } }, "/connections": { "get": { "description": "Returns a list of your connections irrespective of type.", "summary": "List connections", "operationId": "ListConnections", "tags": [ "Connections" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterConnectionName" }, { "$ref": "#/components/parameters/FilterOutboundVoiceProfileId" }, { "$ref": "#/components/parameters/SortConnection" } ], "responses": { "200": { "$ref": "#/components/responses/ListConnectionsResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" } }, "x-latency-category": "responsive" } }, "/connections/{connection_id}/active_calls": { "get": { "summary": "List all active calls for given connection", "description": "Lists all active calls for given connection. Acceptable connections are either SIP connections with webhook_url or xml_request_url, call control or texml. Returned results are cursor paginated.\n", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "ListConnectionActiveCalls", "tags": [ "Call information" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" }, { "$ref": "#/components/parameters/PageLimit" }, { "$ref": "#/components/parameters/PageAfter" }, { "$ref": "#/components/parameters/PageBefore" } ], "responses": { "200": { "$ref": "#/components/responses/ActiveCallsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/connections/{id}": { "get": { "description": "Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.", "summary": "Retrieve a connection", "operationId": "RetrieveConnection", "tags": [ "Connections" ], "parameters": [ { "name": "id", "in": "path", "description": "IP Connection ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ConnectionResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" } }, "/credential_connections": { "get": { "description": "Returns a list of your credential connections.", "summary": "List credential connections", "operationId": "ListCredentialConnections", "tags": [ "Credential Connections" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterConnectionName" }, { "$ref": "#/components/parameters/FilterInnerOutboundVoiceProfileId" }, { "$ref": "#/components/parameters/SortConnection" } ], "responses": { "200": { "$ref": "#/components/responses/ListCredentialConnectionsResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates a credential connection.", "summary": "Create a credential connection", "operationId": "CreateCredentialConnection", "tags": [ "Credential Connections" ], "x-endpoint-cost": "medium", "parameters": [], "requestBody": { "description": "Parameters that can be defined during credential connection creation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialConnectionRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/CredentialConnectionResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/credential_connections/{id}": { "delete": { "description": "Deletes an existing credential connection.", "summary": "Delete a credential connection", "operationId": "DeleteCredentialConnection", "tags": [ "Credential Connections" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/CredentialConnectionResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Retrieves the details of an existing credential connection.", "summary": "Retrieve a credential connection", "operationId": "RetrieveCredentialConnection", "tags": [ "Credential Connections" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/CredentialConnectionResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Updates settings of an existing credential connection.", "summary": "Update a credential connection", "operationId": "UpdateCredentialConnection", "tags": [ "Credential Connections" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters that can be updated in a credential connection", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCredentialConnectionRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/CredentialConnectionResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/credential_connections/{id}/actions/check_registration_status": { "post": { "description": "Updates the registration_status for a credential connection, this endpoint also updates the `registration_status` and `registration_status_updated_at` fields in the credential connection", "summary": "Update a credential connection registration status", "operationId": "CheckRegistrationStatus", "tags": [ "Credential Connections" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/RegistrationStatusResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" } }, "/custom_storage_credentials/{connection_id}": { "delete": { "summary": "Delete stored credentials", "description": "Deletes a stored custom credentials configuration.", "operationId": "DeleteCustomStorageCredentials", "tags": [ "Call Recordings" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" } ], "responses": { "204": { "description": "The credentials configuration for connection_id was deleted successfully." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve stored credentials", "description": "Returns the information about custom storage credentials.", "operationId": "GetCustomStorageCredentials", "tags": [ "Call Recordings" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" } ], "responses": { "200": { "$ref": "#/components/responses/CredentialsResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create custom storage credentials", "description": "Creates custom storage credentials configuration.", "operationId": "CreateCustomStorageCredentials", "tags": [ "Call Recordings" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" } ], "requestBody": { "$ref": "#/components/requestBodies/CreateCredentialsRequest" }, "responses": { "200": { "$ref": "#/components/responses/CredentialsResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "put": { "summary": "Update stored credentials", "description": "Updates a stored custom credentials configuration.", "operationId": "UpdateCustomStorageCredentials", "tags": [ "Call Recordings" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" } ], "requestBody": { "$ref": "#/components/requestBodies/CreateCredentialsRequest" }, "responses": { "200": { "$ref": "#/components/responses/CredentialsResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/customer_service_records": { "get": { "tags": [ "Customer Service Record" ], "summary": "List customer service records", "description": "List customer service records.", "operationId": "ListCustomerServiceRecords", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "sort[]", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "schema": { "type": "string", "enum": [ "created_at", "-created_at" ], "example": "created_at" } }, { "$ref": "#/components/parameters/PhoneNumberEqFilter" }, { "$ref": "#/components/parameters/PhoneNumberInFilter" }, { "$ref": "#/components/parameters/StatusEqFilter" }, { "$ref": "#/components/parameters/StatusInFilter" }, { "$ref": "#/components/parameters/CreatedAtLtFilter" }, { "$ref": "#/components/parameters/CreatedAtGtFilter" } ], "responses": { "200": { "$ref": "#/components/responses/ListCustomerServiceRecords" }, "401": { "$ref": "#/components/responses/UnauthorizedErrorResponse" }, "403": { "$ref": "#/components/responses/ForbiddenErrorResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityErrorResponse" }, "500": { "$ref": "#/components/responses/UnexpectedErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Customer Service Record" ], "summary": "Create a customer service record", "description": "Create a new customer service record for the provided phone number.", "operationId": "CreateCustomerServiceRecord", "requestBody": { "$ref": "#/components/requestBodies/CreateCustomerServiceRecord" }, "responses": { "201": { "$ref": "#/components/responses/CreateCustomerServiceRecord" }, "401": { "$ref": "#/components/responses/UnauthorizedErrorResponse" }, "403": { "$ref": "#/components/responses/ForbiddenErrorResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityErrorResponse" }, "500": { "$ref": "#/components/responses/UnexpectedErrorResponse" } }, "callbacks": { "CustomerServiceRecordStatusChanged": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerServiceRecordStatusChangedEvent" }, "meta": { "$ref": "#/components/schemas/CallbackWebhookMeta" } } } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "responsive" } }, "/customer_service_records/phone_number_coverages": { "post": { "tags": [ "Customer Service Record" ], "summary": "Verify CSR phone number coverage", "description": "Verify the coverage for a list of phone numbers.", "operationId": "VerifyPhoneNumberCoverage", "requestBody": { "$ref": "#/components/requestBodies/VerifyCustomerServiceRecordPhoneNumberCoverage" }, "responses": { "201": { "$ref": "#/components/responses/ListCustomerServiceRecordPhoneNumberCoverage" }, "401": { "$ref": "#/components/responses/UnauthorizedErrorResponse" }, "403": { "$ref": "#/components/responses/ForbiddenErrorResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityErrorResponse" }, "500": { "$ref": "#/components/responses/UnexpectedErrorResponse" } }, "x-latency-category": "responsive" } }, "/customer_service_records/{customer_service_record_id}": { "get": { "tags": [ "Customer Service Record" ], "summary": "Get a customer service record", "description": "Get a specific customer service record.", "operationId": "GetCustomerServiceRecord", "parameters": [ { "$ref": "#/components/parameters/PathCustomerServiceRecordId" } ], "responses": { "201": { "$ref": "#/components/responses/ShowCustomerServiceRecord" }, "401": { "$ref": "#/components/responses/UnauthorizedErrorResponse" }, "403": { "$ref": "#/components/responses/ForbiddenErrorResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFoundErrorResponse" }, "500": { "$ref": "#/components/responses/UnexpectedErrorResponse" } }, "x-latency-category": "responsive" } }, "/detail_records": { "get": { "tags": [ "Detail Records" ], "summary": "Search detail records", "description": "Search for any detail record across the Telnyx Platform", "operationId": "SearchDetailRecords", "parameters": [ { "name": "filter[record_type]", "in": "query", "description": "Filter by the given record type.", "required": true, "schema": { "type": "string", "enum": [ "amd", "conference", "conference-participant", "media_storage", "messaging", "verify", "whatsapp", "whatsapp-conversation", "wireless" ] }, "examples": { "filter[record_type]=messaging": { "value": "messaging", "summary": "Searches for messaging detail records" }, "filter[record_type]=verify": { "value": "verify", "summary": "Searches for verify detail records" } } }, { "name": "filter[date_range]", "in": "query", "description": "Filter by the given user-friendly date range. You can specify one of the following enum values, or a dynamic one using this format: last_N_days.", "required": false, "schema": { "type": "string", "enum": [ "yesterday", "today", "tomorrow", "last_week", "this_week", "next_week", "last_month", "this_month", "next_month" ] }, "examples": { "filter[date_range]=today": { "value": "today", "summary": "Searches for records with timestamp starting at `00:00:00` of the current day" }, "filter[date_range]=yesterday": { "value": "yesterday", "summary": "Searches for records with timestamp starting at `00:00:00` of yesterday" }, "filter[date_range]=last_month": { "value": "last_month", "summary": "Searches for records with timestamp starting at `00:00:00` on the first day of the month" } } }, { "name": "filter", "in": "query", "description": "Filter records on a given record attribute and value.
Example: filter[status]=delivered", "required": false, "schema": { "type": "object", "additionalProperties": true }, "examples": { "filter[created_at][gte]=2021-06-22": { "value": "2021-06-22", "summary": "Searches for records with `created_at` starting at `2021-06-22`" }, "filter[created_at][lt]=2021-06-23": { "value": "2021-06-23", "summary": "Searches for records with `created_at` ending at `2021-06-22`" }, "filter[direction]=inbound": { "value": "inbound", "summary": "Searches for records which have the property `direction` equal to `inbound`" }, "filter[cld][starts_with]=123": { "value": "123", "summary": "Searches for records which have the property `cld` starting with the prefix `123`" }, "filter[cld][ends_with]=789": { "value": "789", "summary": "Searches for records which have the property `cld` ending with the suffix `789`" }, "filter[cld][contains]=456": { "value": "456", "summary": "Searches for records which have the property `cld` containing the pattern `456`" } } }, { "name": "page[number]", "in": "query", "description": "Page number", "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } }, { "name": "page[size]", "in": "query", "description": "Page size", "schema": { "type": "integer", "format": "int32", "default": 20, "minimum": 1, "maximum": 50 } }, { "name": "sort", "description": "Specifies the sort order for results.
Example: sort=-created_at", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "examples": { "sort=created_at": { "value": "created_at", "summary": "Sorts search results using the `created_at` date-time in ascending order" }, "sort=-created_at": { "value": "created_at", "summary": "Sorts search results using the `created_at` date-time in descending order" } } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetailRecordsSearchResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "interactive" } }, "/dialogflow_connections/{connection_id}": { "delete": { "summary": "Delete stored Dialogflow Connection", "description": "Deletes a stored Dialogflow Connection.", "operationId": "DeleteDialogflowConnection", "tags": [ "Dialogflow Integration" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" } ], "responses": { "204": { "description": "The Dialogflow Connection for connection_id was deleted successfully." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve stored Dialogflow Connection", "description": "Return details of the Dialogflow connection associated with the given CallControl connection.", "operationId": "GetDialogflowConnection", "tags": [ "Dialogflow Integration" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" } ], "responses": { "200": { "$ref": "#/components/responses/DialogflowConnectionResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a Dialogflow Connection", "description": "Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services.", "operationId": "CreateDialogflowConnection", "tags": [ "Dialogflow Integration" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" } ], "requestBody": { "$ref": "#/components/requestBodies/DialogflowConnectionRequest" }, "responses": { "201": { "$ref": "#/components/responses/DialogflowConnectionResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "put": { "summary": "Update stored Dialogflow Connection", "description": "Updates a stored Dialogflow Connection.", "operationId": "UpdateDialogflowConnection", "tags": [ "Dialogflow Integration" ], "parameters": [ { "$ref": "#/components/parameters/ConnectionId" } ], "requestBody": { "$ref": "#/components/requestBodies/DialogflowConnectionRequest" }, "responses": { "200": { "$ref": "#/components/responses/DialogflowConnectionResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/document_links": { "get": { "summary": "List all document links", "description": "List all documents links ordered by created_at descending.", "operationId": "ListDocumentLinks", "x-latency-category": "responsive", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/DocServiceDocumentIdFilter" }, { "$ref": "#/components/parameters/LinkedRecordTypeFilter" }, { "$ref": "#/components/parameters/LinkedResourceIdFilter" } ], "responses": { "200": { "$ref": "#/components/responses/ListDocServiceDocumentLinksResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/documents": { "get": { "summary": "List all documents", "description": "List all documents ordered by created_at descending.", "operationId": "ListDocuments", "x-latency-category": "responsive", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/DocumentsFilenameContainsFilter" }, { "$ref": "#/components/parameters/DocumentsCustomerReferenceEqFilter" }, { "$ref": "#/components/parameters/DocumentsCustomerReferenceInFilter" }, { "$ref": "#/components/parameters/DocumentsCreatedAtGreaterThanFilter" }, { "$ref": "#/components/parameters/DocumentsCreatedAtLessThanFilter" }, { "$ref": "#/components/parameters/DocumentsSort" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListDocServiceDocumentsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } }, "post": { "summary": "Upload a document", "description": "Upload a document.

Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.", "operationId": "CreateDocument", "x-latency-category": "responsive", "tags": [ "Documents" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocServiceDocumentRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateMultiPartDocServiceDocumentRequest" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/DocServiceDocumentResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/documents/{id}": { "delete": { "summary": "Delete a document", "description": "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.", "operationId": "DeleteDocument", "x-latency-category": "responsive", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "$ref": "#/components/responses/DocServiceDocumentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } }, "get": { "summary": "Retrieve a document", "description": "Retrieve a document.", "operationId": "RetrieveDocument", "x-latency-category": "responsive", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "$ref": "#/components/responses/DocServiceDocumentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } }, "patch": { "summary": "Update a document", "description": "Update a document.", "operationId": "UpdateDocument", "x-latency-category": "responsive", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocServiceDocument" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/DocServiceDocumentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/documents/{id}/download": { "get": { "summary": "Download a document", "description": "Download a document.", "operationId": "DownloadDocument", "x-latency-category": "responsive", "tags": [ "Documents" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "$ref": "#/components/responses/DownloadDocServiceDocumentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/dynamic_emergency_addresses": { "get": { "summary": "List dynamic emergency addresses", "description": "Returns the dynamic emergency addresses according to filters", "operationId": "ListDynamicEmergencyAddresses", "tags": [ "Dynamic Emergency Addresses" ], "parameters": [ { "name": "filter[status]", "in": "query", "description": "Filter by status.", "required": false, "schema": { "type": "string", "enum": [ "pending", "activated", "rejected" ] } }, { "name": "filter[country_code]", "in": "query", "description": "Filter by country code.", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/listDynamicEmergencyAddresses" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a dynamic emergency address.", "description": "Creates a dynamic emergency address.", "operationId": "CreateDynamicEmergencyAddress", "tags": [ "Dynamic Emergency Addresses" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicEmergencyAddress" } } } }, "responses": { "201": { "$ref": "#/components/responses/DynamicEmergencyAddressResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/dynamic_emergency_addresses/{id}": { "delete": { "summary": "Delete a dynamic emergency address", "description": "Deletes the dynamic emergency address based on the ID provided", "operationId": "DeleteDynamicEmergencyAddress", "tags": [ "Dynamic Emergency Addresses" ], "parameters": [ { "name": "id", "in": "path", "description": "Dynamic Emergency Address id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/DynamicEmergencyAddressResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "get": { "summary": "Get a dynamic emergency address", "description": "Returns the dynamic emergency address based on the ID provided", "operationId": "GetDynamicEmergencyAddress", "tags": [ "Dynamic Emergency Addresses" ], "parameters": [ { "name": "id", "in": "path", "description": "Dynamic Emergency Address id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/DynamicEmergencyAddressResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/dynamic_emergency_endpoints": { "get": { "summary": "List dynamic emergency endpoints", "description": "Returns the dynamic emergency endpoints according to filters", "operationId": "ListDynamicEmergencyEndpoints", "tags": [ "Dynamic Emergency Endpoints" ], "parameters": [ { "name": "filter[status]", "in": "query", "description": "Filter by status.", "required": false, "schema": { "type": "string", "enum": [ "pending", "activated", "rejected" ] } }, { "name": "filter[country_code]", "in": "query", "description": "Filter by country code.", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/listDynamicEmergencyEndpoints" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a dynamic emergency endpoint.", "description": "Creates a dynamic emergency endpoints.", "operationId": "CreateDynamicEmergencyEndpoint", "tags": [ "Dynamic Emergency Endpoints" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicEmergencyEndpoint" } } } }, "responses": { "201": { "$ref": "#/components/responses/DynamicEmergencyEndpointResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/dynamic_emergency_endpoints/{id}": { "delete": { "summary": "Delete a dynamic emergency endpoint", "description": "Deletes the dynamic emergency endpoint based on the ID provided", "operationId": "DeleteDynamicEmergencyEndpoint", "tags": [ "Dynamic Emergency Endpoints" ], "parameters": [ { "name": "id", "in": "path", "description": "Dynamic Emergency Endpoint id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/DynamicEmergencyEndpointResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "get": { "summary": "Get a dynamic emergency endpoint", "description": "Returns the dynamic emergency endpoint based on the ID provided", "operationId": "GetDynamicEmergencyEndpoint", "tags": [ "Dynamic Emergency Endpoints" ], "parameters": [ { "name": "id", "in": "path", "description": "Dynamic Emergency Endpoint id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/DynamicEmergencyEndpointResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/enum/{endpoint}": { "get": { "tags": [ "Enum" ], "summary": "Get Enum", "operationId": "GetEnumEndpoint", "parameters": [ { "required": true, "schema": { "title": "Endpoint", "type": "string" }, "name": "endpoint", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/error": { "get": { "tags": [ "Error" ], "summary": "List Error Codes", "description": "List all error codes", "operationId": "ListErrorCodes", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response List Error Codes Public Error Get", "type": "string" } } } } }, "x-latency-category": "responsive" } }, "/external_connections": { "get": { "description": "This endpoint returns a list of your External Connections inside the 'data' attribute of the response. External Connections are used by Telnyx customers to seamless configure SIP trunking integrations with Telnyx Partners, through External Voice Integrations in Mission Control Portal.", "summary": "List all External Connections", "operationId": "ListExternalConnections", "tags": [ "External Connections" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterConnectionName" }, { "$ref": "#/components/parameters/FilterExternalSipConnection" }, { "$ref": "#/components/parameters/FilterId" }, { "$ref": "#/components/parameters/FilterCreatedAt" }, { "$ref": "#/components/parameters/FilterPhoneNumber" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllExternalConnectionResponse" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates a new External Connection based on the parameters sent in the request. The external_sip_connection and outbound voice profile id are required. Once created, you can assign phone numbers to your application using the `/phone_numbers` endpoint.", "summary": "Creates an External Connection", "operationId": "CreateExternalConnection", "tags": [ "External Connections" ], "x-endpoint-cost": "medium", "parameters": [], "requestBody": { "description": "Parameters that can be set when creating a External Connection", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExternalConnectionRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/ExternalConnectionResponse" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/external_connections/log_messages": { "get": { "description": "Retrieve a list of log messages for all external connections associated with your account.", "summary": "List all log messages", "operationId": "ListExternalConnectionLogMessages", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterExternalConnectionId" }, { "$ref": "#/components/parameters/FilterPhoneNumberLogMessageContains" }, { "$ref": "#/components/parameters/FilterPhoneNumberLogMessageEq" } ], "responses": { "200": { "$ref": "#/components/responses/ListLogMessagesResponse" }, "401": { "description": "Unauthorized" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/external_connections/log_messages/{id}": { "delete": { "description": "Dismiss a log message for an external connection associated with your account.", "summary": "Dismiss a log message", "operationId": "DeleteExternalConnectionLogMessage", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Dismiss request was successful", "properties": { "success": { "type": "boolean", "description": "Describes wether or not the operation was successful" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "get": { "description": "Retrieve a log message for an external connection associated with your account.", "summary": "Retrieve a log message", "operationId": "GetExternalConnectionLogMessage", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/GetLogMessageResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}": { "delete": { "description": "Permanently deletes an External Connection. Deletion may be prevented if the application is in use by phone numbers, is active, or if it is an Operator Connect connection. To remove an Operator Connect integration please contact Telnyx support.", "summary": "Deletes an External Connection", "operationId": "DeleteExternalConnection", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/ExternalConnectionResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "get": { "description": "Return the details of an existing External Connection inside the 'data' attribute of the response.", "summary": "Retrieve an External Connection", "operationId": "GetExternalConnection", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/ExternalConnectionResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "patch": { "description": "Updates settings of an existing External Connection based on the parameters of the request.", "summary": "Update an External Connection", "operationId": "UpdateExternalConnection", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "description": "Parameters to be updated for the External Connection", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExternalConnectionRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ExternalConnectionResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/civic_addresses": { "get": { "description": "Returns the civic addresses and locations from Microsoft Teams.", "summary": "List all civic addresses and locations", "operationId": "ListCivicAddresses", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllCivicAddressesResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Unexpected Error" }, "502": { "description": "Bad Gateway" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/civic_addresses/{address_id}": { "get": { "description": "Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response.", "summary": "Retrieve a Civic Address", "operationId": "GetExternalConnectionCivicAddress", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/address_id" } ], "responses": { "200": { "$ref": "#/components/responses/GetCivicAddressResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "500": { "description": "Unexpected Error" }, "502": { "description": "Bad Gateway" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/phone_numbers": { "get": { "description": "Returns a list of all active phone numbers associated with the given external connection.", "summary": "List all phone numbers", "operationId": "ListExternalConnectionPhoneNumbers", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterPhoneNumberEq" }, { "$ref": "#/components/parameters/FilterPhoneNumberContains" }, { "$ref": "#/components/parameters/FilterPhoneNumber" }, { "$ref": "#/components/parameters/FilterCivicAddressId" }, { "$ref": "#/components/parameters/FilterLocationId" } ], "responses": { "200": { "$ref": "#/components/responses/ListExternalConnectionPhoneNumbersResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/phone_numbers/{phone_number_id}": { "get": { "description": "Return the details of a phone number associated with the given external connection.", "summary": "Retrieve a phone number", "operationId": "GetExternalConnectionPhoneNumber", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/phone_number_id" } ], "responses": { "200": { "$ref": "#/components/responses/GetExternalConnectionPhoneNumberResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "x-latency-category": "responsive" }, "patch": { "description": "Asynchronously update settings of the phone number associated with the given external connection.", "summary": "Update a phone number", "operationId": "UpdateExternalConnectionPhoneNumber", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/phone_number_id" } ], "requestBody": { "description": "Values that can be set when updating a phone number", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExternalConnectionPhoneNumberRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/GetExternalConnectionPhoneNumberResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/releases": { "get": { "description": "Returns a list of your Releases for the given external connection. These are automatically created when you change the `connection_id` of a phone number that is currently on Microsoft Teams.", "summary": "List all Releases", "operationId": "ListExternalConnectionReleases", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterReleaseStatus" }, { "$ref": "#/components/parameters/FilterCivicAddressId" }, { "$ref": "#/components/parameters/FilterLocationId" }, { "$ref": "#/components/parameters/FilterPhoneNumberEq" }, { "$ref": "#/components/parameters/FilterPhoneNumberContains" } ], "responses": { "200": { "$ref": "#/components/responses/ListReleasesResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/releases/{release_id}": { "get": { "description": "Return the details of a Release request and its phone numbers.", "summary": "Retrieve a Release request", "operationId": "GetExternalConnectionRelease", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/release_id" } ], "responses": { "200": { "$ref": "#/components/responses/GetReleaseResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/uploads": { "get": { "description": "Returns a list of your Upload requests for the given external connection.", "summary": "List all Upload requests", "operationId": "ListExternalConnectionUploads", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterUploadStatus" }, { "$ref": "#/components/parameters/FilterCivicAddressId" }, { "$ref": "#/components/parameters/FilterLocationId" }, { "$ref": "#/components/parameters/FilterPhoneNumberEq" }, { "$ref": "#/components/parameters/FilterPhoneNumberContains" } ], "responses": { "200": { "$ref": "#/components/responses/ListUploadsResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates a new Upload request to Microsoft teams with the included phone numbers. Only one of civic_address_id or location_id must be provided, not both. The maximum allowed phone numbers for the numbers_ids array is 1000.", "summary": "Creates an Upload request", "operationId": "CreateExternalConnectionUpload", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "description": "Parameters that can be set when creating an Upload request.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExternalConnectionUploadRequest" } } } }, "responses": { "202": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Create Upload request Response", "properties": { "success": { "type": "boolean", "description": "Describes wether or not the operation was successful" }, "ticket_id": { "type": "string", "format": "uuid", "description": "Ticket id of the upload request" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "413": { "description": "Payload too large. The maximum allowed phone numbers for the numbers_ids array is 1000." }, "422": { "description": "Unprocessable Entity" }, "504": { "description": "Gateway Timeout" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/uploads/refresh": { "post": { "description": "Forces a recheck of the status of all pending Upload requests for the given external connection in the background.", "summary": "Refresh the status of all Upload requests", "operationId": "RefreshExternalConnectionUploads", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Create Upload request Response", "properties": { "success": { "type": "boolean", "description": "Describes wether or not the operation was successful" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "409": { "description": "Status refresh is still in progress, please wait before calling again" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/uploads/status": { "get": { "description": "Returns the count of all pending upload requests for the given external connection.", "summary": "Get the count of pending upload requests", "operationId": "GetExternalConnectionUploadsStatus", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/GetUploadsStatusResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/uploads/{ticket_id}": { "get": { "description": "Return the details of an Upload request and its phone numbers.", "summary": "Retrieve an Upload request", "operationId": "GetExternalConnectionUpload", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/ticket_id" } ], "responses": { "200": { "$ref": "#/components/responses/GetUploadResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "x-latency-category": "responsive" } }, "/external_connections/{id}/uploads/{ticket_id}/retry": { "post": { "description": "If there were any errors during the upload process, this endpoint will retry the upload request. In some cases this will reattempt the existing upload request, in other cases it may create a new upload request. Please check the ticket_id in the response to determine if a new upload request was created.", "summary": "Retry an Upload request", "operationId": "RetryUpload", "tags": [ "External Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/ticket_id" } ], "responses": { "202": { "$ref": "#/components/responses/GetUploadResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" }, "409": { "description": "Order is still in progress, please wait before retrying" }, "422": { "description": "Unprocessable Entity" } }, "x-latency-category": "responsive" } }, "/fax_applications": { "get": { "description": "This endpoint returns a list of your Fax Applications inside the 'data' attribute of the response. You can adjust which applications are listed by using filters. Fax Applications are used to configure how you send and receive faxes using the Programmable Fax API with Telnyx.", "summary": "List all Fax Applications", "operationId": "ListFaxApplications", "tags": [ "Programmable Fax Applications" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterApplicationName" }, { "$ref": "#/components/parameters/FilterOutboundVoiceProfileId" }, { "$ref": "#/components/parameters/SortConnection" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllFaxApplicationsResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates a new Fax Application based on the parameters sent in the request. The application name and webhook URL are required. Once created, you can assign phone numbers to your application using the `/phone_numbers` endpoint.", "summary": "Creates a Fax Application", "operationId": "CreateFaxApplication", "tags": [ "Programmable Fax Applications" ], "x-endpoint-cost": "medium", "parameters": [], "requestBody": { "description": "Parameters that can be set when creating a Fax Application", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFaxApplicationRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/FaxApplicationResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/fax_applications/{id}": { "delete": { "description": "Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers.", "summary": "Deletes a Fax Application", "operationId": "DeleteFaxApplication", "tags": [ "Programmable Fax Applications" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/FaxApplicationResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Return the details of an existing Fax Application inside the 'data' attribute of the response.", "summary": "Retrieve a Fax Application", "operationId": "GetFaxApplication", "tags": [ "Programmable Fax Applications" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/FaxApplicationResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Updates settings of an existing Fax Application based on the parameters of the request.", "summary": "Update a Fax Application", "operationId": "UpdateFaxApplication", "tags": [ "Programmable Fax Applications" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "description": "Parameters to be updated for the Fax Application", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFaxApplicationRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/FaxApplicationResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/faxes": { "get": { "summary": "View a list of faxes", "description": "", "operationId": "ListFaxes", "x-latency-category": "background", "tags": [ "Programmable Fax Commands" ], "parameters": [ { "name": "filter[created_at][gte]", "in": "query", "description": "ISO 8601 date time for filtering faxes created after or on that date", "schema": { "type": "string", "format": "date-time", "example": "2020-02-02T22:25:27.521992Z" } }, { "name": "filter[created_at][gt]", "in": "query", "description": "ISO 8601 date time for filtering faxes created after that date", "schema": { "type": "string", "format": "date-time", "example": "2020-02-02T22:25:27.521992Z" } }, { "name": "filter[created_at][lte]", "in": "query", "description": "ISO 8601 formatted date time for filtering faxes created on or before that date", "schema": { "type": "string", "format": "date-time", "example": "2020-02-02T22:25:27.521992Z" } }, { "name": "filter[created_at][lt]", "in": "query", "description": "ISO 8601 formatted date time for filtering faxes created before that date", "schema": { "type": "string", "format": "date-time", "example": "2020-02-02T22:25:27.521992Z" } }, { "name": "filter[direction][eq]", "in": "query", "description": "The direction, inbound or outbound, for filtering faxes sent from this account", "schema": { "type": "string", "example": "inbound" } }, { "name": "filter[from][eq]", "in": "query", "description": "The phone number, in E.164 format for filtering faxes sent from this number", "schema": { "type": "string", "example": "+13127367276" } }, { "name": "filter[to][eq]", "in": "query", "description": "The phone number, in E.164 format for filtering faxes sent to this number", "schema": { "type": "string", "example": "+13127367276" } }, { "name": "page[size]", "in": "query", "description": "Number of fax resourcxes for the single page returned", "schema": { "type": "integer", "example": 2 } }, { "name": "page[number]", "in": "query", "description": "Number of the page to be retrieved", "schema": { "type": "integer", "example": 2 } } ], "responses": { "200": { "$ref": "#/components/responses/ListFaxesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } }, "post": { "summary": "Send a fax", "operationId": "SendFax", "description": "Send a fax. Files have size limits and page count limit validations. If a file is bigger than 50MB or has more than 350 pages it will fail with `file_size_limit_exceeded` and `page_count_limit_exceeded` respectively. \n\n**Expected Webhooks:**\n\n- `fax.queued`\n- `fax.media.processed`\n- `fax.sending.started`\n- `fax.delivered`\n- `fax.failed`\n", "tags": [ "Programmable Fax Commands" ], "requestBody": { "description": "Send fax request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendFaxRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/SendFaxMultipartRequest" } } } }, "responses": { "202": { "$ref": "#/components/responses/SendFaxResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "fax.queued": { "{$response.body#/data/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxQueued" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "fax.media.processed": { "{$response.body#/data/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxMediaProcessed" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "fax.sending.started": { "{$response.body#/data/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxSendingStarted" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "fax.delivered": { "{$response.body#/data/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxDelivered" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "fax.failed": { "{$response.body#/data/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaxFailed" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "responsive" } }, "/faxes/{id}": { "delete": { "summary": "Delete a fax", "operationId": "DeleteFax", "tags": [ "Programmable Fax Commands" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of a fax.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "View a fax", "operationId": "ViewFax", "tags": [ "Programmable Fax Commands" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of a fax.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/GetFaxResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/faxes/{id}/actions/cancel": { "post": { "summary": "Cancel a fax", "description": "Cancel the outbound fax that is in one of the following states: `queued`, `media.processed`, `originated` or `sending` ", "operationId": "CancelFax", "tags": [ "Programmable Fax Commands" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of a fax.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "202": { "$ref": "#/components/responses/CancelFaxResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/faxes/{id}/actions/refresh": { "post": { "summary": "Refresh a fax", "description": "Refreshes the inbound fax's media_url when it has expired", "operationId": "RefreshFax", "tags": [ "Programmable Fax Commands" ], "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of a fax.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/RefreshFaxResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/fqdn_connections": { "get": { "description": "Returns a list of your FQDN connections.", "summary": "List FQDN connections", "operationId": "ListFqdnConnections", "tags": [ "FQDN Connections" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterConnectionName" }, { "$ref": "#/components/parameters/FilterFqdn" }, { "$ref": "#/components/parameters/FilterOutboundVoiceProfileId" }, { "$ref": "#/components/parameters/SortConnection" } ], "responses": { "200": { "$ref": "#/components/responses/ListFqdnConnectionsResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates a FQDN connection.", "summary": "Create an FQDN connection", "operationId": "CreateFqdnConnection", "tags": [ "FQDN Connections" ], "x-endpoint-cost": "medium", "parameters": [], "requestBody": { "description": "Parameters that can be defined during FQDN connection creation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFqdnConnectionRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/FqdnConnectionResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/fqdn_connections/{id}": { "delete": { "description": "Deletes an FQDN connection.", "summary": "Delete an FQDN connection", "operationId": "DeleteFqdnConnection", "tags": [ "FQDN Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/FqdnConnectionResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Retrieves the details of an existing FQDN connection.", "summary": "Retrieve an FQDN connection", "operationId": "RetrieveFqdnConnection", "tags": [ "FQDN Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/FqdnConnectionResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Updates settings of an existing FQDN connection.", "summary": "Update an FQDN connection", "operationId": "UpdateFqdnConnection", "tags": [ "FQDN Connections" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "description": "Parameters that can be updated in a FQDN connection", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFqdnConnectionRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/FqdnConnectionResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/fqdns": { "get": { "summary": "List FQDNs", "description": "Get all FQDNs belonging to the user that match the given filters.", "operationId": "ListFqdns", "tags": [ "FQDNs" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[connection_id]", "description": "ID of the FQDN connection to which the FQDN belongs.", "in": "query", "schema": { "type": "string" } }, { "name": "filter[fqdn]", "description": "FQDN represented by the resource.", "in": "query", "schema": { "type": "string", "example": "example.com" } }, { "name": "filter[port]", "description": "Port to use when connecting to the FQDN.", "in": "query", "schema": { "type": "integer", "example": 5060 } }, { "name": "filter[dns_record_type]", "description": "DNS record type used by the FQDN.", "in": "query", "schema": { "type": "string", "example": "a" } } ], "responses": { "200": { "$ref": "#/components/responses/ListFqdnsResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Create a new FQDN object.", "summary": "Create an FQDN", "operationId": "CreateFqdn", "tags": [ "FQDNs" ], "x-endpoint-cost": "medium", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFqdnRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/FqdnResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/fqdns/{id}": { "delete": { "description": "Delete an FQDN.", "summary": "Delete an FQDN", "operationId": "DeleteFqdn", "tags": [ "FQDNs" ], "parameters": [ { "$ref": "#/components/parameters/FqdnId" } ], "responses": { "200": { "$ref": "#/components/responses/FqdnResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Return the details regarding a specific FQDN.", "summary": "Retrieve an FQDN", "operationId": "RetrieveFqdn", "tags": [ "FQDNs" ], "parameters": [ { "$ref": "#/components/parameters/FqdnId" } ], "responses": { "200": { "$ref": "#/components/responses/FqdnResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Update the details of a specific FQDN.", "summary": "Update an FQDN", "operationId": "UpdateFqdn", "tags": [ "FQDNs" ], "parameters": [ { "$ref": "#/components/parameters/FqdnId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFqdnRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/FqdnResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/global_ip_allowed_ports": { "get": { "summary": "List all Global IP Allowed Ports", "description": "List all Global IP Allowed Ports", "operationId": "ListGlobalIpAllowedPorts", "tags": [ "Global IPs" ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpAllowedPortListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/global_ip_assignment_health": { "description": "Global IP Assignment Health Check Metrics over time", "get": { "operationId": "GetGlobalIpAssignmentHealth", "tags": [ "Global IPs" ], "parameters": [ { "name": "filter[global_ip_id][in]", "in": "query", "description": "Filter by Global IP ID(s) separated by commas", "required": false, "schema": { "type": "string" } }, { "name": "filter[global_ip_assignment_id][in]", "in": "query", "description": "Filter by Global IP Assignment ID(s) separated by commas", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/TimestampGreater" }, { "$ref": "#/components/parameters/TimestampLess" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpHealthResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "summary": "Global IP Assignment Health Check Metrics" }, "/global_ip_assignments": { "get": { "summary": "List all Global IP assignments", "description": "List all Global IP assignments.", "operationId": "ListGlobalIpAssignments", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpAssignmentListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a Global IP assignment", "description": "Create a Global IP assignment.", "operationId": "CreateGlobalIpAssignment", "tags": [ "Global IPs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalIpAssignment" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/GlobalIpAssignmentResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/global_ip_assignments/{id}": { "delete": { "summary": "Delete a Global IP assignment", "description": "Delete a Global IP assignment.", "operationId": "DeleteGlobalIpAssignment", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpAssignmentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a Global IP", "description": "Retrieve a Global IP assignment.", "operationId": "GetGlobalIpAssignment", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpAssignmentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a Global IP assignment", "description": "Update a Global IP assignment.", "operationId": "UpdateGlobalIpAssignment", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalIpAssignmentUpdate" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/GlobalIpAssignmentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/global_ip_assignments_usage": { "description": "Global IP Assignment Usage Metrics over time", "get": { "operationId": "GetGlobalIpAssignmentUsage", "tags": [ "Global IPs" ], "parameters": [ { "name": "filter[global_ip_assignment_id][in]", "in": "query", "description": "Filter by Global IP Assignment ID(s) separated by commas", "required": false, "schema": { "type": "string" } }, { "name": "filter[global_ip_id][in]", "in": "query", "description": "Filter by Global IP ID(s), separated by commas", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/TimestampGreater" }, { "$ref": "#/components/parameters/TimestampLess" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpAssignmentUsageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "summary": "Global IP Assignment Usage Metrics" }, "/global_ip_health_check_types": { "get": { "summary": "List all Global IP Health check types", "description": "List all Global IP Health check types.", "operationId": "ListGlobalIpHealthCheckTypes", "tags": [ "Global IPs" ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpHealthCheckTypesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/global_ip_health_checks": { "get": { "summary": "List all Global IP health checks", "description": "List all Global IP health checks.", "operationId": "ListGlobalIpHealthChecks", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpHealthCheckListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a Global IP health check", "description": "Create a Global IP health check.", "operationId": "CreateGlobalIpHealthCheck", "tags": [ "Global IPs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalIPHealthCheck" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/GlobalIpHealthCheckResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/global_ip_health_checks/{id}": { "delete": { "summary": "Delete a Global IP health check", "description": "Delete a Global IP health check.", "operationId": "DeleteGlobalIpHealthCheck", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpHealthCheckResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a Global IP health check", "description": "Retrieve a Global IP health check.", "operationId": "GetGlobalIpHealthCheck", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpHealthCheckResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/global_ip_latency": { "description": "Global IP Latency Metrics over time", "get": { "operationId": "GetGlobalIpLatency", "tags": [ "Global IPs" ], "parameters": [ { "name": "filter[global_ip_id][in]", "in": "query", "description": "Filter by Global IP ID(s) separated by commas", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/TimestampGreater" }, { "$ref": "#/components/parameters/TimestampLess" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpLatencyResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "summary": "Global IP Latency Metrics" }, "/global_ip_protocols": { "get": { "summary": "List all Global IP Protocols", "description": "List all Global IP Protocols", "operationId": "ListGlobalIpProtocols", "tags": [ "Global IPs" ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpProtocolListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/global_ip_usage": { "description": "Global IP Usage Metrics over time", "get": { "operationId": "GetGlobalIpUsage", "tags": [ "Global IPs" ], "parameters": [ { "name": "filter[global_ip_id][in]", "in": "query", "description": "Filter by Global IP ID(s) separated by commas", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/TimestampGreater" }, { "$ref": "#/components/parameters/TimestampLess" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpUsageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "summary": "Global IP Usage Metrics" }, "/global_ips": { "get": { "summary": "List all Global IPs", "description": "List all Global IPs.", "operationId": "ListGlobalIps", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a Global IP", "description": "Create a Global IP.", "operationId": "CreateGlobalIp", "tags": [ "Global IPs" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalIP" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/GlobalIpResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/global_ips/{id}": { "delete": { "summary": "Delete a Global IP", "description": "Delete a Global IP.", "operationId": "DeleteGlobalIp", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a Global IP", "description": "Retrieve a Global IP.", "operationId": "GetGlobalIp", "tags": [ "Global IPs" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GlobalIpResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/inventory_coverage": { "get": { "summary": "Create an inventory coverage request", "description": "Creates an inventory coverage request. If locality, npa or national_destination_code is used in groupBy, and no region or locality filters are used, the whole paginated set is returned.", "operationId": "CreateInventoryCoverage", "tags": [ "Inventory Level" ], "parameters": [ { "in": "query", "name": "filter[npa]", "example": 318, "schema": { "type": "integer", "description": "Filter by npa" } }, { "in": "query", "name": "filter[nxx]", "example": 202, "schema": { "type": "integer", "description": "Filter by nxx" } }, { "in": "query", "name": "filter[administrative_area]", "example": "LA", "schema": { "type": "string", "description": "Filter by administrative area" } }, { "in": "query", "name": "filter[phone_number_type]", "example": "local", "schema": { "type": "string", "description": "Filter by phone number type", "enum": [ "local", "toll_free", "national", "mobile", "landline", "shared_cost" ] } }, { "in": "query", "name": "filter[country_code]", "example": "US", "schema": { "type": "string", "description": "Filter by country. Defaults to US", "enum": [ "US", "CA", "GB" ] } }, { "in": "query", "name": "filter[count]", "example": "true", "schema": { "type": "boolean", "description": "Include count in the result" } }, { "name": "filter[features]", "in": "query", "description": "Filter if the phone number should be used for voice, fax, mms, sms, emergency. Returns features in the response when used.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "sms", "mms", "voice", "fax", "emergency" ] }, "example": "voice,sms" } }, { "in": "query", "name": "filter[groupBy]", "example": "nxx", "schema": { "type": "string", "description": "Filter to group results", "enum": [ "locality", "npa", "national_destination_code" ] }, "required": true } ], "responses": { "200": { "$ref": "#/components/responses/InventoryCoverageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/ip_connections": { "get": { "description": "Returns a list of your IP connections.", "summary": "List Ip connections", "operationId": "ListIpConnections", "tags": [ "IP Connections" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterConnectionName" }, { "$ref": "#/components/parameters/FilterInnerOutboundVoiceProfileId" }, { "$ref": "#/components/parameters/SortConnection" } ], "responses": { "200": { "$ref": "#/components/responses/ListIpConnectionsResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates an IP connection.", "summary": "Create an Ip connection", "operationId": "CreateIpConnection", "tags": [ "IP Connections" ], "x-endpoint-cost": "medium", "parameters": [], "requestBody": { "description": "Parameters that can be defined during IP connection creation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIpConnectionRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/IpConnectionResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/ip_connections/{id}": { "delete": { "description": "Deletes an existing IP connection.", "summary": "Delete an Ip connection", "operationId": "DeleteIpConnection", "tags": [ "IP Connections" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the type of resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/IpConnectionResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Retrieves the details of an existing ip connection.", "summary": "Retrieve an Ip connection", "operationId": "RetrieveIpConnection", "tags": [ "IP Connections" ], "parameters": [ { "name": "id", "in": "path", "description": "IP Connection ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/IpConnectionResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Updates settings of an existing IP connection.", "summary": "Update an Ip connection", "operationId": "UpdateIpConnection", "tags": [ "IP Connections" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the type of resource.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters that can be updated in a IP connection", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIpConnectionRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/IpConnectionResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/ips": { "get": { "summary": "List Ips", "description": "Get all IPs belonging to the user that match the given filters.", "operationId": "ListIps", "tags": [ "IPs" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[connection_id]", "description": "ID of the IP Connection to which this IP should be attached.", "in": "query", "schema": { "type": "string" } }, { "name": "filter[ip_address]", "description": "IP adddress represented by this resource.", "in": "query", "schema": { "type": "string", "example": "192.168.0.0" } }, { "name": "filter[port]", "description": "Port to use when connecting to this IP.", "in": "query", "schema": { "type": "integer", "example": 5060 } } ], "responses": { "200": { "$ref": "#/components/responses/ListIpsResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Create a new IP object.", "summary": "Create an Ip", "operationId": "CreateIp", "tags": [ "IPs" ], "x-endpoint-cost": "medium", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIpRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/IpResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/ips/{id}": { "delete": { "description": "Delete an IP.", "summary": "Delete an Ip", "operationId": "DeleteIp", "tags": [ "IPs" ], "parameters": [ { "$ref": "#/components/parameters/IpId" } ], "responses": { "200": { "$ref": "#/components/responses/IpResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Return the details regarding a specific IP.", "summary": "Retrieve an Ip", "operationId": "RetrieveIp", "tags": [ "IPs" ], "parameters": [ { "$ref": "#/components/parameters/IpId" } ], "responses": { "200": { "$ref": "#/components/responses/IpResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Update the details of a specific IP.", "summary": "Update an Ip", "operationId": "UpdateIp", "tags": [ "IPs" ], "parameters": [ { "$ref": "#/components/parameters/IpId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIpRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/IpResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/ledger_billing_group_reports": { "post": { "summary": "Create a ledger billing group report", "operationId": "CreateBillingGroupReport", "tags": [ "Reports" ], "requestBody": { "description": "New ledger billing group report parameters", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLedgerBillingGroupReport" } } } }, "responses": { "200": { "$ref": "#/components/responses/CreateLedgerBillingGroupReportResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/ledger_billing_group_reports/{id}": { "get": { "summary": "Get a ledger billing group report", "operationId": "GetBillingGroupReport", "tags": [ "Reports" ], "parameters": [ { "$ref": "#/components/parameters/LedgerBillingGroupReportId" } ], "responses": { "200": { "$ref": "#/components/responses/RetrieveLedgerBillingGroupReportResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/managed_accounts": { "get": { "summary": "Lists accounts managed by the current user.", "description": "Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.", "operationId": "ListManagedAccounts", "tags": [ "Managed Accounts" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterEmailContains" }, { "$ref": "#/components/parameters/FilterEmailEq" }, { "$ref": "#/components/parameters/FilterOrganizationEmailContains" }, { "$ref": "#/components/parameters/FilterOrganizationEmailEq" }, { "$ref": "#/components/parameters/Sort" }, { "$ref": "#/components/parameters/IncludeCancelledAccounts" } ], "responses": { "200": { "$ref": "#/components/responses/ListManagedAccountsResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a new managed account.", "description": "Create a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account.", "operationId": "CreateManagedAccount", "tags": [ "Managed Accounts" ], "x-endpoint-cost": "medium", "parameters": [], "requestBody": { "description": "Parameters that define the managed account to be created", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateManagedAccountRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ManagedAccountResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "$ref": "#/components/responses/UnprocessableManagedAccountEntity" } }, "x-latency-category": "responsive" } }, "/managed_accounts/allocatable_global_outbound_channels": { "get": { "summary": "Display information about allocatable global outbound channels for the current user.", "description": "Display information about allocatable global outbound channels for the current user. Only usable by account managers.", "operationId": "ListAllocatableGlobalOutboundChannels", "tags": [ "Managed Accounts" ], "x-endpoint-cost": "medium", "responses": { "200": { "$ref": "#/components/responses/ListManagedAccountsAllocatableGlobalOutboundChannelsResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ForbiddenResponse" } }, "x-latency-category": "responsive" } }, "/managed_accounts/{id}": { "get": { "description": "Retrieves the details of a single managed account.", "summary": "Retrieve a managed account", "operationId": "RetrieveManagedAccount", "tags": [ "Managed Accounts" ], "parameters": [ { "name": "id", "in": "path", "description": "Managed Account User ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ManagedAccountResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "patch": { "description": "Update a single managed account.", "summary": "Update a managed account", "operationId": "UpdateManagedAccount", "tags": [ "Managed Accounts" ], "parameters": [ { "name": "id", "in": "path", "description": "Managed Account User ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters that define the updates to the managed account", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManagedAccountRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ManagedAccountResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" }, "422": { "$ref": "#/components/responses/UnprocessableManagedAccountEntity" } }, "x-latency-category": "responsive" } }, "/managed_accounts/{id}/actions/disable": { "post": { "summary": "Disables a managed account", "description": "Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be affected. The managed account and its sub-users will no longer be able to log in via the mission control portal.", "operationId": "DisableManagedAccount", "tags": [ "Managed Accounts" ], "parameters": [ { "name": "id", "in": "path", "description": "Managed Account User ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ManagedAccountResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" }, "422": { "$ref": "#/components/responses/UnprocessableManagedAccountEntity" } }, "x-latency-category": "responsive" } }, "/managed_accounts/{id}/actions/enable": { "post": { "summary": "Enables a managed account", "description": "Enables a managed account and its sub-users to use Telnyx services.", "operationId": "EnableManagedAccount", "tags": [ "Managed Accounts" ], "parameters": [ { "name": "id", "in": "path", "description": "Managed Account User ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ManagedAccountResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" }, "422": { "$ref": "#/components/responses/UnprocessableManagedAccountEntity" } }, "x-latency-category": "responsive" } }, "/managed_accounts/{id}/update_global_channel_limit": { "patch": { "summary": "Update the amount of allocatable global outbound channels allocated to a specific managed account.", "description": "Update the amount of allocatable global outbound channels allocated to a specific managed account.", "operationId": "UpdateManagedAccountGlobalChannelLimit", "tags": [ "Managed Accounts" ], "parameters": [ { "name": "id", "in": "path", "description": "Managed Account User ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters that define the changes to the global outbounds channels for the managed account", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateManagedAccountGlobalChannelLimitRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/UpdateManagedAccountGlobalChannelLimitResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Resource not found" }, "422": { "$ref": "#/components/responses/UnprocessableManagedAccountEntity" } }, "x-latency-category": "responsive" } }, "/media": { "get": { "summary": "List uploaded media", "description": "Returns a list of stored media files.", "operationId": "ListMediaStorage", "tags": [ "Media Storage API" ], "parameters": [ { "name": "filter[content_type][]", "in": "query", "description": "Filters files by given content types", "schema": { "type": "string", "example": "application_xml" } } ], "responses": { "200": { "$ref": "#/components/responses/ListMediaResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" }, "post": { "summary": "Upload media", "description": "Upload media file to Telnyx so it can be used with other Telnyx services", "operationId": "CreateMediaStorage", "tags": [ "Media Storage API" ], "requestBody": { "description": "Upload media request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadMediaRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadMediaMultipartRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/MediaResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/media/{media_name}": { "delete": { "summary": "Deletes stored media", "description": "Deletes a stored media file.", "operationId": "DeleteMediaStorage", "tags": [ "Media Storage API" ], "parameters": [ { "$ref": "#/components/parameters/MediaName" } ], "responses": { "204": { "description": "The media was deleted successfully." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" }, "get": { "summary": "Retrieve stored media", "description": "Returns the information about a stored media file.", "operationId": "GetMediaStorage", "tags": [ "Media Storage API" ], "parameters": [ { "$ref": "#/components/parameters/MediaName" } ], "responses": { "200": { "$ref": "#/components/responses/MediaResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" }, "put": { "summary": "Update stored media", "description": "Updates a stored media file.", "operationId": "UpdateMediaStorage", "tags": [ "Media Storage API" ], "parameters": [ { "$ref": "#/components/parameters/MediaName" } ], "requestBody": { "description": "Update media request", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMediaRequest" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UpdateMediaMultipartRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MediaResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/media/{media_name}/download": { "get": { "summary": "Download stored media", "description": "Downloads a stored media file.", "operationId": "DownloadMedia", "tags": [ "Media Storage API" ], "parameters": [ { "$ref": "#/components/parameters/MediaName" } ], "responses": { "200": { "$ref": "#/components/responses/MediaDownloadResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "interactive" } }, "/messages": { "post": { "summary": "Send a message", "description": "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", "operationId": "SendMessage", "tags": [ "Messages" ], "requestBody": { "description": "Message payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "deliveryUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessageEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "responsive" } }, "/messages/group_mms": { "post": { "summary": "Send a group MMS message", "operationId": "CreateGroupMmsMessage", "tags": [ "Messages" ], "requestBody": { "description": "Message payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroupMMSMessageRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "deliveryUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessageEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "responsive" } }, "/messages/long_code": { "post": { "summary": "Send a long code message", "operationId": "CreateLongCodeMessage", "tags": [ "Messages" ], "requestBody": { "description": "Message payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLongCodeMessageRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "deliveryUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessageEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "responsive" } }, "/messages/number_pool": { "post": { "summary": "Send a message using number pool", "operationId": "CreateNumberPoolMessage", "tags": [ "Messages" ], "requestBody": { "description": "Message payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNumberPoolMessageRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "deliveryUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessageEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "responsive" } }, "/messages/short_code": { "post": { "summary": "Send a short code message", "operationId": "CreateShortCodeMessage", "tags": [ "Messages" ], "requestBody": { "description": "Message payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShortCodeMessageRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "deliveryUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessageEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "responsive" } }, "/messages/{id}": { "get": { "summary": "Retrieve a message", "description": "Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation. If you require messages older than this, please generate an [MDR report.](https://developers.telnyx.com/docs/api/v1/reports/MDR-Reports)", "operationId": "GetMessage", "tags": [ "Messages" ], "parameters": [ { "name": "id", "in": "path", "description": "The id of the message", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/MessageResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_hosted_number_orders": { "get": { "summary": "List messaging hosted number orders", "operationId": "ListMessagingHostedNumberOrders", "tags": [ "Messaging Hosted Number" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListMessagingHostedNumberOrdersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a messaging hosted number order", "operationId": "CreateMessagingHostedNumberOrder", "tags": [ "Messaging Hosted Number" ], "requestBody": { "description": "Message payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessagingHostedNumberOrderRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MessagingHostedNumberOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_hosted_number_orders/{id}": { "get": { "summary": "Retrieve a messaging hosted number order", "operationId": "GetMessagingHostedNumberOrder", "tags": [ "Messaging Hosted Number" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the type of resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessagingHostedNumberOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_hosted_number_orders/{id}/actions/file_upload": { "post": { "summary": "Upload file required for a messaging hosted number order", "operationId": "UploadMessagingHostedNumberOrderFile", "tags": [ "Messaging Hosted Number" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the type of resource.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Message payload", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UploadFileMessagingHostedNumberOrderRequest" }, "encoding": { "loa": { "contentType": "application/pdf" }, "bill": { "contentType": "application/pdf" } } } } }, "responses": { "200": { "$ref": "#/components/responses/MessagingHostedNumberOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_hosted_numbers/{id}": { "delete": { "summary": "Delete a messaging hosted number", "operationId": "DeleteMessagingHostedNumber", "tags": [ "Messaging Hosted Number" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the type of resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/MessagingHostedNumberResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_profile_metrics": { "get": { "summary": "List messaging profile metrics", "operationId": "ListProfileMetrics", "tags": [ "Messaging Profiles" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/MessagingProfileMetric" }, { "$ref": "#/components/parameters/MessagingProfileMetricTimeFrame" } ], "responses": { "200": { "$ref": "#/components/responses/ListMessagingProfileMetrics" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_profiles": { "get": { "summary": "List messaging profiles", "operationId": "ListMessagingProfiles", "tags": [ "Messaging Profiles" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[name]", "in": "query", "description": "Filter by name", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ListMessagingProfilesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a messaging profile", "operationId": "CreateMessagingProfile", "tags": [ "Messaging Profiles" ], "x-endpoint-cost": "medium", "requestBody": { "description": "New Messaging Profile object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessagingProfileRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MessagingProfileResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "inboundMessage": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboundMessageEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "deliveryUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessageEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } }, "replacedLinkClick": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplacedLinkClickEvent" } } } }, "responses": { "200": { "description": "The server must return an HTTP 200, otherwise we will reattempt delivery at the failover webhook URL." } } } } } }, "x-latency-category": "responsive" } }, "/messaging_profiles/{id}": { "delete": { "summary": "Delete a messaging profile", "operationId": "DeleteMessagingProfile", "tags": [ "Messaging Profiles" ], "parameters": [ { "$ref": "#/components/parameters/MessagingProfileId" } ], "responses": { "200": { "$ref": "#/components/responses/MessagingProfileResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a messaging profile", "operationId": "RetrieveMessagingProfile", "tags": [ "Messaging Profiles" ], "parameters": [ { "$ref": "#/components/parameters/MessagingProfileId" } ], "responses": { "200": { "$ref": "#/components/responses/MessagingProfileResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a messaging profile", "operationId": "UpdateMessagingProfile", "tags": [ "Messaging Profiles" ], "parameters": [ { "$ref": "#/components/parameters/MessagingProfileId" } ], "requestBody": { "description": "New Messaging Profile object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMessagingProfileRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/MessagingProfileResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_profiles/{id}/metrics": { "get": { "summary": "Retrieve messaging profile metrics", "operationId": "GetMessagingProfileMetrics", "tags": [ "Messaging Profiles" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/MessagingProfileId" }, { "$ref": "#/components/parameters/MessagingProfileMetricTimeFrame" } ], "responses": { "200": { "$ref": "#/components/responses/RetrieveMessagingProfileMetrics" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_profiles/{id}/phone_numbers": { "get": { "summary": "List phone numbers associated with a messaging profile", "operationId": "ListProfilePhoneNumbers", "tags": [ "Messaging Profiles" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/MessagingProfileId" } ], "responses": { "200": { "$ref": "#/components/responses/ListMessagingProfilePhoneNumbersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_profiles/{id}/short_codes": { "get": { "summary": "List short codes associated with a messaging profile", "operationId": "ListProfileShortCodes", "tags": [ "Messaging Profiles" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/MessagingProfileId" } ], "responses": { "200": { "$ref": "#/components/responses/ListMessagingProfileShortCodesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_profiles/{profile_id}/autoresp_configs": { "get": { "tags": [ "Advanced OptIn/OptOut" ], "summary": "List Auto-Response Settings", "operationId": "GetAutorespConfigs", "parameters": [ { "required": true, "schema": { "title": "Profile Id", "type": "string", "format": "uuid" }, "name": "profile_id", "in": "path" }, { "required": false, "schema": { "title": "Country Code", "type": "string" }, "name": "country_code", "in": "query" }, { "required": false, "schema": { "title": "Created At[Gte]", "type": "string" }, "name": "created_at[gte]", "in": "query" }, { "required": false, "schema": { "title": "Created At[Lte]", "type": "string" }, "name": "created_at[lte]", "in": "query" }, { "required": false, "schema": { "title": "Updated At[Gte]", "type": "string" }, "name": "updated_at[gte]", "in": "query" }, { "required": false, "schema": { "title": "Updated At[Lte]", "type": "string" }, "name": "updated_at[lte]", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutorespConfigsResponseSchema" }, "example": { "data": [ { "op": "start", "keywords": [ "START", "BEGIN" ], "resp_text": "Thank you for subscribing US customer.", "country_code": "US", "id": "677ec1cb-949e-4aeb-a1c3-6d9ddffc1409", "created_at": "2023-03-21T23:37:45.858535+00:00", "updated_at": "2023-03-21T23:37:45.858535+00:00" }, { "op": "stop", "keywords": [ "END", "STOP" ], "resp_text": "You have unsubscribed.", "country_code": "US", "id": "54b7e19f-98a8-416f-81d1-a2782eade48b", "created_at": "2023-03-10T21:54:46.293380+00:00", "updated_at": "2023-03-10T21:54:46.293380+00:00" }, { "op": "start", "keywords": [ "START" ], "resp_text": "Thank you for subscribing.", "country_code": "*", "id": "cfe07be1-2369-433f-be00-eb176008e834", "created_at": "2023-03-14T14:46:21.097735+00:00", "updated_at": "2023-03-14T14:46:21.097735+00:00" } ], "meta": { "page_number": 1, "page_size": 5, "total_pages": 1, "total_results": 3 } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Advanced OptIn/OptOut" ], "summary": "Create Auto-Reponse Setting", "operationId": "CreateAutorespConfig", "parameters": [ { "required": true, "schema": { "title": "Profile Id", "type": "string" }, "name": "profile_id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoRespConfigCreateSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutorespConfigResponseSchema" }, "example": { "data": { "op": "start", "keywords": [ "START" ], "resp_text": "Hello there!", "country_code": "US", "id": "c2298f86-a4dc-4cac-b6b6-4a3d01c290fa", "created_at": "2023-03-22T00:06:49.068817+00:00", "updated_at": "2023-03-22T00:06:49.068817+00:00" } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}": { "delete": { "tags": [ "Advanced OptIn/OptOut" ], "summary": "Delete Auto-Response Setting", "operationId": "DeleteAutorespConfig", "parameters": [ { "required": true, "schema": { "title": "Profile Id", "type": "string", "format": "uuid" }, "name": "profile_id", "in": "path" }, { "required": true, "schema": { "title": "Autoresp Cfg Id", "type": "string", "format": "uuid" }, "name": "autoresp_cfg_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Advanced OptIn/OptOut" ], "summary": "Get Auto-Response Setting", "operationId": "GetAutorespConfig", "parameters": [ { "required": true, "schema": { "title": "Profile Id", "type": "string", "format": "uuid" }, "name": "profile_id", "in": "path" }, { "required": true, "schema": { "title": "Autoresp Cfg Id", "type": "string", "format": "uuid" }, "name": "autoresp_cfg_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutorespConfigResponseSchema" }, "example": { "data": { "op": "start", "keywords": [ "UNSTOP" ], "resp_text": "Hello there!", "country_code": "US", "id": "adc37adf-d110-4355-9e9a-262847e68e89", "created_at": "2023-03-13T17:51:03.826453+00:00", "updated_at": "2023-03-13T17:51:03.826453+00:00" } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "put": { "tags": [ "Advanced OptIn/OptOut" ], "summary": "Update Auto-Response Setting", "operationId": "UpdateAutoRespConfig", "parameters": [ { "required": true, "schema": { "title": "Profile Id", "type": "string", "format": "uuid" }, "name": "profile_id", "in": "path" }, { "required": true, "schema": { "title": "Autoresp Cfg Id", "type": "string", "format": "uuid" }, "name": "autoresp_cfg_id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoRespConfigCreateSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutorespConfigResponseSchema" }, "example": { "data": { "op": "start", "keywords": [ "START", "BEGIN" ], "resp_text": "Hello there!", "country_code": "*", "id": "54b7e19f-98a8-416f-81d1-a2782eade48b", "created_at": "2023-03-10T21:54:46.293380+00:00", "updated_at": "2023-03-10T21:54:46.293380+00:00" } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_tollfree/verification/requests": { "get": { "tags": [ "Messaging Tollfree Verification" ], "summary": "List Verification Requests", "description": "Get a list of previously-submitted tollfree verification requests", "operationId": "ListVerificationRequests", "parameters": [ { "required": true, "schema": { "title": "Page", "minimum": 1.0, "type": "integer" }, "name": "page", "in": "query" }, { "description": "\n Request this many records per page\n\n This value is automatically clamped if the provided value is too large.\n ", "required": true, "schema": { "title": "Page Size", "minimum": 1.0, "type": "integer", "description": "\n Request this many records per page\n\n This value is automatically clamped if the provided value is too large.\n " }, "name": "page_size", "in": "query" }, { "required": false, "schema": { "title": "Date Start", "type": "string", "format": "date-time" }, "name": "date_start", "in": "query" }, { "required": false, "schema": { "title": "Date End", "type": "string", "format": "date-time" }, "name": "date_end", "in": "query" }, { "required": false, "schema": { "$ref": "#/components/schemas/TFVerificationStatus" }, "name": "status", "in": "query" }, { "required": false, "schema": { "title": "Phone Number", "type": "string" }, "name": "phone_number", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Paginated_VerificationRequestStatus_" } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Messaging Tollfree Verification" ], "summary": "Submit Verification Request", "description": "Submit a new tollfree verification request", "operationId": "SubmitVerificationRequest", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TFVerificationRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationRequestEgress" } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_tollfree/verification/requests/{id}": { "delete": { "tags": [ "Messaging Tollfree Verification" ], "summary": "Delete Verification Request", "description": "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", "operationId": "DeleteVerificationRequest", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string", "format": "uuid" }, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Get Verification Request", "description": "Get a single verification request by its ID.", "operationId": "GetVerificationRequest", "tags": [ "Messaging Tollfree Verification" ], "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string", "format": "uuid" }, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationRequestStatus" } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "tags": [ "Messaging Tollfree Verification" ], "summary": "Update Verification Request", "description": "Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken.", "operationId": "UpdateVerificationRequest", "parameters": [ { "required": true, "schema": { "title": "Id", "type": "string", "format": "uuid" }, "name": "id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TFVerificationRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationRequestEgress" } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/messaging_url_domains": { "get": { "summary": "List messaging URL domains", "operationId": "ListMessagingUrlDomains", "tags": [ "Messaging URL Domains" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListMessagingUrlDomains" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/mobile_network_operators": { "get": { "summary": "List mobile network operators", "description": "Telnyx has a set of GSM mobile operators partners that are available through our mobile network roaming. This resource is entirely managed by Telnyx and may change over time. That means that this resource won't allow any write operations for it. Still, it's available so it can be used as a support resource that can be related to other resources or become a configuration option.", "operationId": "GetMobileNetworkOperators", "tags": [ "Mobile Network Operators" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[name][starts_with]", "description": "Filter by name starting with.", "in": "query", "required": false, "schema": { "type": "string", "example": "AT" } }, { "name": "filter[name][contains]", "description": "Filter by name containing match.", "in": "query", "required": false, "schema": { "type": "string", "example": "T&T" } }, { "name": "filter[name][ends_with]", "description": "Filter by name ending with.", "in": "query", "required": false, "schema": { "type": "string", "example": "T" } }, { "name": "filter[country_code]", "description": "Filter by exact country_code.", "in": "query", "required": false, "schema": { "type": "string", "example": "US" } }, { "name": "filter[mcc]", "description": "Filter by exact MCC.", "in": "query", "required": false, "schema": { "type": "string", "example": "310" } }, { "name": "filter[mnc]", "description": "Filter by exact MNC.", "in": "query", "required": false, "schema": { "type": "string", "example": "410" } }, { "name": "filter[tadig]", "description": "Filter by exact TADIG.", "in": "query", "required": false, "schema": { "type": "string", "example": "USACG" } }, { "name": "filter[network_preferences_enabled]", "description": "Filter by network_preferences_enabled.", "in": "query", "required": false, "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "$ref": "#/components/responses/SearchMobileNetworkOperatorsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/mobile_push_credentials": { "get": { "tags": [ "Push Credentials" ], "summary": "List mobile push credentials", "description": "List mobile push credentials", "operationId": "ListPushCredentials", "parameters": [ { "name": "filter[type]", "in": "query", "description": "type of mobile push credentials", "schema": { "type": "string", "enum": [ "ios", "android" ], "example": "ios" } }, { "name": "filter[alias]", "in": "query", "description": "Unique mobile push credential alias", "schema": { "type": "string", "example": "LucyCredential" } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "description": "Mobile mobile push credentials", "content": { "application/json": { "schema": { "$ref": "#/components/responses/ListPushCredentialsResponse" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Push Credentials" ], "summary": "Creates a new mobile push credential", "description": "Creates a new mobile push credential", "operationId": "CreatePushCredential", "parameters": [], "requestBody": { "description": "Mobile push credential parameters that need to be sent in the request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CreateIosPushCredentialRequest" }, { "$ref": "#/components/schemas/CreateAndroidPushCredentialRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Mobile push credential created", "content": { "application/json": { "schema": { "$ref": "#/components/responses/PushCredentialResponse" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "422": { "description": "Unable to process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "x-latency-category": "responsive" } }, "/mobile_push_credentials/{push_credential_id}": { "delete": { "tags": [ "Push Credentials" ], "summary": "Deletes a mobile push credential", "description": "Deletes a mobile push credential based on the given `push_credential_id`", "operationId": "DeletePushCredentialById", "parameters": [ { "name": "push_credential_id", "in": "path", "description": "The unique identifier of a mobile push credential", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b76-4df3-4bca-a05a-3da1ecc389f0" } } ], "responses": { "204": { "description": "The mobile push credential was deleted successfully" }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "422": { "description": "Unable to process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Push Credentials" ], "summary": "Retrieves a mobile push credential", "description": "Retrieves mobile push credential based on the given `push_credential_id`", "operationId": "GetPushCredentialById", "parameters": [ { "name": "push_credential_id", "in": "path", "description": "The unique identifier of a mobile push credential", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b76-4df3-4bca-a05a-3da1ecc389f0" } } ], "responses": { "200": { "description": "Successful get mobile push credential response", "content": { "application/json": { "schema": { "$ref": "#/components/responses/PushCredentialResponse" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "422": { "description": "Unable to process request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "x-latency-category": "responsive" } }, "/networks": { "get": { "summary": "List all Networks", "description": "List all Networks.", "operationId": "ListNetworks", "tags": [ "Networks" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[name]", "description": "The network name to filter on.", "in": "query", "required": false, "schema": { "type": "string", "example": "test network" } } ], "responses": { "200": { "$ref": "#/components/responses/NetworkListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a Network", "description": "Create a new Network.", "operationId": "CreateNetwork", "tags": [ "Networks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkCreate" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/NetworkResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/networks/{id}": { "delete": { "summary": "Delete a Network", "description": "Delete a Network.", "operationId": "DeleteNetwork", "tags": [ "Networks" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/NetworkResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a Network", "description": "Retrieve a Network.", "operationId": "GetNetwork", "tags": [ "Networks" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/NetworkResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a Network", "description": "Update a Network.", "operationId": "UpdateNetwork", "tags": [ "Networks" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkCreate" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/NetworkResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/networks/{id}/default_gateway": { "delete": { "summary": "Delete Default Gateway.", "description": "Delete Default Gateway.", "operationId": "DeleteDefaultGateway", "tags": [ "Networks" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/DefaultGatewayResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Get Default Gateway status.", "description": "Get Default Gateway status.", "operationId": "GetDefaultGateway", "tags": [ "Networks" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/DefaultGatewayResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create Default Gateway.", "description": "Create Default Gateway.", "operationId": "CreateDefaultGateway", "tags": [ "Networks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultGateway" } } }, "required": true }, "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/DefaultGatewayResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/networks/{id}/network_interfaces": { "get": { "summary": "List all Interfaces for a Network.", "description": "List all Interfaces for a Network.", "operationId": "ListNetworkInterfaces", "tags": [ "Networks" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[name]", "description": "The interface name to filter on.", "in": "query", "required": false, "schema": { "type": "string", "example": "test interface" } }, { "name": "filter[type]", "description": "The interface type to filter on.", "in": "query", "required": false, "schema": { "type": "string", "example": "wireguard_interface" } }, { "name": "filter[status]", "description": "The interface status to filter on.", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/InterfaceStatus" } } ], "responses": { "200": { "$ref": "#/components/responses/NetworkInterfaceListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/notification_channels": { "get": { "description": "List notification channels.", "summary": "List notification channels", "operationId": "ListNotificationChannels", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/ChannelTypeId" } ], "responses": { "200": { "description": "Returns a list of notification channels.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationChannel" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Create a notification channel.", "summary": "Create a notification channel", "operationId": "CreateNotificationChannels", "tags": [ "Notifications" ], "requestBody": { "description": "Add a Notification Channel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationChannel" } } } }, "responses": { "200": { "description": "A Notification Channel response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationChannel" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/notification_channels/{id}": { "delete": { "description": "Delete a notification channel.", "summary": "Delete a notification channel", "operationId": "DeleteNotificationChannel", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "description": "A Notification Channel response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationChannel" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Get a notification channel.", "summary": "Get a notification channel", "operationId": "GetNotificationChannel", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "description": "A Notification Channel response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationChannel" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Update a notification channel.", "summary": "Update a notification channel", "operationId": "UpdateNotificationChannel", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "requestBody": { "description": "Update notification channel object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationChannel" } } } }, "responses": { "200": { "description": "A Notification Channel response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationChannel" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/notification_event_conditions": { "get": { "description": "Returns a list of your notifications events conditions.", "summary": "List all Notifications Events Conditions", "operationId": "FindNotificationsEventsConditions", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/AssociatedRecordType" } ], "responses": { "200": { "description": "Returns a list of notification event conditions available.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationEventCondition" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/notification_events": { "get": { "description": "Returns a list of your notifications events.", "summary": "List all Notifications Events", "operationId": "FindNotificationsEvents", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "description": "Returns a list of notification events available.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationEvent" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/notification_profiles": { "get": { "description": "Returns a list of your notifications profiles.", "summary": "List all Notifications Profiles", "operationId": "FindNotificationsProfiles", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "description": "Returns a list of notification profiles.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationProfile" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Create a notification profile.", "summary": "Create a notification profile", "operationId": "CreateNotificationProfile", "tags": [ "Notifications" ], "requestBody": { "description": "Add a Notification Profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationProfile" } } } }, "responses": { "200": { "description": "A Notification Profile response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationProfile" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/notification_profiles/{id}": { "delete": { "description": "Delete a notification profile.", "summary": "Delete a notification profile", "operationId": "DeleteNotificationProfile", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "description": "A Notification Profile response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationProfile" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Get a notification profile.", "operationId": "GetNotificationProfile", "summary": "Get a notification profile", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "description": "A Notification Profile response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationProfile" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Update a notification profile.", "operationId": "UpdateNotificationProfile", "summary": "Update a notification profile", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "requestBody": { "description": "Update notification profile object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationProfile" } } } }, "responses": { "200": { "description": "A Notification Profile response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationProfile" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/notification_settings": { "get": { "description": "List notification settings.", "summary": "List notification settings", "operationId": "ListNotificationSettings", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/NotificationProfileId" }, { "$ref": "#/components/parameters/NotificationChannelId" }, { "$ref": "#/components/parameters/NotificationEventConditionId" }, { "$ref": "#/components/parameters/AssociatedRecordType" }, { "$ref": "#/components/parameters/Status" } ], "responses": { "200": { "description": "Returns a list of notification settings.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationSetting" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Add a notification setting.", "summary": "Add a Notification Setting", "operationId": "CreateNotificationSetting", "tags": [ "Notifications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationSetting" } } } }, "responses": { "200": { "description": "A Notification Setting response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationSetting" } } } } } }, "201": { "description": "A Notification Setting response - async", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationSetting" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/notification_settings/{id}": { "delete": { "description": "Delete a notification setting.", "summary": "Delete a notification setting", "operationId": "DeleteNotificationSetting", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "description": "A Notification Setting response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationSetting" } } } } } }, "201": { "description": "A Notification Setting response - async", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationSetting" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Get a notification setting.", "summary": "Get a notification setting", "operationId": "GetNotificationSetting", "tags": [ "Notifications" ], "parameters": [ { "$ref": "#/components/parameters/Id" } ], "responses": { "200": { "description": "A Notification Setting response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationSetting" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_block_orders": { "get": { "summary": "List number block orders", "description": "Get a paginated list of number block orders.", "operationId": "ListNumberBlockOrders", "tags": [ "Phone Number Block Orders" ], "parameters": [ { "name": "filter[status]", "in": "query", "description": "Filter number block orders by status.", "schema": { "type": "string", "example": "pending" } }, { "name": "filter[created_at][gt]", "in": "query", "description": "Filter number block orders later than this value.", "schema": { "type": "string", "example": "2018-01-01T00:00:00.000000Z" } }, { "name": "filter[created_at][lt]", "in": "query", "description": "Filter number block orders earlier than this value.", "schema": { "type": "string", "example": "2018-01-01T00:00:00.000000Z" } }, { "name": "filter[phone_numbers.starting_number]", "in": "query", "description": "Filter number block orders having these phone numbers.", "schema": { "type": "string", "example": "+19705555000" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListNumberBlockOrdersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a number block order", "description": "Creates a phone number block order.", "operationId": "CreateNumberBlockOrder", "tags": [ "Phone Number Block Orders" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNumberBlockOrderRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/NumberBlockOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "numberOrderStatusUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberOrderBlockEvent" } } } }, "responses": { "200": { "description": "The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL." } } } } } }, "x-latency-category": "responsive" } }, "/number_block_orders/{number_block_order_id}": { "get": { "summary": "Retrieve a number block order", "description": "Get an existing phone number block order.", "operationId": "RetrieveNumberBlockOrder", "tags": [ "Phone Number Block Orders" ], "parameters": [ { "name": "number_block_order_id", "in": "path", "description": "The number block order ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/NumberBlockOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_lookup/{phone_number}": { "get": { "summary": "Lookup phone number data", "description": "Returns information about the provided phone number.", "operationId": "LookupNumber", "tags": [ "Number Lookup" ], "parameters": [ { "$ref": "#/components/parameters/PhoneNumber" }, { "$ref": "#/components/parameters/NumberLookupType" } ], "responses": { "200": { "$ref": "#/components/responses/NumberLookupResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_order_documents": { "get": { "summary": "List number order documents", "description": "Gets a paginated list of number order documents.", "operationId": "ListNumberOrderDocuments", "tags": [ "Phone Number Order Documents" ], "x-group-parameters": "true", "parameters": [ { "name": "filter[requirement_id]", "in": "query", "description": "Filter number order documents by `requirement_id`.", "schema": { "type": "string" } }, { "name": "filter[created_at][gt]", "in": "query", "description": "Filter number order documents after this datetime.", "schema": { "type": "string" } }, { "name": "filter[created_at][lt]", "in": "query", "description": "Filter number order documents from before this datetime.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListNumberOrderDocumentsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a number order document", "description": "Upload a phone number order document.", "operationId": "CreateNumberOrderDocument", "tags": [ "Phone Number Order Documents" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNumberOrderDocumentRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/NumberOrderDocumentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_order_documents/{number_order_document_id}": { "get": { "summary": "Retrieve a number order document", "description": "Gets a single number order document.", "operationId": "RetrieveNumberOrderDocument", "tags": [ "Phone Number Order Documents" ], "parameters": [ { "name": "number_order_document_id", "in": "path", "description": "The number order document ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/NumberOrderDocumentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a number order document", "description": "Updates a number order document.", "operationId": "UpdateNumberOrderDocument", "tags": [ "Phone Number Order Documents" ], "parameters": [ { "name": "number_order_document_id", "in": "path", "description": "The number order document ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNumberOrderDocumentRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/NumberOrderDocumentResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_order_phone_numbers": { "get": { "summary": "Retrieve a list of phone numbers associated to orders", "description": "Get a list of phone numbers associated to orders.", "operationId": "RetrieveOrderPhoneNumbers", "tags": [ "Phone Number Orders" ], "responses": { "200": { "$ref": "#/components/responses/ListNumberOrderPhoneNumbersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_order_phone_numbers/{number_order_phone_number_id}": { "get": { "summary": "Retrieve a number order phone number.", "description": "Get an existing number order phone number.", "operationId": "GetNumberOrderPhoneNumber", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "number_order_phone_number_id", "in": "path", "description": "The number order phone number ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/NumberOrderPhoneNumberResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a number order phone number.", "description": "Updates a number order phone number.", "operationId": "UpdateNumberOrderPhoneNumber", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "number_order_phone_number_id", "in": "path", "description": "The number order phone number ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNumberOrderPhoneNumberRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/NumberOrderPhoneNumberResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_orders": { "get": { "summary": "List number orders", "description": "Get a paginated list of number orders.", "operationId": "ListNumberOrders", "tags": [ "Phone Number Orders" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "name": "filter[status]", "in": "query", "description": "Filter number orders by status.", "schema": { "type": "string" } }, { "name": "filter[created_at][gt]", "in": "query", "description": "Filter number orders later than this value.", "schema": { "type": "string" } }, { "name": "filter[created_at][lt]", "in": "query", "description": "Filter number orders earlier than this value.", "schema": { "type": "string" } }, { "name": "filter[phone_numbers_count]", "in": "query", "description": "Filter number order with this amount of numbers", "schema": { "type": "string" } }, { "name": "filter[customer_reference]", "in": "query", "description": "Filter number orders via the customer reference set.", "schema": { "type": "string" } }, { "name": "filter[requirements_met]", "in": "query", "description": "Filter number orders by requirements met.", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListNumberOrdersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a number order", "description": "Creates a phone number order.", "operationId": "CreateNumberOrder", "tags": [ "Phone Number Orders" ], "x-endpoint-cost": "heavy", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNumberOrderRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/NumberOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "callbacks": { "numberOrderStatusUpdate": { "{$request.body#/webhook_url}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberOrderedEvent" } } } }, "responses": { "200": { "description": "The server must return a HTTP 200, otherwise we will reattempt to deliver the webhook to the failover URL." } } } } } }, "x-latency-category": "responsive" } }, "/number_orders/{number_order_id}": { "get": { "summary": "Retrieve a number order", "description": "Get an existing phone number order.", "operationId": "RetrieveNumberOrder", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "number_order_id", "in": "path", "description": "The number order ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/NumberOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a number order", "description": "Updates a phone number order.", "operationId": "UpdateNumberOrder", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "number_order_id", "in": "path", "description": "The number order ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNumberOrderRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/NumberOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_reservations": { "get": { "summary": "List number reservations", "description": "Gets a paginated list of phone number reservations.", "operationId": "ListNumberReservations", "tags": [ "Phone Number Reservations" ], "x-group-parameters": "true", "parameters": [ { "name": "filter[status]", "in": "query", "description": "Filter number reservations by status.", "schema": { "type": "string" } }, { "name": "filter[created_at][gt]", "in": "query", "description": "Filter number reservations later than this value.", "schema": { "type": "string" } }, { "name": "filter[created_at][lt]", "in": "query", "description": "Filter number reservations earlier than this value.", "schema": { "type": "string" } }, { "name": "filter[phone_numbers.phone_number]", "in": "query", "description": "Filter number reservations having these phone numbers.", "schema": { "type": "string" } }, { "name": "filter[customer_reference]", "in": "query", "description": "Filter number reservations via the customer reference set.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListNumberReservationsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a number reservation", "description": "Creates a Phone Number Reservation for multiple numbers.", "operationId": "CreateNumberReservation", "tags": [ "Phone Number Reservations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNumberReservationRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/NumberReservationResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_reservations/{number_reservation_id}": { "get": { "summary": "Retrieve a number reservation", "description": "Gets a single phone number reservation.", "operationId": "RetrieveNumberReservation", "tags": [ "Phone Number Reservations" ], "parameters": [ { "name": "number_reservation_id", "in": "path", "description": "The number reservation ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/NumberReservationResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/number_reservations/{number_reservation_id}/actions/extend": { "post": { "summary": "Extend a number reservation", "description": "Extends reservation expiry time on all phone numbers.", "operationId": "ExtendNumberReservationExpiryTime", "tags": [ "Phone Number Reservations" ], "parameters": [ { "name": "number_reservation_id", "in": "path", "description": "The number reservation ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/NumberReservationResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/numbers_features": { "post": { "summary": "Retrieve the features for a list of numbers", "description": "Retrieve the features for a list of numbers", "operationId": "PostNumbersFeatures", "tags": [ "numbers features" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_numbers": { "type": "array", "items": { "type": "string", "format": "phone" } } }, "required": [ "phone_numbers" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "phone_number": { "type": "string", "format": "phone" }, "features": { "type": "array", "items": { "type": "string" } } }, "required": [ "phone_number", "features" ] } } } } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "responsive" } }, "/ota_updates": { "get": { "summary": "List OTA updates", "operationId": "ListOtaUpdates", "tags": [ "OTA updates" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterBasicStatusLifecycle" }, { "name": "filter[sim_card_id]", "description": "The SIM card identification UUID.", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "filter[type]", "description": "Filter by type.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "sim_card_network_preferences" ], "example": "sim_card_network_preferences" } } ], "responses": { "200": { "$ref": "#/components/responses/SearchOTAUpdateResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/ota_updates/{id}": { "get": { "summary": "Get OTA update", "description": "This API returns the details of an Over the Air (OTA) update.", "operationId": "GetOtaUpdate", "tags": [ "OTA updates" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/OTAUpdateResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/outbound_voice_profiles": { "get": { "description": "Get all outbound voice profiles belonging to the user that match the given filters.", "summary": "Get all outbound voice profiles", "operationId": "ListOutboundVoiceProfiles", "tags": [ "Outbound Voice Profiles" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/NameFilter" }, { "$ref": "#/components/parameters/SortOutboundVoiceProfile" } ], "responses": { "200": { "$ref": "#/components/responses/ListOutboundVoiceProfilesResponse" }, "401": { "description": "Unauthorized" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "post": { "description": "Create an outbound voice profile.", "summary": "Create an outbound voice profile", "operationId": "CreateVoiceProfile", "tags": [ "Outbound Voice Profiles" ], "requestBody": { "description": "Parameters that can be defined when creating an outbound voice profile", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutboundVoiceProfileRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/OutboundVoiceProfileResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/outbound_voice_profiles/{id}": { "delete": { "description": "Deletes an existing outbound voice profile.", "summary": "Delete an outbound voice profile", "operationId": "DeleteOutboundVoiceProfile", "tags": [ "Outbound Voice Profiles" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/OutboundVoiceProfileResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "get": { "description": "Retrieves the details of an existing outbound voice profile.", "summary": "Retrieve an outbound voice profile", "operationId": "GetOutboundVoiceProfile", "tags": [ "Outbound Voice Profiles" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/OutboundVoiceProfileResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "patch": { "description": "Updates an existing outbound voice profile.", "summary": "Updates an existing outbound voice profile.", "operationId": "UpdateOutboundVoiceProfile", "tags": [ "Outbound Voice Profiles" ], "requestBody": { "description": "Parameters that can be updated on an outbound voice profile", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOutboundVoiceProfileRequest" } } } }, "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/OutboundVoiceProfileResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/partnerCampaign/sharedByMe": { "get": { "tags": [ "Shared Campaigns" ], "summary": "Get Partner Campaigns Shared By User", "description": "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.", "operationId": "GetPartnerCampaignsSharedByUser", "parameters": [ { "description": "The 1-indexed page number to get. The default value is `1`.", "required": false, "schema": { "title": "Page", "type": "integer", "description": "The 1-indexed page number to get. The default value is `1`.", "default": 1 }, "name": "page", "in": "query" }, { "description": "The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.", "required": false, "schema": { "title": "Recordsperpage", "type": "integer", "description": "The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`.", "default": 10 }, "name": "recordsPerPage", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedCampaignRecordSet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/partnerCampaign/{campaignId}/sharing": { "get": { "tags": [ "Shared Campaigns" ], "summary": "Get Sharing Status", "operationId": "GetCampaignSharingStatus", "parameters": [ { "description": "ID of the campaign in question", "required": true, "schema": { "title": "Campaignid", "type": "string", "description": "ID of the campaign in question" }, "name": "campaignId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Get Sharing Status Public Partnercampaign Campaignid Sharing Get", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CampaignSharingStatus" } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/payment/auto_recharge_prefs": { "get": { "description": "Returns the payment auto recharge preferences.", "summary": "List auto recharge preferences", "operationId": "GetAutoRechargePrefs", "tags": [ "AutoRechargePreferences" ], "x-endpoint-cost": "medium", "responses": { "200": { "$ref": "#/components/responses/AutoRechargePrefResponse" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "patch": { "description": "Update payment auto recharge preferences.", "summary": "Update auto recharge preferences", "operationId": "UpdateAutoRechargePrefs", "tags": [ "AutoRechargePreferences" ], "x-endpoint-cost": "medium", "requestBody": { "description": "Details to update auto recharge preferences", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoRechargePrefRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/AutoRechargePrefResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/phoneNumberAssignmentByProfile": { "post": { "tags": [ "Bulk Phone Number Campaigns" ], "summary": "Assign Messaging Profile To Campaign", "operationId": "PostAssignMessagingProfileToCampaign", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignProfileToCampaignRequest" } } }, "required": true }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Assign Messaging Profile To Campaign Public Phonenumberassignmentbyprofile Post", "anyOf": [ { "$ref": "#/components/schemas/AssignProfileToCampaignResponse" }, { "$ref": "#/components/schemas/SettingsDataErrorMessage" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "This endpoint allows you to link all phone numbers associated with a Messaging Profile to a campaign. **Please note:** if you want to assign phone numbers to a campaign that you did not create with Telnyx 10DLC services, this endpoint allows that provided that you've shared the campaign with Telnyx. In this case, only provide the parameter, `tcrCampaignId`, and not `campaignId`. In all other cases (where the campaign you're assigning was created with Telnyx 10DLC services), only provide `campaignId`, not `tcrCampaignId`.", "x-latency-category": "responsive" } }, "/phoneNumberAssignmentByProfile/{taskId}": { "get": { "tags": [ "Bulk Phone Number Campaigns" ], "summary": "Get Assignment Task Status", "operationId": "GetAssignmentTaskStatus", "parameters": [ { "required": true, "schema": { "title": "Taskid", "type": "string" }, "name": "taskId", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentTaskStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Check the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by `taskId`.", "x-latency-category": "responsive" } }, "/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers": { "get": { "tags": [ "Bulk Phone Number Campaigns" ], "summary": "Get Phone Number Status", "operationId": "GetPhoneNumberStatus", "parameters": [ { "required": true, "schema": { "title": "Taskid", "type": "string" }, "name": "taskId", "in": "path" }, { "required": false, "schema": { "title": "Recordsperpage", "default": 20 }, "name": "recordsPerPage", "in": "query" }, { "required": false, "schema": { "title": "Page", "default": 1 }, "name": "page", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberStatusResponsePaginated" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Check the status of the individual phone number/campaign assignments associated with the supplied `taskId`.", "x-latency-category": "responsive" } }, "/phoneNumberCampaign": { "get": { "tags": [ "Phone Number Campaigns" ], "summary": "Retrieve All Phone Number Campaigns", "operationId": "GetAllPhoneNumberCampaigns", "parameters": [ { "required": false, "schema": { "title": "Recordsperpage", "default": 20 }, "name": "recordsPerPage", "in": "query" }, { "required": false, "schema": { "title": "Page", "default": 1 }, "name": "page", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberCampaignPaginated" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve all of your organization's phone number/campaign assignments.", "x-latency-category": "responsive" }, "post": { "tags": [ "Phone Number Campaigns" ], "summary": "Create New Phone Number Campaign", "operationId": "CreatePhoneNumberCampaign", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberCampaignCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Create New Phone Number Campaign Public Phonenumbercampaign Post", "anyOf": [ { "$ref": "#/components/schemas/PhoneNumberCampaign" }, { "type": "object" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Assign an individual phone number to campaign.", "x-latency-category": "responsive" } }, "/phoneNumberCampaign/{phoneNumber}": { "delete": { "tags": [ "Phone Number Campaigns" ], "summary": "Delete Phone Number Campaign", "operationId": "DeletePhoneNumberCampaign", "parameters": [ { "required": true, "schema": { "title": "Phonenumber", "type": "string" }, "name": "phoneNumber", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberCampaign" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "This endpoint allows you to remove a campaign assignment from the supplied `phoneNumber`.", "x-latency-category": "responsive" }, "get": { "tags": [ "Phone Number Campaigns" ], "summary": "Get Single Phone Number Campaign", "operationId": "GetPhoneNumberCampaign", "parameters": [ { "required": true, "schema": { "title": "Phonenumber", "type": "string" }, "name": "phoneNumber", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberCampaign" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "Retrieve an individual phone number/campaign assignment by `phoneNumber`.", "x-latency-category": "responsive" }, "put": { "tags": [ "Phone Number Campaigns" ], "summary": "Create New Phone Number Campaign", "operationId": "CreatePhoneNumberCampaign", "parameters": [ { "required": true, "schema": { "title": "Phonenumber", "type": "string" }, "name": "phoneNumber", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberCampaignCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Create New Phone Number Campaign Public Phonenumbercampaign Phonenumber Put", "anyOf": [ { "$ref": "#/components/schemas/PhoneNumberCampaign" }, { "type": "object" } ] } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "description": "This endpoint allows you to assign a different campaign to a supplied `phoneNumber`.", "x-latency-category": "responsive" } }, "/phone_number_blocks/jobs": { "get": { "summary": "Lists the phone number blocks jobs", "operationId": "ListPhoneNumberBlocksJobs", "tags": [ "Phone Number Blocks Background Jobs" ], "x-group-parameters": "true", "parameters": [ { "name": "filter[type]", "in": "query", "description": "Filter the phone number blocks jobs by type.", "schema": { "type": "string", "enum": [ "delete_phone_number_block" ], "example": "delete_phone_number_block", "description": "Identifies the type of the background job." } }, { "name": "filter[status]", "in": "query", "description": "Filter the phone number blocks jobs by status.", "schema": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ], "example": "in_progress", "description": "Identifies the status of the background job." } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "sort", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "required": false, "schema": { "type": "string", "enum": [ "created_at" ], "example": "created_at" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPhoneNumberBlocksJobsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_number_blocks/jobs/delete_phone_number_block": { "post": { "x-latency-category": "background", "summary": "Deletes all numbers associated with a phone number block", "description": "Creates a new background job to delete all the phone numbers associated with the given block. We will only consider the phone number block as deleted after all phone numbers associated with it are removed, so multiple executions of this job may be necessary in case some of the phone numbers present errors during the deletion process.", "operationId": "CreatePhoneNumberBlockDeletionJob", "tags": [ "Phone Number Blocks Background Jobs" ], "x-group-parameters": "true", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberBlocksJobDeletePhoneNumberBlockRequest" } } } }, "responses": { "202": { "description": "Phone number blocks job delete phone numbers requested.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Number Blocks Job Delete Phone Number Block", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberBlocksJob" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/phone_number_blocks/jobs/{id}": { "get": { "summary": "Retrieves a phone number blocks job", "operationId": "GetPhoneNumberBlocksJob", "tags": [ "Phone Number Blocks Background Jobs" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Phone Number Blocks Job.", "required": true, "schema": { "type": "string" } } ], "x-group-parameters": "true", "responses": { "200": { "description": "Phone number blocks job details.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Number Blocks Job", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberBlocksJob" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_number_campaigns": { "get": { "tags": [ "Phone Number Campaigns" ], "summary": "Retrieve All Phone Number Campaigns", "operationId": "GetAllPhoneNumberCampaigns", "parameters": [ { "required": false, "schema": { "title": "Recordsperpage", "default": 20 }, "name": "recordsPerPage", "in": "query" }, { "required": false, "schema": { "title": "Page", "default": 1 }, "name": "page", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Phone Number Campaigns" ], "summary": "Create New Phone Number Campaign", "operationId": "CreatePhoneNumberCampaign", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberCampaignCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/phone_number_campaigns/{phoneNumber}": { "delete": { "tags": [ "Phone Number Campaigns" ], "summary": "Delete Phone Number Campaign", "operationId": "DeletePhoneNumberCampaign", "parameters": [ { "required": true, "schema": { "title": "Phonenumber", "type": "string" }, "name": "phoneNumber", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Phone Number Campaigns" ], "summary": "Get Single Phone Number Campaign", "operationId": "GetSinglePhoneNumberCampaign", "parameters": [ { "required": true, "schema": { "title": "Phonenumber", "type": "string" }, "name": "phoneNumber", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" }, "put": { "tags": [ "Phone Number Campaigns" ], "summary": "Create New Phone Number Campaign", "operationId": "PutPhoneNumberCampaign", "parameters": [ { "required": true, "schema": { "title": "Phonenumber", "type": "string" }, "name": "phoneNumber", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberCampaignCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "x-latency-category": "responsive" } }, "/phone_numbers": { "get": { "summary": "List phone numbers", "operationId": "ListPhoneNumbers", "tags": [ "Phone Number Configurations" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[tag]", "in": "query", "description": "Filter by phone number tags.", "required": false, "schema": { "type": "string" } }, { "name": "filter[phone_number]", "in": "query", "description": "Filter by phone number. Requires at least three digits.\n Non-numerical characters will result in no values being returned.", "required": false, "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "description": "Filter by phone number status.", "required": false, "schema": { "type": "string", "enum": [ "purchase_pending", "purchase_failed", "port_pending", "active", "deleted", "port_failed", "emergency_only", "ported_out", "port_out_pending" ], "example": "active" } }, { "name": "filter[connection_id]", "in": "query", "description": "Filter by connection_id.", "required": false, "schema": { "type": "string", "format": "int64", "example": "1521916448077776306" } }, { "name": "filter[voice.connection_name][contains]", "in": "query", "description": "Filter contains connection name. Requires at least three characters.", "required": false, "schema": { "type": "string", "example": "test" } }, { "name": "filter[voice.connection_name][starts_with]", "in": "query", "description": "Filter starts with connection name. Requires at least three characters.", "required": false, "schema": { "type": "string", "example": "test" } }, { "name": "filter[voice.connection_name][ends_with]", "in": "query", "description": "Filter ends with connection name. Requires at least three characters.", "required": false, "schema": { "type": "string", "example": "test" } }, { "name": "filter[voice.connection_name][eq]", "in": "query", "description": "Filter by connection name.", "required": false, "schema": { "type": "string", "example": "test" } }, { "name": "filter[voice.usage_payment_method]", "in": "query", "description": "Filter by usage_payment_method.", "required": false, "schema": { "type": "string", "enum": [ "pay-per-minute", "channel" ], "example": "channel" } }, { "name": "filter[billing_group_id]", "in": "query", "description": "Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.", "required": false, "schema": { "type": "string", "example": "62e4bf2e-c278-4282-b524-488d9c9c43b2" } }, { "name": "filter[emergency_address_id]", "in": "query", "description": "Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.", "required": false, "schema": { "type": "string", "format": "int64", "example": "9102160989215728032" } }, { "name": "filter[customer_reference]", "in": "query", "description": "Filter numbers via the customer_reference set.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "required": false, "schema": { "type": "string", "enum": [ "purchased_at", "phone_number", "connection_name", "usage_payment_method" ], "example": "connection_name" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPhoneNumbersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers/csv_downloads": { "get": { "summary": "List CSV downloads", "operationId": "ListCsvDownloads", "tags": [ "CSV Downloads" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListCsvDownloadsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "x-latency-category": "background", "summary": "Create a CSV download", "operationId": "CreateCsvDownload", "tags": [ "CSV Downloads" ], "x-endpoint-cost": "medium", "responses": { "200": { "$ref": "#/components/responses/CsvDownloadResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/phone_numbers/csv_downloads/{id}": { "get": { "x-latency-category": "background", "summary": "Retrieve a CSV download", "operationId": "GetCsvDownload", "tags": [ "CSV Downloads" ], "x-endpoint-cost": "medium", "parameters": [ { "name": "id", "in": "path", "description": "Identifies the CSV download.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/CsvDownloadResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/phone_numbers/inbound_channels": { "get": { "summary": "List your inbound channels", "description": "Returns the inbound channels for your account. Inbound channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.", "operationId": "ListInboundChannels", "tags": [ "Inbound Channels" ], "x-endpoint-cost": "medium", "responses": { "200": { "description": "Inbound Channels Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "channels": { "type": "integer", "description": "The current number of concurrent channels set for the account", "example": 7 }, "record_type": { "description": "Identifies the type of the response", "type": "string", "example": "inbound_channels" } } } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update inbound channels", "operationId": "UpdateOutboundChannels", "description": "Update the inbound channels for the account", "tags": [ "Inbound Channels" ], "x-endpoint-cost": "medium", "requestBody": { "description": "Inbound channels update", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "channels" ], "properties": { "channels": { "type": "integer", "description": "The new number of concurrent channels for the account", "example": 7 } } } } } }, "responses": { "200": { "description": "Expected Update response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "channels": { "type": "integer", "description": "The number of channels set for the account", "example": 7 }, "record_type": { "description": "Identifies the type of the response", "type": "string", "example": "inbound_channels" } } } } } } } }, "default": { "description": "Unexpected error", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "items": { "required": [ "code", "title" ], "properties": { "code": { "type": "string", "format": "int" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "description": "JSON pointer (RFC6901) to the offending entity.", "type": "string", "format": "json-pointer" }, "parameter": { "description": "Indicates which query parameter caused the error.", "type": "string" } } }, "meta": { "type": "object" } } } } } } } } } }, "x-latency-category": "responsive" } }, "/phone_numbers/jobs": { "get": { "summary": "Lists the phone numbers jobs", "operationId": "ListPhoneNumbersJobs", "tags": [ "Bulk Phone Number Operations" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "name": "filter[type]", "in": "query", "description": "Filter the phone number jobs by type.", "schema": { "type": "string", "enum": [ "update_emergency_settings", "delete_phone_numbers", "update_phone_numbers" ], "example": "update_emergency_settings", "description": "Identifies the type of the background job." } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "sort", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "required": false, "schema": { "type": "string", "enum": [ "created_at" ], "example": "created_at" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPhoneNumbersJobsResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Invalid sorting value": { "value": { "errors": [ { "code": "10015", "title": "Invalid sorting value", "detail": "The value provided for sorting is not valid. Check the value used and try again.", "source": { "pointer": "/sort" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } }, "Invalid page size": { "value": { "errors": [ { "code": "10015", "title": "Invalid pagination", "detail": "The provided 'page' parameter is invalid. It must be an object with 'size' and/or 'number' with numeric values.", "source": { "pointer": "page/size" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } }, "Invalid page number": { "value": { "errors": [ { "code": "10015", "title": "Invalid pagination", "detail": "The provided 'page' parameter is invalid. It must be an object with 'size' and/or 'number' with numeric values.", "source": { "pointer": "page/number" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers/jobs/delete_phone_numbers": { "post": { "x-latency-category": "background", "summary": "Delete a batch of numbers", "description": "Creates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call.", "operationId": "CreateDeletePhoneNumbersJob", "tags": [ "Bulk Phone Number Operations" ], "x-group-parameters": "true", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumbersJobDeletePhoneNumbersRequest" } } } }, "responses": { "202": { "description": "Phone numbers job delete phone numbers requested.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Numbers Job Delete Phone Numbers", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumbersJob" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ForbiddenResponse" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Phone numbers must be present": { "$ref": "#/components/examples/PhoneNumbersMustBePresent" }, "Maximum allowed phone numbers": { "$ref": "#/components/examples/MaximumAllowedPhoneNumbers" }, "Minimum allowed phone numbers": { "$ref": "#/components/examples/MinimumAllowedPhoneNumbers" }, "Mixed IDs and E164 values": { "$ref": "#/components/examples/MixedIdsAndE164Values" }, "Phone number ownership": { "$ref": "#/components/examples/PhoneNumberOwnership" }, "Maximum jobs allowed": { "$ref": "#/components/examples/Maximum20JobsAllowed" } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/phone_numbers/jobs/update_emergency_settings": { "post": { "x-latency-category": "background", "summary": "Update the emergency settings from a batch of numbers", "description": "Creates a background job to update the emergency settings of a collection of phone numbers. At most one thousand numbers can be updated per API call.", "operationId": "CreatePhoneNumbersJobUpdateEmergencySettings", "tags": [ "Bulk Phone Number Operations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumbersJobUpdateEmergencySettingsRequest" } } } }, "responses": { "202": { "description": "Phone numbers enable emergency requested.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Numbers Enable Emergency", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumbersJob" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ForbiddenResponse" }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Phone numbers must be present": { "$ref": "#/components/examples/PhoneNumbersMustBePresent" }, "Maximum allowed phone numbers": { "$ref": "#/components/examples/MaximumAllowedPhoneNumbers" }, "Minimum allowed phone numbers": { "$ref": "#/components/examples/MinimumAllowedPhoneNumbers" }, "Mixed IDs and E164 values": { "$ref": "#/components/examples/MixedIdsAndE164Values" }, "Phone number ownership": { "$ref": "#/components/examples/PhoneNumberOwnership" }, "Maximum jobs allowed": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "You can have at most 500 pending or in progress jobs", "source": { "pointer": "/base" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/phone_numbers/jobs/update_phone_numbers": { "post": { "x-latency-category": "background", "summary": "Update a batch of numbers", "description": "Creates a new background job to update a batch of numbers. At most one thousand numbers can be updated per API call. At least one of the updateable fields must be submitted.", "operationId": "CreateUpdatePhoneNumbersJob", "tags": [ "Bulk Phone Number Operations" ], "x-group-parameters": "true", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumbersJobUpdatePhoneNumbersRequest" } } } }, "responses": { "202": { "description": "Phone numbers job update phone numbers requested.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Numbers Job Update Phone Numbers", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumbersJob" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Not authorized": { "$ref": "#/components/examples/NotAuthorized" }, "Billing group not authorized": { "value": { "errors": [ { "code": "10010", "title": "Authorization Failed", "detail": "The specified billing group either does not exist or is not part of your account", "source": { "pointer": "/billing_group_id" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10010" } } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Phone numbers must be present": { "$ref": "#/components/examples/PhoneNumbersMustBePresent" }, "Maximum allowed phone numbers": { "$ref": "#/components/examples/MaximumAllowedPhoneNumbers" }, "Minimum allowed phone numbers": { "$ref": "#/components/examples/MinimumAllowedPhoneNumbers" }, "Mixed IDs and E164 values": { "$ref": "#/components/examples/MixedIdsAndE164Values" }, "Phone number ownership": { "$ref": "#/components/examples/PhoneNumberOwnership" }, "Minimum updateable field": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "You must provide at least 1 updateable field.", "source": { "pointer": "/updateable_fields" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } }, "Maximum jobs allowed": { "$ref": "#/components/examples/Maximum20JobsAllowed" } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/phone_numbers/jobs/{id}": { "get": { "summary": "Retrieve a phone numbers job", "operationId": "RetrievePhoneNumbersJob", "tags": [ "Bulk Phone Number Operations" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Phone Numbers Job.", "required": true, "schema": { "type": "string" } } ], "x-group-parameters": "true", "responses": { "200": { "description": "Phone numbers job details.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Numbers Job", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumbersJob" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" }, "examples": { "Resource not found": { "value": { "errors": [ { "code": "10005", "title": "Resource not found", "detail": "The requested resource or URL could not be found.", "source": { "pointer": "/base" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10005" } } ] } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers/messaging": { "get": { "summary": "List phone numbers with messaging settings", "operationId": "ListPhoneNumbersWithMessagingSettings", "tags": [ "Number Configurations" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListPhoneNumbersWithMessagingSettingsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers/voice": { "get": { "summary": "List phone numbers with voice settings", "operationId": "ListPhoneNumbersWithVoiceSettings", "tags": [ "Phone Number Configurations" ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[phone_number]", "in": "query", "description": "Filter by phone number. Requires at least three digits.\n Non-numerical characters will result in no values being returned.", "required": false, "schema": { "type": "string" } }, { "name": "filter[connection_name][contains]", "in": "query", "description": "Filter contains connection name. Requires at least three characters.", "required": false, "schema": { "type": "string", "example": "test" } }, { "name": "filter[customer_reference]", "in": "query", "description": "Filter numbers via the customer_reference set.", "schema": { "type": "string" } }, { "name": "filter[voice.usage_payment_method]", "in": "query", "description": "Filter by usage_payment_method.", "required": false, "schema": { "type": "string", "enum": [ "pay-per-minute", "channel" ], "example": "channel" } }, { "name": "sort", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "required": false, "schema": { "type": "string", "enum": [ "purchased_at", "phone_number", "connection_name", "usage_payment_method" ], "example": "connection_name" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPhoneNumbersWithVoiceSettingsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers/{id}": { "delete": { "summary": "Delete a phone number", "operationId": "DeletePhoneNumber", "tags": [ "Phone Number Configurations" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/IntId" } ], "responses": { "200": { "$ref": "#/components/responses/DeletePhoneNumberResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a phone number", "operationId": "RetrievePhoneNumber", "tags": [ "Phone Number Configurations" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/IntId" } ], "responses": { "200": { "$ref": "#/components/responses/PhoneNumberResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a phone number", "operationId": "UpdatePhoneNumber", "tags": [ "Phone Number Configurations" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/IntId" } ], "requestBody": { "description": "Updated settings for the phone number.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePhoneNumberRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/PhoneNumberResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers/{id}/actions/enable_emergency": { "post": { "summary": "Enable emergency for a phone number", "operationId": "EnablePhoneNumberEmergency", "tags": [ "Phone Number Configurations" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/IntId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberEnableEmergencyRequest" } } } }, "responses": { "200": { "description": "Phone number emergency enabled.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Number Enable Emergency", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberWithVoiceSettings" } } } } } }, "202": { "description": "Phone number emergency requested.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Number Enable Emergency", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberWithVoiceSettings" } } } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers/{id}/messaging": { "get": { "summary": "Retrieve a phone number with messaging settings", "operationId": "GetPhoneNumberMessagingSettings", "tags": [ "Number Configurations" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the type of resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/PhoneNumberWithMessagingSettingsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a phone number with messaging settings", "operationId": "UpdatePhoneNumberMessagingSettings", "tags": [ "Number Configurations" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the type of resource.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated messaging settings for the phone number", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePhoneNumberMessagingSettingsRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/PhoneNumberWithMessagingSettingsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers/{id}/voice": { "get": { "summary": "Retrieve a phone number with voice settings", "operationId": "GetPhoneNumberVoiceSettings", "tags": [ "Phone Number Configurations" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/IntId" } ], "responses": { "200": { "$ref": "#/components/responses/PhoneNumberWithVoiceSettingsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a phone number with voice settings", "operationId": "UpdatePhoneNumberVoiceSettings", "tags": [ "Phone Number Configurations" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/IntId" } ], "requestBody": { "description": "Updated voice settings for the phone number.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePhoneNumberVoiceSettingsRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/PhoneNumberWithVoiceSettingsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/phone_numbers_regulatory_requirements": { "get": { "summary": "Retrieve regulartory requirements", "operationId": "ListRegulatoryRequirements", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "filter[phone_number]", "in": "query", "description": "Record type phone number/ phone numbers", "schema": { "type": "string", "example": "+41215470622,+41215470633" }, "required": true } ], "responses": { "200": { "$ref": "#/components/responses/listRegulatoryRequirements" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/portability_checks": { "post": { "summary": "Run a portability check", "tags": [ "Phone Number Porting" ], "description": "Runs a portability check, returning the results immediately.", "operationId": "PostPortabilityCheck", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "The list of +E.164 formatted phone numbers to check for portability", "example": [ "+13035550000", "+13035550001", "+13035550002" ] } } } } } }, "responses": { "201": { "$ref": "#/components/responses/PortabilityCheckResponse" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting/loa_configuration/preview": { "post": { "tags": [ "Porting Order" ], "summary": "Preview the LOA configuration parameters", "description": "Preview the LOA template that would be generated without need to create LOA configuration.", "operationId": "PreviewLoaConfigurationParams", "requestBody": { "$ref": "#/components/requestBodies/CreatePortingLOAConfiguration" }, "responses": { "200": { "$ref": "#/components/responses/DownloadLOATemplate" }, "422": { "description": "Unprocessable entity. Check message field in response for details." }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" } }, "/porting/loa_configurations": { "get": { "tags": [ "Porting Order" ], "summary": "List LOA configurations", "description": "List the LOA configurations.", "operationId": "ListLoaConfigurations", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingLOAConfigurations" }, "422": { "description": "Unprocessable entity. Check message field in response for details." }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Porting Order" ], "summary": "Create a LOA configuration", "description": "Create a LOA configuration.", "operationId": "CreateLoaConfiguration", "requestBody": { "$ref": "#/components/requestBodies/CreatePortingLOAConfiguration" }, "responses": { "201": { "$ref": "#/components/responses/CreatePortingLOAConfiguration" }, "422": { "description": "Unprocessable entity. Check message field in response for details." }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" } }, "/porting/loa_configurations/{id}": { "delete": { "tags": [ "Porting Order" ], "summary": "Delete a LOA configuration", "description": "Delete a specific LOA configuration.", "operationId": "DeleteLoaConfiguration", "parameters": [ { "name": "id", "description": "Identifies a LOA configuration.", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Porting Order" ], "summary": "Retrieve a LOA configuration", "description": "Retrieve a specific LOA configuration.", "operationId": "GetLoaConfiguration", "parameters": [ { "name": "id", "description": "Identifies a LOA configuration.", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/ShowPortingLOAConfiguration" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" }, "patch": { "tags": [ "Porting Order" ], "summary": "Update a LOA configuration", "description": "Update a specific LOA configuration.", "operationId": "UpdateLoaConfiguration", "parameters": [ { "name": "id", "description": "Identifies a LOA configuration.", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "$ref": "#/components/requestBodies/CreatePortingLOAConfiguration" }, "responses": { "200": { "$ref": "#/components/responses/UpdatePortingLOAConfiguration" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" } }, "/porting/loa_configurations/{id}/preview": { "get": { "tags": [ "Porting Order" ], "summary": "Preview a LOA configuration", "description": "Preview a specific LOA configuration.", "operationId": "PreviewLoaConfiguration", "parameters": [ { "name": "id", "description": "Identifies a LOA configuration.", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/DownloadLOATemplate" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" } }, "/porting/reports": { "get": { "tags": [ "Porting Order" ], "summary": "List porting related reports", "description": "List the reports generated about porting operations.", "operationId": "ListPortingReports", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[report_type]", "in": "query", "description": "Filter reports of a specific type", "schema": { "type": "string", "enum": [ "export_porting_orders_csv" ], "example": "export_porting_orders_csv" } }, { "name": "filter[status]", "in": "query", "description": "Filter reports of a specific status", "schema": { "type": "string", "enum": [ "pending", "completed" ], "example": "completed" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingReports" }, "422": { "description": "Unprocessable entity. Check message field in response for details." }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Porting Order" ], "summary": "Create a porting related report", "description": "Generate reports about porting operations.", "operationId": "CreatePortingReport", "requestBody": { "$ref": "#/components/requestBodies/CreatePortingReport" }, "responses": { "201": { "$ref": "#/components/responses/CreatePortingReport" }, "422": { "description": "Unprocessable entity. Check message field in response for details." }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" } }, "/porting/reports/{id}": { "get": { "tags": [ "Porting Order" ], "summary": "Retrieve a report", "description": "Retrieve a specific report generated.", "operationId": "GetPortingReport", "parameters": [ { "name": "id", "description": "Identifies a report.", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/ShowPortingReport" }, "404": { "description": "Resource not found" }, "500": { "description": "Internal server error" } }, "x-latency-category": "responsive" } }, "/porting_orders": { "get": { "summary": "List all porting orders", "tags": [ "Porting Order" ], "description": "Returns a list of your porting order.", "operationId": "ListPortingOrders", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/QueryIncludePhoneNumbers" }, { "$ref": "#/components/parameters/FilterByPortingOrderStatus" }, { "$ref": "#/components/parameters/FilterByPortingOrderStatusIn" }, { "name": "filter[customer_reference]", "in": "query", "description": "Filter results by customer_reference", "example": "123abc", "schema": { "type": "string" } }, { "name": "filter[parent_support_key]", "in": "query", "description": "Filter results by parent_support_key", "example": "123abc", "schema": { "type": "string" } }, { "name": "filter[phone_numbers.country_code]", "in": "query", "description": "Filter results by country ISO 3166-1 alpha-2 code", "example": "US", "schema": { "type": "string" } }, { "name": "filter[phone_numbers.carrier_name]", "in": "query", "description": "Filter results by old service provider", "example": "Telnyx", "schema": { "type": "string" } }, { "name": "filter[misc.type]", "in": "query", "example": "full", "description": "Filter results by porting order type", "schema": { "$ref": "#/components/schemas/PortingOrderType" } }, { "name": "filter[end_user.admin.entity_name]", "in": "query", "description": "Filter results by person or company name", "example": "Porter McPortersen", "schema": { "type": "string" } }, { "name": "filter[end_user.admin.auth_person_name]", "in": "query", "example": "Admin McPortersen", "description": "Filter results by authorized person", "schema": { "type": "string" } }, { "name": "filter[activation_settings.fast_port_eligible]", "in": "query", "description": "Filter results by fast port eligible", "example": false, "schema": { "type": "boolean" } }, { "name": "filter[activation_settings.foc_datetime_requested][gt]", "in": "query", "description": "Filter results by foc date later than this value", "example": "2021-03-25T10:00:00.000Z", "schema": { "type": "string" } }, { "name": "filter[activation_settings.foc_datetime_requested][lt]", "in": "query", "description": "Filter results by foc date earlier than this value", "example": "2021-03-25T10:00:00.000Z", "schema": { "type": "string" } }, { "name": "filter[phone_numbers.phone_number][contains]", "in": "query", "description": "Filter results by full or partial phone_number", "example": "+13038675309", "schema": { "type": "string" } }, { "name": "sort[]", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "schema": { "type": "string", "enum": [ "created_at", "-created_at", "activation_settings.foc_datetime_requested", "-activation_settings.foc_datetime_requested" ], "example": "created_at" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingOrder" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a porting order", "tags": [ "Porting Order" ], "description": "Creates a new porting order object.", "operationId": "CreatePortingOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortingOrder" } } } }, "responses": { "201": { "$ref": "#/components/responses/ListDraftPortingOrdersWithoutPagination" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/exception_types": { "get": { "summary": "List all exception types", "tags": [ "Porting Order" ], "description": "Returns a list of all possible exception types for a porting order.", "operationId": "ListExceptionTypes", "parameters": [], "responses": { "200": { "$ref": "#/components/responses/ListPortingOrdersExceptionTypes" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/phone_number_configurations": { "get": { "summary": "List all phone number configurations", "tags": [ "Porting Order" ], "description": "Returns a list of phone number configurations paginated.", "operationId": "ListPhoneNumberConfigurations", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterByPortingOrderID" }, { "$ref": "#/components/parameters/FilterByPortingOrderIdIn" }, { "name": "filter[user_bundle_id]", "in": "query", "description": "Filter results by a specific user bundle ID", "schema": { "type": "string", "format": "uuid", "example": "5d6f7ede-1961-4717-bfb5-db392c5efc2d" } }, { "name": "filter[user_bundle_id][in][]", "in": "query", "description": "Filter results by a list of user bundle IDs", "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "example": "5d6f7ede-1961-4717-bfb5-db392c5efc2d" } } }, { "name": "filter[porting_phone_number]", "in": "query", "description": "Filter results by a specific porting phone number ID", "schema": { "type": "string", "format": "uuid", "example": "5d6f7ede-1961-4717-bfb5-db392c5efc2d" } }, { "name": "filter[porting_phone_number][in][]", "in": "query", "description": "Filter results by a list of porting phone number IDs", "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "example": "5d6f7ede-1961-4717-bfb5-db392c5efc2d" } } }, { "name": "sort[]", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "schema": { "type": "string", "enum": [ "created_at", "-created_at" ], "example": "created_at" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingPhoneNumberConfigurations" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a list of phone number configurations", "tags": [ "Porting Order" ], "description": "Creates a list of phone number configurations.", "operationId": "CreatePhoneNumberConfigurations", "requestBody": { "$ref": "#/components/requestBodies/CreatePortingPhoneNumberConfigurations" }, "responses": { "201": { "$ref": "#/components/responses/CreatePortingPhoneNumberConfigurations" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}": { "delete": { "summary": "Delete a porting order", "tags": [ "Porting Order" ], "description": "Deletes an existing porting order. This operation is restrict to porting orders in draft state.", "operationId": "DeletePortingOrder", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "responses": { "204": { "description": "No content" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a porting order", "tags": [ "Porting Order" ], "description": "Retrieves the details of an existing porting order.", "operationId": "GetPortingOrder", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "$ref": "#/components/parameters/QueryIncludePhoneNumbers" } ], "responses": { "200": { "$ref": "#/components/responses/ShowPortingOrder" }, "401": { "description": "Unauthorized" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Edit a porting order", "tags": [ "Porting Order" ], "description": "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.", "operationId": "UpdatePortingOrder", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePortingOrder" } } } }, "responses": { "200": { "$ref": "#/components/responses/UpdatePortingOrderResponse" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/actions/activate": { "post": { "summary": "Activate every number in a porting order asynchronously.", "tags": [ "Porting Order" ], "description": "Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only.", "operationId": "ActivatePortingOrder", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "responses": { "202": { "$ref": "#/components/responses/ShowPortingOrdersActivationJob" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/actions/cancel": { "post": { "summary": "Cancel a porting order", "tags": [ "Porting Order" ], "description": "Cancel a porting order", "operationId": "CancelPortingOrder", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "responses": { "200": { "$ref": "#/components/responses/CancelPortingOrderResponse" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/actions/confirm": { "post": { "summary": "Submit a porting order.", "tags": [ "Porting Order" ], "description": "Confirm and submit your porting order.", "operationId": "ConfirmPortingOrder", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "responses": { "200": { "$ref": "#/components/responses/ConfirmPortingOrderResponse" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/actions/share": { "post": { "summary": "Share a porting order", "tags": [ "Porting Order" ], "description": "Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users.", "operationId": "SharePortingOrder", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "requestBody": { "$ref": "#/components/requestBodies/SharePortingOrder" }, "responses": { "201": { "$ref": "#/components/responses/SharePortingOrder" }, "401": { "description": "Unauthorized" }, "404": { "description": "Porting Order not found" } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/activation_jobs": { "get": { "summary": "List all porting activation jobs", "tags": [ "Porting Order" ], "description": "Returns a list of your porting activation jobs.", "operationId": "ListPortingOrderActivationJobs", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingOrdersActivationJobs" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/activation_jobs/{activationJobId}": { "get": { "summary": "Retrieve a porting activation job", "tags": [ "Porting Order" ], "description": "Returns a porting activation job.", "operationId": "GetPortingOrdersActivationJob", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "$ref": "#/components/parameters/PathPortingOrdersActivationJobID" } ], "responses": { "200": { "$ref": "#/components/responses/ShowPortingOrdersActivationJob" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a porting activation job", "tags": [ "Porting Order" ], "description": "Updates the activation time of a porting activation job.", "operationId": "UpdatePortingOrdersActivationJob", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "$ref": "#/components/parameters/PathPortingOrdersActivationJobID" } ], "requestBody": { "$ref": "#/components/requestBodies/UpdatePortingOrdersActivationJob" }, "responses": { "200": { "$ref": "#/components/responses/ShowPortingOrdersActivationJob" }, "422": { "description": "Unprocessable entity. Check message field in response for details." }, "404": { "description": "Not found" } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/additional_documents": { "get": { "summary": "List additional documents", "tags": [ "Porting Order" ], "description": "Returns a list of additional documents for a porting order.", "operationId": "ListAdditionalDocuments", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[document_type]", "in": "query", "description": "Filter additional documents of a specific document type", "schema": { "type": "string", "enum": [ "loa", "invoice", "csr", "other" ], "example": "loa" } }, { "name": "filter[document_type][in][]", "in": "query", "description": "Filter additional documents by a list of document types", "schema": { "type": "array", "items": { "type": "string", "enum": [ "loa", "invoice", "csr", "other" ], "example": "loa" } } }, { "name": "sort[]", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "schema": { "type": "string", "enum": [ "created_at", "-created_at" ], "example": "created_at" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingAdditionalDocuments" }, "404": { "description": "Resource not found" }, "401": { "description": "Unauthorized" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a list of additional documents", "tags": [ "Porting Order" ], "description": "Creates a list of additional documents for a porting order.", "operationId": "CreateAdditionalDocuments", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "requestBody": { "$ref": "#/components/requestBodies/CreatePortingAdditionalDocuments" }, "responses": { "201": { "$ref": "#/components/responses/CreatePortingAdditionalDocuments" }, "404": { "description": "Resource not found" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/additional_documents/{additional_document_id}": { "delete": { "summary": "Delete an additional document", "tags": [ "Porting Order" ], "description": "Deletes an additional document for a porting order.", "operationId": "DeleteAdditionalDocument", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "name": "additional_document_id", "description": "Additional document identification.", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "Resource not found" }, "401": { "description": "Unauthorized" } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/allowed_foc_windows": { "get": { "summary": "List allowed FOC dates", "tags": [ "Porting Order" ], "description": "Returns a list of allowed FOC dates for a porting order.", "operationId": "ListAllowedFocWindows", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "responses": { "200": { "$ref": "#/components/responses/ListAllowedFocWindows" }, "401": { "description": "Unauthorized" } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/comments": { "get": { "summary": "List all comments of a porting order", "tags": [ "Porting Order" ], "description": "Returns a list of all comments of a porting order.", "operationId": "ListPortingOrderComments", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingOrdersComments" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a comment for a porting order", "tags": [ "Porting Order" ], "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "description": "Creates a new comment for a porting order.", "operationId": "CreateComment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortingOrderComment" } } } }, "responses": { "201": { "$ref": "#/components/responses/ShowPortingOrdersComment" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/loa_template": { "get": { "summary": "Download a porting order loa template", "tags": [ "Porting Order" ], "description": "Download a porting order loa template", "operationId": "GetPortingOrderLoaTemplate", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "name": "loa_configuration_id", "in": "query", "description": "The identifier of the LOA configuration to use for the template. If not provided, the default LOA configuration will be used.", "example": "a36c2277-446b-4d11-b4ea-322e02a5c08d", "required": false, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/DownloadLOATemplate" }, "401": { "description": "Unauthorized" } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/requirements": { "get": { "summary": "List porting order requirements", "tags": [ "Porting Order" ], "description": "Returns a list of all requirements based on country/number type for this porting order.", "operationId": "ListPortingOrderRequirements", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingOrderRequirements" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/sub_request": { "get": { "summary": "Retrieve the associated V1 sub_request_id and port_request_id", "tags": [ "Porting Order" ], "description": "Retrieve the associated V1 sub_request_id and port_request_id", "operationId": "GetPortingOrderSubRequest", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "responses": { "200": { "$ref": "#/components/responses/SubRequestByPortingOrder" }, "401": { "description": "Unauthorized" }, "404": { "description": "Porting Order not found" } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/verification_codes": { "get": { "summary": "List verification codes", "tags": [ "Porting Order" ], "description": "Returns a list of verification codes for a porting order.", "operationId": "ListVerificationCodes", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterByPhoneNumber" }, { "$ref": "#/components/parameters/FilterByPhoneNumberIn" }, { "name": "filter[verified]", "in": "query", "description": "Filter verification codes that have been verified or not", "schema": { "type": "boolean", "example": true } }, { "name": "sort[]", "in": "query", "description": "Specifies the sort order for results. If not given, results are sorted by created_at in descending order.", "schema": { "type": "string", "enum": [ "created_at", "-created_at" ], "example": "created_at" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingVerificationCodes" }, "404": { "description": "Resource not found" }, "401": { "description": "Unauthorized" } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/verification_codes/send": { "post": { "summary": "Send the verification codes", "description": "Send the verification code for all porting phone numbers.", "tags": [ "Porting Order" ], "operationId": "SendPortingVerificationCodes", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "requestBody": { "$ref": "#/components/requestBodies/SendPortingVerificationCodes" }, "responses": { "204": { "description": "No content" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_orders/{id}/verification_codes/verify": { "post": { "summary": "Verify the verification code for a list of phone numbers", "description": "Verifies the verification code for a list of phone numbers.", "tags": [ "Porting Order" ], "operationId": "VerifyPortingVerificationCodes", "parameters": [ { "$ref": "#/components/parameters/PathPortingOrderID" } ], "requestBody": { "$ref": "#/components/requestBodies/VerifyPortingVerificationCodes" }, "responses": { "200": { "$ref": "#/components/responses/VerifyPortingVerificationCodes" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/porting_phone_numbers": { "get": { "summary": "List all porting phone numbers", "tags": [ "Porting Order" ], "description": "Returns a list of your porting phone numbers.", "operationId": "ListPortingPhoneNumbers", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterByPortingOrderID" }, { "$ref": "#/components/parameters/FilterByPortingOrderIdIn" }, { "$ref": "#/components/parameters/FilterBySupportKeyEq" }, { "$ref": "#/components/parameters/FilterBySupportKeyIn" }, { "$ref": "#/components/parameters/FilterByPhoneNumber" }, { "$ref": "#/components/parameters/FilterByPhoneNumberIn" }, { "name": "filter[porting_order_status]", "in": "query", "description": "Filter results by porting order status", "schema": { "type": "string", "enum": [ "draft", "in-process", "submitted", "exception", "foc-date-confirmed", "cancel-pending", "ported", "cancelled" ], "example": "in-process" } }, { "$ref": "#/components/parameters/FilterByPortingOrderActivationStatus" }, { "$ref": "#/components/parameters/FilterByPortabilityStatus" } ], "responses": { "200": { "$ref": "#/components/responses/ListPortingPhoneNumbers" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/portouts": { "get": { "summary": "List portout requests", "description": "Returns the portout requests according to filters", "operationId": "ListPortoutRequest", "tags": [ "Number Portout" ], "parameters": [ { "name": "filter[carrier_name]", "in": "query", "description": "Filter by new carrier name.", "required": false, "schema": { "type": "string" } }, { "name": "filter[spid]", "in": "query", "description": "Filter by new carrier spid.", "required": false, "schema": { "type": "string" } }, { "name": "filter[status]", "in": "query", "description": "Filter by portout status.", "required": false, "schema": { "type": "string", "enum": [ "pending", "authorized", "ported", "rejected", "rejected-pending", "canceled" ] } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListPortoutResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/portouts/{id}": { "get": { "summary": "Get a portout request", "description": "Returns the portout request based on the ID provided", "operationId": "FindPortoutRequest", "tags": [ "Number Portout" ], "parameters": [ { "name": "id", "in": "path", "description": "Portout id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/PortoutResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/portouts/{id}/comments": { "get": { "summary": "List all comments for a portout request", "description": "Returns a list of comments for a portout request.", "operationId": "FindPortoutComments", "tags": [ "Number Portout" ], "parameters": [ { "name": "id", "in": "path", "description": "Portout id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "$ref": "#/components/responses/ListPortoutComments" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a comment on a portout request", "description": "Creates a comment on a portout request.", "operationId": "PostPortRequestComment", "tags": [ "Number Portout" ], "parameters": [ { "name": "id", "in": "path", "description": "Portout id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "description": "Comment to post on this portout request" } } } } } }, "responses": { "201": { "$ref": "#/components/responses/PortoutCommentResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/portouts/{id}/supporting_documents": { "get": { "summary": "List supporting documents on a portout request", "description": "List every supporting documents for a portout request.", "operationId": "GetPortRequestSupportingDocuments", "tags": [ "Number Portout" ], "parameters": [ { "name": "id", "in": "path", "description": "Portout id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "201": { "$ref": "#/components/responses/PortOutListSupportingDocumentsResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a list of supporting documents on a portout request", "description": "Creates a list of supporting documents on a portout request.", "operationId": "PostPortRequestSupportingDocuments", "tags": [ "Number Portout" ], "parameters": [ { "name": "id", "in": "path", "description": "Portout id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "description": "List of supporting documents parameters", "minItems": 1, "maxItems": 10, "items": { "type": "object", "required": [ "type", "document_id" ], "properties": { "type": { "type": "string", "enum": [ "loa", "invoice" ], "description": "Identifies the type of the document", "example": "loa" }, "document_id": { "format": "uuid", "type": "string", "description": "Identifies the associated document", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } } } } } } } }, "responses": { "201": { "$ref": "#/components/responses/CreatePortOutSupportingDocumentsResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/portouts/{id}/{status}": { "patch": { "summary": "Update Status", "description": "Authorize or reject portout request", "operationId": "UpdatePortoutStatus", "tags": [ "Number Portout" ], "parameters": [ { "name": "id", "in": "path", "description": "Portout id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "description": "Updated portout status", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "authorized", "rejected-pending" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "description": "Provide a reason if rejecting the port out request", "type": "string", "example": "I do not recognize this transaction" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/PortoutResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Unprocessable entity. Check message field in response for details." } }, "x-latency-category": "responsive" } }, "/private_wireless_gateways": { "get": { "summary": "Get all Private Wireless Gateways", "description": "Get all Private Wireless Gateways belonging to the user.", "operationId": "GetPrivateWirelessGateways", "tags": [ "Private Wireless Gateways" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[name]", "description": "The name of the Private Wireless Gateway.", "in": "query", "required": false, "schema": { "type": "string" }, "example": "my private gateway" }, { "name": "filter[ip_range]", "description": "The IP address range of the Private Wireless Gateway.", "in": "query", "required": false, "schema": { "type": "string" }, "example": "192.168.0.0/24" }, { "name": "filter[region_code]", "description": "The name of the region where the Private Wireless Gateway is deployed.", "in": "query", "required": false, "schema": { "type": "string" }, "example": "ashburn-va" }, { "name": "filter[created_at]", "description": "Private Wireless Gateway resource creation date.", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2018-02-02T22:25:27.521Z" }, { "name": "filter[updated_at]", "description": "When the Private Wireless Gateway was last updated.", "in": "query", "required": false, "schema": { "type": "string" }, "example": "2018-02-02T22:25:27.521Z" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllPrivateWirelessGatewaysResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "x-latency-category": "background", "summary": "Create a Private Wireless Gateway", "description": "Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network.", "operationId": "CreatePrivateWirelessGateway", "tags": [ "Private Wireless Gateways" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "network_id": { "description": "The identification of the related network resource.", "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "name": { "description": "The private wireless gateway name.", "type": "string", "example": "My private wireless gateway" } }, "required": [ "network_id", "name" ] } } } }, "responses": { "202": { "$ref": "#/components/responses/CreatePrivateWirelessGatewayResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/private_wireless_gateways/{id}": { "delete": { "summary": "Delete a Private Wireless Gateway", "description": "Deletes the Private Wireless Gateway.", "operationId": "DeleteWirelessGateway", "tags": [ "Private Wireless Gateways" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/DeletePrivateWirelessGatewayResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Get a Private Wireless Gateway", "description": "Retrieve information about a Private Wireless Gateway.", "operationId": "GetPrivateWirelessGateway", "tags": [ "Private Wireless Gateways" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GetPrivateWirelessGatewayResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/public_internet_gateways": { "get": { "summary": "List all Public Internet Gateways", "description": "List all Public Internet Gateways.", "operationId": "ListPublicInternetGateways", "tags": [ "Public Internet Gateways" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[network_id]", "description": "The associated network id to filter on.", "in": "query", "required": false, "schema": { "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } } ], "responses": { "200": { "$ref": "#/components/responses/PublicInternetGatewayListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a Public Internet Gateway", "description": "Create a new Public Internet Gateway.", "operationId": "CreatePublicInternetGateway", "tags": [ "Public Internet Gateways" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInternetGatewayCreate" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/PublicInternetGatewayResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/public_internet_gateways/{id}": { "delete": { "summary": "Delete a Public Internet Gateway", "description": "Delete a Public Internet Gateway.", "operationId": "DeletePublicInternetGateway", "tags": [ "Public Internet Gateways" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/PublicInternetGatewayResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a Public Internet Gateway", "description": "Retrieve a Public Internet Gateway.", "operationId": "GetPublicInternetGateway", "tags": [ "Public Internet Gateways" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/PublicInternetGatewayResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/queues/{queue_name}": { "get": { "summary": "Retrieve a call queue", "description": "Retrieve an existing call queue", "operationId": "RetrieveCallQueue", "tags": [ "Queue Commands" ], "parameters": [ { "name": "queue_name", "description": "Uniquely identifies the queue by name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/QueueResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "interactive" } }, "/queues/{queue_name}/calls": { "get": { "summary": "Retrieve calls from a queue", "description": "Retrieve the list of calls in an existing queue", "operationId": "ListQueueCalls", "tags": [ "Queue Commands" ], "parameters": [ { "name": "queue_name", "description": "Uniquely identifies the queue by name", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListQueueCallsResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "interactive" } }, "/queues/{queue_name}/calls/{call_control_id}": { "get": { "summary": "Retrieve a call from a queue", "description": "Retrieve an existing call from an existing queue", "operationId": "RetrieveCallFromQueue", "tags": [ "Queue Commands" ], "parameters": [ { "name": "queue_name", "description": "Uniquely identifies the queue by name", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/CallControlId" } ], "responses": { "200": { "$ref": "#/components/responses/QueueCallResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "interactive" } }, "/recordings": { "get": { "summary": "List all call recordings", "description": "Returns a list of your call recordings.", "operationId": "GetRecordings", "tags": [ "Call Recordings" ], "responses": { "200": { "$ref": "#/components/responses/RecordingsResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/recordings/actions/delete": { "delete": { "summary": "Deletes a list of call recordings", "description": "Permanently deletes a list of call recordings.", "operationId": "DeleteRecordings", "tags": [ "Call Recordings" ], "requestBody": { "$ref": "#/components/requestBodies/DeleteRecordingsRequest" }, "responses": { "204": { "description": "The recordings have been successfully deleted." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/recordings/{id}": { "get": { "description": "Retrieve a recording from the authenticated user's recordings", "summary": "Retrieve a recording", "operationId": "RetrieveRecording", "tags": [ "Recordings Commands" ], "parameters": [ { "name": "id", "description": "Uniquely identifies the recording", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/RecordingResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "interactive" } }, "/recordings/{recording_id}": { "delete": { "summary": "Delete a call recording", "description": "Permanently deletes a call recording.", "operationId": "DeleteRecording", "tags": [ "Call Recordings" ], "parameters": [ { "$ref": "#/components/parameters/RecordingId" } ], "responses": { "200": { "$ref": "#/components/responses/RecordingResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve call recording", "description": "Retrieves the details of an existing call recording.", "operationId": "GetRecording", "tags": [ "Call Recordings" ], "parameters": [ { "$ref": "#/components/parameters/RecordingId" } ], "responses": { "200": { "$ref": "#/components/responses/RecordingResponseBody" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/regions": { "get": { "summary": "List all Regions", "description": "List all regions and the interfaces that region supports", "operationId": "ListRegions", "tags": [ "Regions" ], "responses": { "200": { "$ref": "#/components/responses/RegionListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/reports/batch_mdr_reports": { "get": { "tags": [ "MDR Detail Reports" ], "description": "Fetch all previous requests for messaging detail reports. Messaging detail reports are reports for pulling all messaging records. ", "operationId": "GetCdrRequests", "parameters": [ { "name": "page[number]", "in": "query", "description": "Page number", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "page[size]", "in": "query", "description": "Size of the page", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrGetDetailReportResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "interactive" }, "post": { "tags": [ "MDR Detail Reports" ], "description": "Submit a request for new messaging detail report. Messaging detail report pulls all raw messaging data according to defined filters.", "operationId": "SubmitMdrRequest", "requestBody": { "description": "Mdr detail request data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrPostDetailReportRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrPostDetailReportResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "background" } }, "/reports/batch_mdr_reports/{id}": { "delete": { "tags": [ "MDR Detail Reports" ], "description": "Delete generated messaging detail report by id", "operationId": "DeleteMdrRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrDeleteDetailReportResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "interactive" }, "get": { "tags": [ "MDR Detail Reports" ], "description": "Fetch single messaging detail report by id.", "operationId": "GetMdrRequest", "parameters": [ { "name": "id", "in": "path", "required": true, "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrGetDetailReportByIdResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "interactive" } }, "/reports/cdr_usage_reports/sync": { "get": { "tags": [ "CDR Usage Reports" ], "description": "Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes. ", "operationId": "GetUsageReportSync", "parameters": [ { "name": "start_date", "in": "query", "schema": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" } }, { "name": "end_date", "in": "query", "schema": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" } }, { "name": "aggregation_type", "in": "query", "required": true, "schema": { "type": "string", "example": "no_aggregation", "enum": [ "NO_AGGREGATION", "CONNECTION", "TAG", "BILLING_GROUP" ] } }, { "name": "product_breakdown", "in": "query", "required": true, "schema": { "type": "string", "example": "no_breakdown", "enum": [ "NO_BREAKDOWN", "DID_VS_TOLL_FREE", "COUNTRY", "DID_VS_TOLL_FREE_PER_COUNTRY" ] } }, { "name": "connections", "in": "query", "schema": { "type": "array", "example": 1234567890123, "items": { "type": "number", "example": 1234567890123 } } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CdrGetSyncUsageReportResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "background" } }, "/reports/mdr_usage_reports": { "get": { "tags": [ "MDR Usage Reports" ], "description": "Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown", "operationId": "GetUsageReports", "parameters": [ { "name": "page[number]", "in": "query", "description": "Page number", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "page[size]", "in": "query", "description": "Size of the page", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrGetUsageReportsResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "interactive" }, "post": { "tags": [ "MDR Usage Reports" ], "description": "Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period. ", "operationId": "SubmitUsageReport", "requestBody": { "description": "Mdr usage report data", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/MdrPostUsageReportRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrPostUsageReportsResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "background" } }, "/reports/mdr_usage_reports/sync": { "get": { "tags": [ "MDR Usage Reports" ], "description": "Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes. ", "operationId": "GetUsageReportSync", "parameters": [ { "name": "start_date", "in": "query", "schema": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" } }, { "name": "end_date", "in": "query", "schema": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" } }, { "name": "aggregation_type", "in": "query", "required": true, "schema": { "type": "string", "example": "profile", "enum": [ "NO_AGGREGATION", "PROFILE", "TAGS" ] } }, { "name": "profiles", "in": "query", "schema": { "type": "array", "example": "My profile", "items": { "type": "string", "example": "My profile" } } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrGetSyncUsageReportResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "background" } }, "/reports/mdr_usage_reports/{id}": { "delete": { "tags": [ "MDR Usage Reports" ], "description": "Delete messaging usage report by id", "operationId": "DeleteUsageReport", "parameters": [ { "name": "id", "in": "path", "required": true, "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrDeleteUsageReportsResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "interactive" }, "get": { "tags": [ "MDR Usage Reports" ], "description": "Fetch a single messaging usage report by id", "operationId": "GetUsageReport", "parameters": [ { "name": "id", "in": "path", "required": true, "content": { "*/*": { "schema": { "type": "string", "format": "uuid" } } } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrGetUsageReportsByIdResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "interactive" } }, "/reports/mdrs": { "get": { "tags": [ "MDR Detail Reports" ], "description": "Fetch all Mdr records ", "operationId": "GetPaginatedMdrs", "parameters": [ { "name": "start_date", "in": "query", "description": "Pagination start date", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "Pagination end date", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string", "description": "Message uuid", "example": "e093fbe0-5bde-11eb-ae93-0242ac130002" } }, { "name": "direction", "in": "query", "schema": { "type": "string", "description": "Direction (inbound or outbound)", "example": "INBOUND", "enum": [ "INBOUND", "OUTBOUND" ] } }, { "name": "profile", "in": "query", "schema": { "type": "string", "description": "Name of the profile", "example": "My profile" } }, { "name": "cld", "in": "query", "schema": { "type": "string", "description": "Destination number", "example": "+15551237654" } }, { "name": "cli", "in": "query", "schema": { "type": "string", "description": "Origination number", "example": "+15551237654" } }, { "name": "status", "in": "query", "schema": { "type": "string", "description": "Message status", "example": "DELIVERED", "enum": [ "GW_TIMEOUT", "DELIVERED", "DLR_UNCONFIRMED", "DLR_TIMEOUT", "RECEIVED", "GW_REJECT", "FAILED" ] } }, { "name": "message_type", "in": "query", "schema": { "type": "string", "description": "Type of message", "example": "SMS", "enum": [ "SMS", "MMS" ] } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MdrGetDetailResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "interactive" } }, "/reports/wdrs": { "get": { "tags": [ "WDR Detail Reports" ], "description": "Fetch all Wdr records ", "operationId": "GetPaginatedWdrs", "parameters": [ { "name": "start_date", "in": "query", "description": "Start date", "schema": { "type": "string", "example": "2021-05-01T00:00:00Z" } }, { "name": "end_date", "in": "query", "description": "End date", "schema": { "type": "string", "example": "2021-06-01T00:00:00Z" } }, { "name": "id", "in": "query", "schema": { "type": "string", "description": "WDR uuid", "example": "e093fbe0-5bde-11eb-ae93-0242ac130002" } }, { "name": "mcc", "in": "query", "schema": { "type": "string", "description": "Mobile country code", "example": "204" } }, { "name": "mnc", "in": "query", "schema": { "type": "string", "description": "Mobile network code", "example": "01" } }, { "name": "imsi", "in": "query", "schema": { "type": "string", "description": "International mobile subscriber identity", "example": "123456" } }, { "name": "sim_group_name", "in": "query", "schema": { "type": "string", "description": "Sim group name", "example": "sim name" } }, { "name": "sim_group_id", "in": "query", "schema": { "type": "string", "description": "Sim group unique identifier", "example": "f05a189f-7c46-4531-ac56-1460dc465a42" } }, { "name": "sim_card_id", "in": "query", "schema": { "type": "string", "description": "Sim card unique identifier", "example": "877f80a6-e5b2-4687-9a04-88076265720f" } }, { "name": "phone_number", "in": "query", "schema": { "type": "string", "description": "Phone number", "example": "+12345678910" } }, { "name": "page[number]", "in": "query", "description": "Page number", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "page[size]", "in": "query", "description": "Size of the page", "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "sort", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "description": "Field used to order the data. If no field is specified, default value is 'created_at'", "example": "created_at", "default": "created_at" } } ], "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalWdrGetDetailResponse" } } } } }, "x-latency-category": "interactive" } }, "/requirement_types": { "get": { "summary": "List all requirement types", "description": "List all requirement types ordered by created_at descending", "operationId": "ListRequirementTypes", "x-latency-category": "responsive", "tags": [ "Requirement Types" ], "parameters": [ { "$ref": "#/components/parameters/DocReqsRequirementTypeNameFilter" }, { "$ref": "#/components/parameters/DocReqsRequirementTypesSort" } ], "responses": { "200": { "$ref": "#/components/responses/DocReqsListRequirementTypesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/requirement_types/{id}": { "get": { "summary": "Retrieve a requirement types", "description": "Retrieve a requirement type by id", "operationId": "RetrieveRequirementType", "x-latency-category": "responsive", "tags": [ "Requirement Types" ], "parameters": [ { "$ref": "#/components/parameters/DocReqsRequirementTypeId" } ], "responses": { "200": { "$ref": "#/components/responses/DocReqsRequirementTypeResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/requirements": { "get": { "summary": "List all requirements", "description": "List all requirements with filtering, sorting, and pagination", "operationId": "ListRequirements", "x-latency-category": "responsive", "tags": [ "Requirements" ], "parameters": [ { "$ref": "#/components/parameters/DocReqsCountryFilter" }, { "$ref": "#/components/parameters/DocReqsPhoneNumberTypeFilter" }, { "$ref": "#/components/parameters/DocReqsActionFilter" }, { "$ref": "#/components/parameters/DocReqsRequirementsSort" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListRequirementsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/requirements/{id}": { "get": { "summary": "Retrieve a document requirement", "description": "Retrieve a document requirement record", "operationId": "RetrieveDocumentRequirements", "x-latency-category": "responsive", "tags": [ "Requirements" ], "parameters": [ { "$ref": "#/components/parameters/DocReqsRequirementId" } ], "responses": { "200": { "$ref": "#/components/responses/DocReqsRequirementResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/room_compositions": { "get": { "summary": "View a list of room compositions.", "description": "", "operationId": "ListRoomCompositions", "x-endpoint-cost": "medium", "tags": [ "Room Compositions" ], "parameters": [ { "name": "filter[date_created_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room compositions created on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_created_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room compositions created after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_created_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room compositions created before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[session_id]", "in": "query", "description": "The session_id for filtering room compositions.", "schema": { "type": "string", "format": "uuid", "example": "92e7d459-bcc5-4386-9f5f-6dd14a82588d" } }, { "name": "filter[status]", "in": "query", "description": "The status for filtering room compositions.", "schema": { "type": "string", "example": "completed", "enum": [ "completed", "processing", "enqueued" ] } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "$ref": "#/components/responses/ListRoomCompositionsResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a room composition.", "description": "Asynchronously create a room composition.", "operationId": "CreateRoomComposition", "tags": [ "Room Compositions" ], "x-endpoint-cost": "heavy", "requestBody": { "description": "Parameters that can be defined during room composition creation.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRoomCompositionRequest" } } } }, "responses": { "202": { "$ref": "#/components/responses/CreateRoomCompositionResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" } }, "x-latency-category": "responsive" } }, "/room_compositions/{room_composition_id}": { "delete": { "summary": "Delete a room composition.", "description": "Synchronously delete a room composition.", "operationId": "DeleteRoomComposition", "tags": [ "Room Compositions" ], "x-endpoint-cost": "medium", "parameters": [ { "name": "room_composition_id", "in": "path", "description": "The unique identifier of a room composition.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5219b3af-87c6-4c08-9b58-5a533d893e21" } } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "x-latency-category": "responsive" }, "get": { "summary": "View a room composition.", "operationId": "ViewRoomComposition", "tags": [ "Room Compositions" ], "x-endpoint-cost": "light", "parameters": [ { "name": "room_composition_id", "in": "path", "description": "The unique identifier of a room composition.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "5219b3af-87c6-4c08-9b58-5a533d893e21" } } ], "responses": { "200": { "$ref": "#/components/responses/GetRoomCompositionResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "x-latency-category": "responsive" } }, "/room_participants": { "get": { "summary": "View a list of room participants.", "description": "", "operationId": "ListRoomParticipants", "x-endpoint-cost": "medium", "tags": [ "Room Participants" ], "parameters": [ { "name": "filter[date_joined_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room participants that joined on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_joined_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room participants that joined after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_joined_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room participants that joined before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room participants updated on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room participants updated after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room participants updated before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_left_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room participants that left on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_left_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room participants that left after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_left_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room participants that left before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[context]", "in": "query", "description": "Filter room participants based on the context.", "schema": { "type": "string", "example": "Alice" } }, { "name": "filter[session_id]", "in": "query", "description": "Session_id for filtering room participants.", "schema": { "type": "string", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "$ref": "#/components/responses/ListRoomParticipantsResponse" } }, "x-latency-category": "responsive" } }, "/room_participants/{room_participant_id}": { "get": { "summary": "View a room participant.", "operationId": "ViewRoomParticipant", "tags": [ "Room Participants" ], "x-endpoint-cost": "light", "parameters": [ { "name": "room_participant_id", "in": "path", "description": "The unique identifier of a room participant.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "responses": { "200": { "$ref": "#/components/responses/GetRoomParticipantResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "x-latency-category": "responsive" } }, "/room_recordings": { "delete": { "summary": "Delete several room recordings in a bulk.", "description": "", "operationId": "DeleteRoomRecordings", "x-endpoint-cost": "heavy", "tags": [ "Room Recordings" ], "parameters": [ { "name": "filter[date_ended_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room recordings ended on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room recordings ended after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room recordings ended before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_started_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room recordings started on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_started_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room recordings started after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_started_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room recordings started before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[room_id]", "in": "query", "description": "room_id for filtering room recordings.", "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[participant_id]", "in": "query", "description": "participant_id for filtering room recordings.", "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[session_id]", "in": "query", "description": "session_id for filtering room recordings.", "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[status]", "in": "query", "description": "status for filtering room recordings.", "schema": { "type": "string", "example": "completed" } }, { "name": "filter[type]", "in": "query", "description": "type for filtering room recordings.", "schema": { "type": "string", "example": "audio" } }, { "name": "filter[duration_secs][eq]", "in": "query", "description": "duration_secs equal for filtering room recordings.", "schema": { "type": "integer", "example": 20 } }, { "name": "filter[duration_secs][lte]", "in": "query", "description": "duration_secs less or equal for filtering room recordings.", "schema": { "type": "integer", "example": 20 } }, { "name": "filter[duration_secs][gte]", "in": "query", "description": "duration_secs greater or equal for filtering room recordings.", "schema": { "type": "integer", "example": 20 } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "201": { "$ref": "#/components/responses/BulkDeleteRoomRecordingsResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" } }, "x-latency-category": "responsive" }, "get": { "summary": "View a list of room recordings.", "description": "", "operationId": "ListRoomRecordings", "x-endpoint-cost": "medium", "tags": [ "Room Recordings" ], "parameters": [ { "name": "filter[date_ended_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room recordings ended on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room recordings ended after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room recordings ended before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_started_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room recordings started on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_started_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room recordings started after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_started_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room recordings started before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[room_id]", "in": "query", "description": "room_id for filtering room recordings.", "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[participant_id]", "in": "query", "description": "participant_id for filtering room recordings.", "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[session_id]", "in": "query", "description": "session_id for filtering room recordings.", "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[status]", "in": "query", "description": "status for filtering room recordings.", "schema": { "type": "string", "example": "completed" } }, { "name": "filter[type]", "in": "query", "description": "type for filtering room recordings.", "schema": { "type": "string", "example": "audio" } }, { "name": "filter[duration_secs][eq]", "in": "query", "description": "duration_secs equal for filtering room recordings.", "schema": { "type": "integer", "example": 20 } }, { "name": "filter[duration_secs][lte]", "in": "query", "description": "duration_secs less or equal for filtering room recordings.", "schema": { "type": "integer", "example": 20 } }, { "name": "filter[duration_secs][gte]", "in": "query", "description": "duration_secs greater or equal for filtering room recordings.", "schema": { "type": "integer", "example": 20 } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "$ref": "#/components/responses/ListRoomRecordingsResponse" } }, "x-latency-category": "responsive" } }, "/room_recordings/{room_recording_id}": { "delete": { "summary": "Delete a room recording.", "description": "Synchronously delete a Room Recording.", "operationId": "DeleteRoomRecording", "tags": [ "Room Recordings" ], "x-endpoint-cost": "medium", "parameters": [ { "name": "room_recording_id", "in": "path", "description": "The unique identifier of a room recording.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "x-latency-category": "responsive" }, "get": { "summary": "View a room recording.", "operationId": "ViewRoomRecording", "tags": [ "Room Recordings" ], "x-endpoint-cost": "light", "parameters": [ { "name": "room_recording_id", "in": "path", "description": "The unique identifier of a room recording.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "responses": { "200": { "$ref": "#/components/responses/GetRoomRecordingResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "x-latency-category": "responsive" } }, "/room_sessions": { "get": { "summary": "View a list of room sessions.", "description": "", "operationId": "ListRoomSessions", "x-endpoint-cost": "medium", "tags": [ "Room Sessions" ], "parameters": [ { "name": "filter[date_created_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room sessions created on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_created_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room sessions created after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_created_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room sessions created before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room sessions updated on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room sessions updated after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room sessions updated before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room sessions ended on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room sessions ended after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room sessions ended before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[room_id]", "in": "query", "description": "Room_id for filtering room sessions.", "schema": { "type": "string", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[active]", "in": "query", "description": "Filter active or inactive room sessions.", "schema": { "type": "boolean", "example": true } }, { "name": "include_participants", "in": "query", "description": "To decide if room participants should be included in the response.", "schema": { "type": "boolean", "example": true } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "$ref": "#/components/responses/ListRoomSessionsResponse" } }, "x-latency-category": "responsive" } }, "/room_sessions/{room_session_id}": { "get": { "summary": "View a room session.", "operationId": "ViewRoomSession", "tags": [ "Room Sessions" ], "x-endpoint-cost": "light", "parameters": [ { "name": "room_session_id", "in": "path", "description": "The unique identifier of a room session.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "include_participants", "in": "query", "description": "To decide if room participants should be included in the response.", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "$ref": "#/components/responses/GetRoomSessionResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "x-latency-category": "responsive" } }, "/room_sessions/{room_session_id}/actions/end": { "post": { "summary": "End a room session.", "description": "Note: this will also kick all participants currently present in the room", "operationId": "EndSession", "x-endpoint-cost": "medium", "tags": [ "Room Sessions" ], "security": [], "parameters": [ { "name": "room_session_id", "in": "path", "description": "The unique identifier of a room session.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "responses": { "200": { "$ref": "#/components/responses/ActionSuccessResponse" } }, "x-latency-category": "responsive" } }, "/room_sessions/{room_session_id}/actions/kick": { "post": { "summary": "Kick participants from a room session.", "description": "", "operationId": "KickParticipantInSession", "x-endpoint-cost": "medium", "tags": [ "Room Sessions" ], "security": [], "parameters": [ { "name": "room_session_id", "in": "path", "description": "The unique identifier of a room session.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "requestBody": { "description": "Parameters that can be defined during Kick action.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsParticipantsRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ActionSuccessResponse" } }, "x-latency-category": "responsive" } }, "/room_sessions/{room_session_id}/actions/mute": { "post": { "summary": "Mute participants in room session.", "description": "", "operationId": "MuteParticipantInSession", "x-endpoint-cost": "medium", "tags": [ "Room Sessions" ], "security": [], "parameters": [ { "name": "room_session_id", "in": "path", "description": "The unique identifier of a room session.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "requestBody": { "description": "Parameters that can be defined during Mute action.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsParticipantsRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ActionSuccessResponse" } }, "x-latency-category": "responsive" } }, "/room_sessions/{room_session_id}/actions/unmute": { "post": { "summary": "Unmute participants in room session.", "description": "", "operationId": "UnmuteParticipantInSession", "x-endpoint-cost": "medium", "tags": [ "Room Sessions" ], "security": [], "parameters": [ { "name": "room_session_id", "in": "path", "description": "The unique identifier of a room session.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "requestBody": { "description": "Parameters that can be defined during Unmute action.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsParticipantsRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ActionSuccessResponse" } }, "x-latency-category": "responsive" } }, "/room_sessions/{room_session_id}/participants": { "get": { "summary": "View a list of room participants.", "description": "", "operationId": "ListRoomParticipants", "x-endpoint-cost": "medium", "tags": [ "Room Sessions" ], "parameters": [ { "name": "room_session_id", "in": "path", "description": "The unique identifier of a room session.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[date_joined_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room participants that joined on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_joined_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room participants that joined after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_joined_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room participants that joined before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room participants updated on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room participants updated after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room participants updated before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_left_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room participants that left on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_left_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room participants that left after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_left_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room participants that left before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[context]", "in": "query", "description": "Filter room participants based on the context.", "schema": { "type": "string", "example": "Alice" } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "$ref": "#/components/responses/ListRoomParticipantsResponse" } }, "x-latency-category": "responsive" } }, "/rooms": { "get": { "summary": "View a list of rooms.", "description": "", "operationId": "ListRooms", "x-endpoint-cost": "medium", "tags": [ "Rooms" ], "parameters": [ { "name": "filter[date_created_at][eq]", "in": "query", "description": "ISO 8601 date for filtering rooms created on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_created_at][gte]", "in": "query", "description": "ISO 8601 date for filtering rooms created after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_created_at][lte]", "in": "query", "description": "ISO 8601 date for filtering rooms created before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][eq]", "in": "query", "description": "ISO 8601 date for filtering rooms updated on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][gte]", "in": "query", "description": "ISO 8601 date for filtering rooms updated after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][lte]", "in": "query", "description": "ISO 8601 date for filtering rooms updated before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[unique_name]", "in": "query", "description": "Unique_name for filtering rooms.", "schema": { "type": "string", "example": "my_video_room" } }, { "name": "include_sessions", "in": "query", "description": "To decide if room sessions should be included in the response.", "schema": { "type": "boolean", "example": true } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "$ref": "#/components/responses/ListRoomsResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a room.", "description": "Synchronously create a Room.", "operationId": "CreateRoom", "tags": [ "Rooms" ], "x-endpoint-cost": "medium", "requestBody": { "description": "Parameters that can be defined during room creation.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRoomRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/CreateRoomResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" } }, "x-latency-category": "responsive" } }, "/rooms/{room_id}": { "delete": { "summary": "Delete a room.", "description": "Synchronously delete a Room. Participants from that room will be kicked out, they won't be able to join that room anymore, and you won't be charged anymore for that room.", "operationId": "DeleteRoom", "tags": [ "Rooms" ], "x-endpoint-cost": "medium", "parameters": [ { "name": "room_id", "in": "path", "description": "The unique identifier of a room.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "x-latency-category": "responsive" }, "get": { "summary": "View a room.", "operationId": "ViewRoom", "tags": [ "Rooms" ], "x-endpoint-cost": "light", "parameters": [ { "name": "room_id", "in": "path", "description": "The unique identifier of a room.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "include_sessions", "in": "query", "description": "To decide if room sessions should be included in the response.", "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "$ref": "#/components/responses/GetRoomResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a room.", "description": "Synchronously update a Room.", "operationId": "UpdateRoom", "tags": [ "Rooms" ], "x-endpoint-cost": "medium", "parameters": [ { "name": "room_id", "in": "path", "description": "The unique identifier of a room.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "requestBody": { "description": "Parameters that can be defined during room update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchRoomRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/PatchRoomResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/rooms/{room_id}/actions/generate_join_client_token": { "post": { "summary": "Create Client Token to join a room.", "description": "Synchronously create an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after `token_ttl_secs`, a Refresh Token is also provided to refresh a Client Token, the Refresh Token expires after `refresh_token_ttl_secs`.", "operationId": "CreateRoomClientToken", "tags": [ "Rooms Client Tokens" ], "x-endpoint-cost": "medium", "parameters": [ { "name": "room_id", "in": "path", "description": "The unique identifier of a room.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "requestBody": { "description": "Parameters that can be defined during Room Client Token creation.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRoomClientTokenRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/CreateRoomClientTokenResponse" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "x-latency-category": "responsive" } }, "/rooms/{room_id}/actions/refresh_client_token": { "post": { "summary": "Refresh Client Token to join a room.", "description": "Synchronously refresh an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after `token_ttl_secs`.", "operationId": "RefreshRoomClientToken", "tags": [ "Rooms Client Tokens" ], "x-endpoint-cost": "light", "security": [], "parameters": [ { "name": "room_id", "in": "path", "description": "The unique identifier of a room.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } } ], "requestBody": { "description": "Parameters that can be defined during Room Client Token refresh.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshRoomClientTokenRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/RefreshRoomClientTokenResponse" }, "403": { "$ref": "#/components/responses/Forbidden" } }, "x-latency-category": "responsive" } }, "/rooms/{room_id}/sessions": { "get": { "summary": "View a list of room sessions.", "description": "", "operationId": "ListRoomSessions", "x-endpoint-cost": "medium", "tags": [ "Rooms" ], "parameters": [ { "name": "room_id", "in": "path", "description": "The unique identifier of a room.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" } }, { "name": "filter[date_created_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room sessions created on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_created_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room sessions created after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_created_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room sessions created before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room sessions updated on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room sessions updated after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_updated_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room sessions updated before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][eq]", "in": "query", "description": "ISO 8601 date for filtering room sessions ended on that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][gte]", "in": "query", "description": "ISO 8601 date for filtering room sessions ended after that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[date_ended_at][lte]", "in": "query", "description": "ISO 8601 date for filtering room sessions ended before that date.", "schema": { "type": "string", "format": "date", "example": "2021-04-25" } }, { "name": "filter[active]", "in": "query", "description": "Filter active or inactive room sessions.", "schema": { "type": "boolean", "example": true } }, { "name": "include_participants", "in": "query", "description": "To decide if room participants should be included in the response.", "schema": { "type": "boolean", "example": true } }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageNumber" } ], "responses": { "200": { "$ref": "#/components/responses/ListRoomSessionsResponse" } }, "x-latency-category": "responsive" } }, "/short_codes": { "get": { "summary": "List short codes", "operationId": "ListShortCodes", "tags": [ "Short Codes" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[messaging_profile_id]", "in": "query", "description": "Filter by Messaging Profile ID. Use the string `null` for phone numbers without assigned profiles. A synonym for the `/messaging_profiles/{id}/short_codes` endpoint when querying about an extant profile.", "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/ListShortCodesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/short_codes/{id}": { "get": { "summary": "Retrieve a short code", "operationId": "RetrieveShortCode", "tags": [ "Short Codes" ], "parameters": [ { "$ref": "#/components/parameters/ShortCodeId" } ], "responses": { "200": { "$ref": "#/components/responses/ShortCodeResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update short code", "operationId": "UpdateShortCode", "description": "Update the settings for a specific short code. To unbind a short code from a profile, set the `messaging_profile_id` to `null` or an empty string.", "tags": [ "Short Codes" ], "parameters": [ { "$ref": "#/components/parameters/ShortCodeId" } ], "requestBody": { "description": "Short code update", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShortCodeRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/ShortCodeResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_card_actions": { "get": { "operationId": "ListSimCardActions", "summary": "List SIM card actions", "description": "This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.", "tags": [ "SIM Card Actions" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterSIMCardId" }, { "$ref": "#/components/parameters/FilterBasicStatusLifecycle" }, { "$ref": "#/components/parameters/FilterBulkSIMCardActionId" }, { "name": "filter[action_type]", "description": "Filter by action type.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "enable", "enable_standby_sim_card", "disable", "set_standby", "remove_public_ip", "set_public_ip" ], "example": "disable" } } ], "responses": { "200": { "$ref": "#/components/responses/SimCardActionCollectionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_card_actions/{id}": { "get": { "operationId": "GetSimCardAction", "summary": "Get SIM card action details", "description": "This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.", "tags": [ "SIM Card Actions" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/SIMCardActionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_card_data_usage_notifications": { "get": { "x-latency-category": "background", "operationId": "ListDataUsageNotifications", "summary": "List SIM card data usage notifications", "description": "Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters.", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterSIMCardId" } ], "responses": { "200": { "$ref": "#/components/responses/SimCardDataUsageNotificationCollectionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } }, "post": { "operationId": "PostSimCardDataUsageNotification", "summary": "Create a new SIM card data usage notification", "description": "Creates a new SIM card data usage notification.", "tags": [ "SIM Cards" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sim_card_id": { "type": "string", "format": "uuid", "description": "The identification UUID of the related SIM card resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "threshold": { "type": "object", "description": "Data usage threshold that will trigger the notification.", "properties": { "amount": { "type": "string", "format": "decimal", "example": "2048.1" }, "unit": { "type": "string", "example": "MB", "enum": [ "MB", "GB" ] } } } }, "required": [ "sim_card_id", "threshold" ] } } } }, "responses": { "201": { "$ref": "#/components/responses/CreateSimCardDataUsageNotificationResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_card_data_usage_notifications/{id}": { "delete": { "operationId": "DeleteSimCardDataUsageNotifications", "summary": "Delete SIM card data usage notifications", "description": "Delete the SIM Card Data Usage Notification.", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/DeleteSimCardDataUsageNotificationResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "x-latency-category": "background", "operationId": "GetSimCardDataUsageNotification", "summary": "Get a single SIM card data usage notification", "description": "Get a single SIM Card Data Usage Notification.", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GetSimCardDataUsageNotificationResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } }, "patch": { "operationId": "PatchSimCardDataUsageNotification", "summary": "Updates information for a SIM Card Data Usage Notification", "description": "Updates information for a SIM Card Data Usage Notification.", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimCardDataUsageNotification" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/UpdateSimCardDataUsageNotificationResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_card_group_actions": { "get": { "operationId": "GetSimCardGroupActions", "summary": "List SIM card group actions", "description": "This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.", "tags": [ "SIM Card Group Actions" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/FilterSIMCardGroupId" }, { "$ref": "#/components/parameters/FilterBasicStatusLifecycle" }, { "name": "filter[type]", "description": "Filter by action type.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "set_private_wireless_gateway", "remove_private_wireless_gateway" ], "example": "set_private_wireless_gateway" } } ], "responses": { "200": { "$ref": "#/components/responses/SimCardGroupActionCollectionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_card_group_actions/{id}": { "get": { "operationId": "GetSimCardGroupAction", "summary": "Get SIM card group action details", "description": "This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.", "tags": [ "SIM Card Group Actions" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/SIMCardGroupActionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_card_groups": { "get": { "tags": [ "SIM Card Groups" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[name]", "description": "A valid SIM card group name.", "schema": { "format": "uuid", "type": "string", "example": "My Test Group" }, "in": "query" }, { "name": "filter[private_wireless_gateway_id]", "description": "A Private Wireless Gateway ID associated with the group.", "schema": { "format": "uuid", "type": "string", "example": "7606c6d3-ff7c-49c1-943d-68879e9d584d" }, "in": "query" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllSimCardGroupsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "operationId": "GetAllSimCardGroups", "summary": "Get all SIM card groups", "description": "Get all SIM card groups belonging to the user that match the given filters.", "x-latency-category": "responsive" }, "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIMCardGroupCreate" } } }, "required": true }, "tags": [ "SIM Card Groups" ], "responses": { "200": { "$ref": "#/components/responses/CreateSimCardGroupResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "operationId": "CreateSimCardGroup", "summary": "Create a SIM card group", "description": "Creates a new SIM card group object", "x-latency-category": "responsive" } }, "/sim_card_groups/{id}": { "delete": { "tags": [ "SIM Card Groups" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/DeleteSimCardGroupResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "operationId": "DeleteSimCardGroup", "summary": "Delete a SIM card group", "description": "Permanently deletes a SIM card group", "x-latency-category": "responsive" }, "get": { "tags": [ "SIM Card Groups" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GetSimCardGroupResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "operationId": "GetSimCardGroup", "summary": "Get SIM card group", "description": "Returns the details regarding a specific SIM card group", "x-latency-category": "responsive" }, "patch": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIMCardGroupPatch" } } }, "required": true }, "tags": [ "SIM Card Groups" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/UpdateSimCardGroupResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "operationId": "UpdateSimCardGroup", "summary": "Update a SIM card group", "description": "Updates a SIM card group", "x-latency-category": "responsive" } }, "/sim_card_groups/{id}/actions/remove_private_wireless_gateway": { "post": { "x-latency-category": "background", "summary": "Request Private Wireless Gateway removal from SIM card group", "description": "This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic handled by Telnyx's default mobile network configuration.", "operationId": "RemoveSimCardGroupPrivateWirelessGateway", "tags": [ "SIM Card Groups" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/SIMCardGroupActionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_card_groups/{id}/actions/set_private_wireless_gateway": { "post": { "x-latency-category": "background", "summary": "Request Private Wireless Gateway assignment for SIM card group", "description": "This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic controlled by the associated Private Wireless Gateway. This operation will also imply that new SIM cards assigned to a group will inherit its network definitions. If it's moved to a different group that doesn't have a Private Wireless Gateway, it'll use Telnyx's default mobile network configuration.", "operationId": "SetPrivateWirelessGatewayForSimCardGroup", "tags": [ "SIM Card Groups" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "private_wireless_gateway_id": { "description": "The identification of the related Private Wireless Gateway resource.", "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "required": [ "private_wireless_gateway_id" ] } } } }, "responses": { "202": { "$ref": "#/components/responses/SIMCardGroupActionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_card_order_preview": { "post": { "summary": "Preview SIM card orders", "description": "Preview SIM card order purchases.", "operationId": "PreviewSimCardOrders", "tags": [ "SIM Card Orders" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "quantity", "address_id" ], "properties": { "quantity": { "type": "integer", "minimum": 1, "description": "The amount of SIM cards that the user would like to purchase in the SIM card order.", "example": 21 }, "address_id": { "type": "string", "description": "Uniquely identifies the address for the order.", "format": "int64", "example": "1293384261075731499" } } } } } }, "responses": { "202": { "$ref": "#/components/responses/SIMCardOrdersPreviewResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" } }, "x-latency-category": "responsive" } }, "/sim_card_orders": { "get": { "summary": "Get all SIM card orders", "description": "Get all SIM card orders according to filters.", "operationId": "GetSimCardOrders", "tags": [ "SIM Card Orders" ], "parameters": [ { "$ref": "#/components/parameters/FilterCreatedAt" }, { "$ref": "#/components/parameters/FilterUpdatedAt" }, { "$ref": "#/components/parameters/FilterQuantity" }, { "$ref": "#/components/parameters/FilterCostByAmount" }, { "$ref": "#/components/parameters/FilterCostByCurrency" }, { "$ref": "#/components/parameters/FilterAddressById" }, { "$ref": "#/components/parameters/FilterAddressByStreetAddress" }, { "$ref": "#/components/parameters/FilterAddressByExtendedAddress" }, { "$ref": "#/components/parameters/FilterAddressByLocality" }, { "$ref": "#/components/parameters/FilterAddressByAdministrativeArea" }, { "$ref": "#/components/parameters/FilterAddressByCountryCode" }, { "$ref": "#/components/parameters/FilterAddressByPostalCode" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllSimCardOrdersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimCardOrderCreate" } } }, "required": true }, "tags": [ "SIM Card Orders" ], "responses": { "200": { "$ref": "#/components/responses/CreateSimCardOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "summary": "Create a SIM card order", "description": "Creates a new order for SIM cards.", "operationId": "CreateSimCardOrder", "x-latency-category": "responsive" } }, "/sim_card_orders/{id}": { "get": { "summary": "Get a single SIM card order", "description": "Get a single SIM card order by its ID.", "operationId": "GetSimCardOrder", "tags": [ "SIM Card Orders" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GetSimCardOrderResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_cards": { "get": { "summary": "Get all SIM cards", "description": "Get all SIM cards belonging to the user that match the given filters.", "operationId": "GetSimCards", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/IncludeSIMCardGroup" }, { "$ref": "#/components/parameters/FilterSIMCardGroupId" }, { "name": "filter[tags]", "description": "A list of SIM card tags to filter on.

\nIf the SIM card contains all of the given tags they will be found.

\nFor example, if the SIM cards have the following tags: \nSearching for ['customers', 'test'] returns only the first because it's the only one with both tags.
Searching for test returns the first two SIMs, because both of them have such tag.
Searching for customers returns the first and last SIMs.
\n", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "example": [ "personal", "customers", "active-customers" ] } }, { "name": "filter[iccid]", "description": "A search string to partially match for the SIM card's ICCID.", "in": "query", "required": false, "schema": { "type": "string", "example": "89310410106543789301" } }, { "name": "filter[status]", "description": "Filter by a SIM card's status.", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "enabled", "disabled", "standby", "data_limit_exceeded", "unauthorized_imei" ] } } }, { "name": "sort", "description": "Sorts SIM cards by the given field. Defaults to ascending order unless field is prefixed with a minus sign.", "in": "query", "required": false, "example": "-current_billing_period_consumed_data.amount", "schema": { "type": "string", "enum": [ "current_billing_period_consumed_data.amount" ] } } ], "responses": { "200": { "$ref": "#/components/responses/SearchSimCardsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_cards/actions/bulk_set_network_preferences": { "post": { "x-latency-category": "background", "summary": "Request bulk setting of network preferences for SIM cards.", "description": "This API triggers an asynchronous operation to set network preferences 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://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.\n", "operationId": "SetNetworkPreferencesBulk", "tags": [ "SIM Cards" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sim_card_ids" ], "properties": { "sim_card_ids": { "type": "array", "items": { "$ref": "#/components/schemas/Id" }, "example": [ "6b14e151-8493-4fa1-8664-1cc4e6d14158" ] } } } } } }, "responses": { "202": { "$ref": "#/components/responses/BulkSIMCardActionResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" } } } }, "/sim_cards/actions/bulk_set_public_ips": { "post": { "x-latency-category": "background", "summary": "Request bulk setting SIM card public IPs.", "description": "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://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.\n", "operationId": "SetPublicIPsBulk", "tags": [ "SIM Cards" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "sim_card_ids" ], "properties": { "sim_card_ids": { "type": "array", "items": { "$ref": "#/components/schemas/Id" }, "example": [ "6b14e151-8493-4fa1-8664-1cc4e6d14158" ] } } } } } }, "responses": { "202": { "$ref": "#/components/responses/BulkSIMCardActionResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" } } } }, "/sim_cards/actions/validate_registration_codes": { "post": { "summary": "Validate SIM cards registration codes", "tags": [ "SIM Cards" ], "description": "It validates whether SIM card registration codes are valid or not.", "operationId": "ValidateRegistrationCodes", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "registration_codes": { "type": "array", "items": { "type": "string" } } }, "description": "The object containing the Array of SIM card registration codes.", "example": { "registration_codes": [ "123456780", "1231231230" ] } } } } }, "responses": { "200": { "description": "Successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIMCardRegistrationCodeValidations" } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_cards/{id}": { "delete": { "summary": "Deletes a SIM card", "description": "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.", "operationId": "DeleteSimCard", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/DeleteSimCardResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Get SIM card", "description": "Returns the details regarding a specific SIM card.", "operationId": "GetSimCard", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" }, { "$ref": "#/components/parameters/IncludeSIMCardGroup" } ], "responses": { "200": { "$ref": "#/components/responses/GetSimCardResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a SIM card", "description": "Updates SIM card data", "operationId": "UpdateSimCard", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SIMCard" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/UpdateSimCardResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_cards/{id}/actions/delete_network_preferences": { "post": { "x-latency-category": "background", "summary": "Delete network preferences for a SIM card", "description": "This API deletes network preferences for a SIM card.
\nThe API will trigger an asynchronous operation called a SIM Card Action. Creating network preferences may take a period of time. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.\n", "operationId": "DeleteNetworkPreferences", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/SIMCardActionResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_cards/{id}/actions/disable": { "post": { "x-latency-category": "background", "summary": "Request a SIM card disable", "description": "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://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.\n", "operationId": "DisableSimCard", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/SIMCardActionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_cards/{id}/actions/enable": { "post": { "x-latency-category": "background", "summary": "Request a SIM card enable", "description": "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://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.\n", "operationId": "EnableSimCard", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/SIMCardActionResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_cards/{id}/actions/remove_public_ip": { "post": { "summary": "Request removing a SIM card public IP", "description": "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://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.", "operationId": "RemoveSimCardPublicIp", "tags": [ "SIM Cards" ], "x-latency-category": "background", "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/SIMCardActionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_cards/{id}/actions/set_network_preferences": { "post": { "x-latency-category": "background", "summary": "Create or update network preferences for a SIM card", "description": "This API sets network preferences for a SIM card.
\nEvery SIM card has default network preferences defined on Telnyx. These preferences will determine how a SIMCard will connect to the network by considering a list of preferable operators.

\nThe SIM card needs to be attached to the network so this can connect and SMS must be available, otherwise, the operation will fail. This preference will only be respected if the network is available, otherwise the strongest signal will be used.

\nThe API will trigger an asynchronous operation called a SIM Card Action. Creating network preferences may take a period of time. The status of the SIM Card Action can be followed through the [List SIM Card Action](https://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.\n", "operationId": "SetNetworkPreference", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/SIMCardActionResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_cards/{id}/actions/set_public_ip": { "post": { "x-latency-category": "background", "summary": "Request setting a SIM card public IP", "description": "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://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.

\n Setting a Public IP to a SIM Card incurs a charge and will only succeed if the account has sufficient funds.", "operationId": "SetSimCardPublicIp", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/SIMCardActionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_cards/{id}/actions/set_standby": { "post": { "x-latency-category": "background", "summary": "Request setting a SIM card to standby", "description": "The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data.
\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://developersdev.telnyx.com/docs/api/v2/wireless/SIM-Card-Actions#ListSIMCardActions) API.\n", "operationId": "SetSimCardStandby", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/SIMCardActionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/sim_cards/{sim_card_id}/activation_code": { "get": { "summary": "Get activation QR code for an eSIM", "description": "It returns the contents for the activation QR 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", "operationId": "GetSimCardActivationCode", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/SIMCardId" } ], "responses": { "200": { "$ref": "#/components/responses/SIMCardActivationCodeResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_cards/{sim_card_id}/device_details": { "get": { "summary": "Get SIM card device details", "description": "It returns the device details where a SIM card is currently being used.\n", "operationId": "GetSimCardDeviceDetails", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/SIMCardId" } ], "responses": { "200": { "$ref": "#/components/responses/SIMCardDeviceDetailsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_cards/{sim_card_id}/network_preferences": { "delete": { "summary": "DELETE network preferences", "description": "This API asynchronously removes the custom-defined network preferences settings. After this operation is done the Telnyx default settings, the same applied for an unaltered SIM card, will be in place.\n", "operationId": "DeleteSIMCardNetworkPreferences", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/SIMCardId" } ], "responses": { "202": { "$ref": "#/components/responses/DELETESIMCardNetworkPreferenceResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Get network preferences", "description": "It returns the network preferences currently applied in the SIM card.\n", "operationId": "GetSimCardNetworkPreferences", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/SIMCardId" }, { "$ref": "#/components/parameters/IncludeOTAUpdates" } ], "responses": { "200": { "$ref": "#/components/responses/SIMCardNetworkPreferenceWithOTAUpdatesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "put": { "summary": "Set network preferences", "description": "This API allows setting or updating a SIM card network preference.

\nEvery SIM card has default network preferences defined on Telnyx. These preferences will determine how a SIMCard will connect to the network by considering a list of preferable operators.

\nThere can be multiple scenarios where an operator can be preferred over another, for example, when a specific mobile operator can provide better network latency or better pricing.\n", "operationId": "PutSimCardNetworkPreferences", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/SIMCardId" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mobile_network_operators_preferences": { "type": "array", "description": "A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.", "items": { "$ref": "#/components/schemas/MobileNetworkOperatorPreferencesRequest" } } } } } } }, "responses": { "202": { "$ref": "#/components/responses/PUTSIMCardNetworkPreferenceResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_cards/{sim_card_id}/public_ip": { "get": { "summary": "Get SIM card public IP definition", "description": "It returns the public IP requested for a SIM card.\n", "operationId": "GetSimCardPublicIp", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/SIMCardId" } ], "responses": { "200": { "$ref": "#/components/responses/SIMCardPublicIPResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sim_cards/{sim_card_id}/wireless_connectivity_logs": { "get": { "operationId": "GetWirelessConnectivityLogs", "summary": "List wireless connectivity logs", "description": "This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.", "tags": [ "SIM Cards" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/SIMCardId" } ], "responses": { "200": { "$ref": "#/components/responses/WirelessConnectivityLogCollectionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/storage/buckets/{bucketName}/ssl_certificate": { "delete": { "operationId": "RemoveStorageSSLCertificate", "summary": "Remove SSL Certificate", "description": "Deletes an SSL certificate and its matching secret.", "tags": [ "Bucket SSL Certificate" ], "parameters": [ { "in": "path", "name": "bucketName", "required": true, "schema": { "type": "string" }, "description": "Bucket Name" } ], "responses": { "200": { "$ref": "#/components/responses/SSLCertificateResponse" } }, "x-latency-category": "responsive" }, "get": { "operationId": "GetStorageSSLCertificates", "summary": "Get Bucket SSL Certificate", "description": "Returns the stored certificate detail of a bucket, if applicable.", "tags": [ "Bucket SSL Certificate" ], "parameters": [ { "in": "path", "name": "bucketName", "required": true, "schema": { "type": "string" }, "description": "The name of the bucket" } ], "responses": { "200": { "$ref": "#/components/responses/SSLCertificateResponse" } }, "x-latency-category": "responsive" }, "put": { "operationId": "AddStorageSSLCertificate", "tags": [ "Bucket SSL Certificate" ], "parameters": [ { "in": "path", "name": "bucketName", "required": true, "schema": { "type": "string" }, "description": "The name of the bucket" } ], "summary": "Add SSL Certificate", "description": "Uploads an SSL certificate and its matching secret so that you can use Telnyx\u2019s storage as your CDN.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "certificate": { "type": "string", "format": "binary", "description": "The SSL certificate file" }, "private_key": { "type": "string", "format": "binary", "description": "The private key file" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/SSLCertificateResponse" } }, "x-latency-category": "responsive" } }, "/storage/buckets/{bucketName}/usage/api": { "get": { "operationId": "GetStorageAPIUsage", "summary": "Get API Usage", "description": "Returns the detail on API usage on a bucket of a particular time period, group by method category.", "parameters": [ { "in": "path", "name": "bucketName", "required": true, "schema": { "type": "string" }, "description": "The name of the bucket" }, { "in": "query", "name": "filter[start_time]", "required": true, "schema": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z" }, "description": "The start time of the query", "examples": { "start_time": { "value": "2020-01-01T00:00:00Z" } } }, { "in": "query", "name": "filter[end_time]", "schema": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z" }, "examples": { "end_time": { "value": "2020-01-01T00:00:00Z" } }, "description": "The end time of the query" } ], "tags": [ "Bucket Usage" ], "responses": { "200": { "$ref": "#/components/responses/BucketAPIUsageResponse" } }, "x-latency-category": "responsive" } }, "/storage/buckets/{bucketName}/usage/storage": { "get": { "operationId": "GetBucketUsage", "summary": "Get Bucket Usage", "description": "Returns the amount of storage space and number of files a bucket takes up.", "parameters": [ { "in": "path", "name": "bucketName", "required": true, "schema": { "type": "string" }, "description": "The name of the bucket" }, { "in": "query", "name": "filter[start_time]", "required": true, "schema": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z" }, "description": "The start time of the query", "examples": { "start_time": { "value": "2020-01-01T00:00:00Z" } } }, { "in": "query", "name": "filter[end_time]", "schema": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z" }, "examples": { "end_time": { "value": "2020-01-01T00:00:00Z" } }, "description": "The end time of the query" } ], "tags": [ "Bucket Usage" ], "responses": { "200": { "$ref": "#/components/responses/BucketUsageResponse" } }, "x-latency-category": "responsive" } }, "/storage/buckets/{bucketName}/{objectName}/presigned_url": { "post": { "operationId": "GetPresignedObjectUrl", "summary": "Get Presigned Object URL", "description": "Returns a timed and authenticated URL to get an object. This is the equivalent to AWS S3\u2019s \u201cpresigned\u201d URL. Please note that Telnyx performs authentication differently from AWS S3 and you MUST NOT use the presign method of AWS s3api CLI or sdk to generate the presigned URL. \n\nRefer to: https://developers.telnyx.com/docs/cloud-storage/presigned-urls\n", "parameters": [ { "in": "path", "name": "bucketName", "required": true, "schema": { "type": "string" }, "description": "The name of the bucket" }, { "in": "path", "name": "objectName", "required": true, "schema": { "type": "string" }, "description": "The name of the object" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedObjectUrlParams" } } } }, "tags": [ "Presigned Object URLs" ], "responses": { "200": { "$ref": "#/components/responses/PresignedObjectUrlResponse" } }, "x-latency-category": "responsive" } }, "/sub_number_orders": { "get": { "summary": "List sub number orders", "description": "Get a paginated list of sub number orders.", "operationId": "ListSubNumberOrders", "tags": [ "Phone Number Orders" ], "x-group-parameters": "true", "parameters": [ { "name": "filter[user_id]", "in": "query", "description": "User ID of the user who owns the sub number order", "schema": { "type": "string", "format": "uuid", "example": "d70873cd-7c98-401a-81b6-b1ae08246995" } }, { "name": "filter[order_request_id]", "in": "query", "description": "ID of the number order the sub number order belongs to", "schema": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c293" } }, { "name": "filter[country_code]", "in": "query", "description": "ISO alpha-2 country code.", "schema": { "type": "string", "example": "US" } }, { "name": "filter[phone_number_type]", "in": "query", "description": "Phone Number Type", "schema": { "type": "string", "example": "local" } }, { "name": "filter[phone_numbers_count]", "in": "query", "description": "Amount of numbers in the sub number order", "schema": { "type": "integer", "example": 1 } }, { "name": "filter[include_phone_numbers]", "in": "query", "description": "Include the first 50 phone number objects for each sub order in the results. Note: use of this filter could produce unexpected results due to payload size.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "$ref": "#/components/responses/ListSubNumberOrdersResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/sub_number_orders/{sub_number_order_id}": { "get": { "summary": "Retrieve a sub number order", "description": "Get an existing sub number order.", "operationId": "GetSubNumberOrder", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "sub_number_order_id", "in": "path", "description": "The sub number order ID.", "required": true, "schema": { "type": "string" } }, { "name": "filter[include_phone_numbers]", "in": "query", "description": "Include the first 50 phone number objects in the results", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "$ref": "#/components/responses/SubNumberOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a sub number order", "description": "Updates a sub number order.", "operationId": "UpdateSubNumberOrder", "tags": [ "Phone Number Orders" ], "parameters": [ { "name": "sub_number_order_id", "in": "path", "description": "The sub number order ID.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubNumberOrderRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/SubNumberOrderResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/telephony_credentials": { "get": { "description": "List all On-demand Credentials.", "summary": "List all credentials", "operationId": "FindTelephonyCredentials", "tags": [ "Credentials" ], "x-group-parameters": "true", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/OptionalTag" }, { "$ref": "#/components/parameters/FilterName" }, { "$ref": "#/components/parameters/FilterStatus" }, { "$ref": "#/components/parameters/FilterResourceId" }, { "$ref": "#/components/parameters/FilterSipUsername" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllTelephonyCredentialResponse" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "post": { "description": "Create a credential.", "summary": "Create a credential", "operationId": "CreateTelephonyCredential", "tags": [ "Credentials" ], "parameters": [], "requestBody": { "description": "Parameters that can be defined during credential creation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TelephonyCredentialCreateRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/TelephonyCredentialResponse" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/telephony_credentials/tags": { "get": { "description": "Returns a list of tags used on Credentials", "summary": "List all tags", "operationId": "ListTags", "tags": [ "Credentials" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListTagsResponse" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" } }, "/telephony_credentials/{id}": { "delete": { "description": "Delete an existing credential.", "summary": "Delete a credential", "operationId": "DeleteTelephonyCredential", "tags": [ "Credentials" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/TelephonyCredentialResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" }, "get": { "description": "Get the details of an existing On-demand Credential.", "summary": "Get a credential", "operationId": "GetTelephonyCredential", "tags": [ "Credentials" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/TelephonyCredentialResponse" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" }, "patch": { "description": "Update an existing credential.", "summary": "Update a credential", "operationId": "UpdateTelephonyCredential", "tags": [ "Credentials" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Parameters that can be updated in a credential", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TelephonyCredentialUpdateRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/TelephonyCredentialResponse" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" }, "422": { "description": "Bad request" } }, "x-latency-category": "responsive" } }, "/telephony_credentials/{id}/actions/{action}": { "post": { "description": "Perform activate or deactivate action on provided Credential. Activate action will change the status to active, making it possible to connect calls with the credential. Deactivate action will change the status to inactive, making it impossible to connect calls with the credential.", "summary": "Perform activate or deactivate action on provided Credential", "operationId": "PerformCredentialAction", "tags": [ "Credentials" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } }, { "name": "action", "in": "path", "description": "Identifies the action to be taken.", "required": true, "schema": { "type": "string", "enum": [ "activate", "deactivate" ] } } ], "responses": { "200": { "$ref": "#/components/responses/TelephonyCredentialResponse" }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Resource not found" } }, "x-latency-category": "responsive" } }, "/telephony_credentials/{id}/token": { "post": { "description": "Create an Access Token (JWT) for the credential.", "summary": "Create an Access Token.", "operationId": "CreateTelephonyCredentialToken", "tags": [ "Access Tokens" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the resource.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "JWT", "content": { "text/plain": { "schema": { "type": "string", "example": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ" } } } }, "404": { "description": "Resource not Found" } }, "x-latency-category": "responsive" } }, "/texml/Accounts/{account_sid}/Calls": { "get": { "summary": "Fetch multiple call resources", "description": "Returns multiple call resouces for an account. This endpoint is eventually consistent.", "x-latency-category": "responsive", "operationId": "GetTexmlCalls", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageToken" }, { "$ref": "#/components/parameters/To" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Status" }, { "$ref": "#/components/parameters/StartTime" }, { "$ref": "#/components/parameters/EndTime" } ], "responses": { "200": { "$ref": "#/components/responses/GetCallsResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } }, "post": { "summary": "Initiate an outbound call", "description": "Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "InitiateTexmlCall", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" } ], "requestBody": { "description": "Iniatiate Call request object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateCallRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/InitiateCallResponse" } } } }, "/texml/Accounts/{account_sid}/Calls/{call_sid}": { "get": { "summary": "Fetch a call", "description": "Returns an individual call identified by its CallSid. This endpoint is eventually consistent.", "x-latency-category": "responsive", "operationId": "GetTexmlCall", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallSid" }, { "$ref": "#/components/parameters/AccountSid" } ], "responses": { "200": { "$ref": "#/components/responses/GetCallResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } }, "post": { "summary": "Update call", "description": "Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "UpdateTexmlCall", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallSid" }, { "$ref": "#/components/parameters/AccountSid" } ], "requestBody": { "description": "Update Call request object", "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UpdateCallRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/GetCallResponse" } } } }, "/texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json": { "get": { "summary": "Fetch recordings for a call", "description": "Returns recordings for a call identified by call_sid.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "FetchTeXMLCallRecordings", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/CallSid" } ], "responses": { "200": { "$ref": "#/components/responses/TexmlGetCallRecordingsResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } }, "post": { "summary": "Request recording for a call", "description": "Starts recording with specified parameters for call idientified by call_sid.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "StartTeXMLCallRecording", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/CallSid" } ], "requestBody": { "$ref": "#/components/requestBodies/TexmlCreateCallRecordingRequest" }, "responses": { "200": { "$ref": "#/components/responses/TexmlCreateCallRecordingResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json": { "post": { "summary": "Update recording on a call", "description": "Updates recording resource for particular call.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "UpdateTeXMLCallRecording", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/CallSid" }, { "$ref": "#/components/parameters/RecordingId" } ], "requestBody": { "$ref": "#/components/requestBodies/TexmlUpdateCallRecordingRequest" }, "responses": { "200": { "$ref": "#/components/responses/TexmlCreateCallRecordingResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Conferences": { "get": { "summary": "List conference resources", "description": "Lists conference resources.", "x-latency-category": "responsive", "operationId": "GetTexmlConferences", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PageSize" }, { "$ref": "#/components/parameters/PageToken" }, { "$ref": "#/components/parameters/FriendlyName" }, { "$ref": "#/components/parameters/ConferenceStatus" }, { "$ref": "#/components/parameters/DateCreated" }, { "$ref": "#/components/parameters/DateUpdated" } ], "responses": { "200": { "$ref": "#/components/responses/GetConferencesResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Conferences/{conference_sid}": { "get": { "summary": "Fetch a conference resource", "description": "Returns a conference resource.", "x-latency-category": "responsive", "operationId": "GetTexmlConference", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" } ], "responses": { "200": { "$ref": "#/components/responses/GetConferenceResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } }, "post": { "summary": "Update a conference resource", "description": "Updates a conference resource.", "x-latency-category": "responsive", "operationId": "UpdateTexmlConference", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" } ], "requestBody": { "description": "Update Conference request object", "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UpdateConferenceRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/GetConferenceResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants": { "get": { "summary": "List conference participants", "description": "Lists conference participants", "x-latency-category": "responsive", "operationId": "GetTexmlConferenceParticipants", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" } ], "responses": { "200": { "$ref": "#/components/responses/GetParticipantsResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } }, "post": { "summary": "Dial a new conference participant", "description": "Dials a new conference participant", "x-latency-category": "responsive", "operationId": "DialTexmlConferenceParticipant", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" } ], "requestBody": { "description": "Dial Conference Participant request object", "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DialConferenceParticipantRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/DialParticipantResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid}": { "delete": { "summary": "Delete a conference participant", "description": "Deletes a conference participant", "x-latency-category": "responsive", "operationId": "DeleteTexmlConferenceParticipant", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" }, { "$ref": "#/components/parameters/CallSid" } ], "responses": { "204": { "$ref": "#/components/responses/EmptyResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } }, "get": { "summary": "Get conference participant resource", "description": "Gets conference participant resource", "x-latency-category": "responsive", "operationId": "GetTexmlConferenceParticipant", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" }, { "$ref": "#/components/parameters/CallSid" } ], "responses": { "200": { "$ref": "#/components/responses/GetParticipantResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } }, "post": { "summary": "Update a conference participant", "description": "Updates a conference participant", "x-latency-category": "responsive", "operationId": "UpdateTexmlConferenceParticipant", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" }, { "$ref": "#/components/parameters/CallSid" } ], "requestBody": { "description": "Update Conference Participant request object", "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UpdateConferenceParticipantRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/GetParticipantResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings": { "get": { "summary": "List conference recordings", "description": "Lists conference recordings", "x-latency-category": "responsive", "operationId": "GetTexmlConferenceRecordings", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" } ], "responses": { "200": { "$ref": "#/components/responses/GetConferenceRecordingsResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json": { "get": { "summary": "Fetch recordings for a conference", "description": "Returns recordings for a conference identified by conference_sid.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "FetchTeXMLConferenceRecordings", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/ConferenceSid" } ], "responses": { "200": { "$ref": "#/components/responses/TexmlGetCallRecordingsResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Recordings.json": { "get": { "summary": "Fetch multiple recording resources", "description": "Returns multiple recording resources for an account.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "GetTeXMLCallRecordings", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PageSizeTexml" }, { "$ref": "#/components/parameters/TexmlDateCreated" } ], "responses": { "200": { "$ref": "#/components/responses/TexmlGetCallRecordingsResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/Accounts/{account_sid}/Recordings/{recording_sid}.json": { "delete": { "summary": "Delete recording resource", "description": "Deletes recording resource identified by recording id.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "DeleteTeXMLCallRecording", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/RecordingId" } ], "responses": { "204": { "description": "The resource was deleted successfully." }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } }, "get": { "summary": "Fetch recording resource", "description": "Returns recording resource identified by recording id.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "GetTeXMLCallRecording", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/AccountSid" }, { "$ref": "#/components/parameters/RecordingId" } ], "responses": { "200": { "$ref": "#/components/responses/TexmlGetCallRecordingResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } } } }, "/texml/calls/{application_id}": { "post": { "summary": "Initiate an outbound call", "description": "Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "InitiateTexmlCall", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/ApplicationId" } ], "requestBody": { "description": "Iniatiate Call request object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateCallRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/InitiateCallResponse" } } } }, "/texml/calls/{call_sid}/update": { "post": { "summary": "Update call", "description": "Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example.", "x-latency-category": "responsive", "x-group-parameters": "true", "operationId": "UpdateTexmlCall", "tags": [ "TeXML REST Commands" ], "parameters": [ { "$ref": "#/components/parameters/CallSid" } ], "requestBody": { "description": "Update Call request object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCallRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/UpdateTeXMLCallResponse" } } } }, "/texml/secrets": { "post": { "summary": "Create a TeXML secret", "description": "Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to use your secret name, and this name will be replaced by the actual secret value when processing the TeXML on Telnyx side. The secrets are not visible in any logs.", "x-latency-category": "responsive", "operationId": "CreateTexmlSecret", "tags": [ "TeXML REST Commands" ], "requestBody": { "description": "Create TeXML secret request object", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeXMLSecretRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/CreateTeXMLSecretResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } } } }, "/texml_applications": { "get": { "description": "Returns a list of your TeXML Applications.", "summary": "List all TeXML Applications", "operationId": "FindTexmlApplications", "tags": [ "TeXML Applications" ], "x-endpoint-cost": "medium", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[friendly_name][contains]", "in": "query", "description": "If present, applications with friendly_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.", "schema": { "type": "string", "default": "null" } }, { "$ref": "#/components/parameters/FilterOutboundVoiceProfileId" }, { "$ref": "#/components/parameters/SortConnection" } ], "responses": { "200": { "$ref": "#/components/responses/GetAllTexmlApplicationsResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" } }, "x-latency-category": "responsive" }, "post": { "description": "Creates a TeXML Application.", "summary": "Creates a TeXML Application", "operationId": "CreateTexmlApplication", "tags": [ "TeXML Applications" ], "x-endpoint-cost": "medium", "parameters": [], "requestBody": { "description": "Parameters that can be set when creating a TeXML Application", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTexmlApplicationRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/TexmlApplicationResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/texml_applications/{id}": { "delete": { "description": "Deletes a TeXML Application.", "summary": "Deletes a TeXML Application", "operationId": "DeleteTexmlApplication", "tags": [ "TeXML Applications" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/TexmlApplicationResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "get": { "description": "Retrieves the details of an existing TeXML Application.", "summary": "Retrieve a TeXML Application", "operationId": "GetTexmlApplication", "tags": [ "TeXML Applications" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "200": { "$ref": "#/components/responses/TexmlApplicationResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" } }, "x-latency-category": "responsive" }, "patch": { "description": "Updates settings of an existing TeXML Application.", "summary": "Update a TeXML Application", "operationId": "UpdateTexmlApplication", "tags": [ "TeXML Applications" ], "parameters": [ { "$ref": "#/components/parameters/id" } ], "requestBody": { "description": "Parameters that can be updated in a TeXML Application", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTexmlApplicationRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/TexmlApplicationResponse" }, "400": { "$ref": "#/components/responses/BadRequestResponse" }, "401": { "$ref": "#/components/responses/UnauthenticatedResponse" }, "403": { "$ref": "#/components/responses/UnauthorizedResponse" }, "404": { "$ref": "#/components/responses/NotFoundResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityResponse" } }, "x-latency-category": "responsive" } }, "/v2/external_connections/{id}/locations/{location_id}": { "patch": { "summary": "Update a location's static emergency address", "operationId": "updateLocation", "tags": [ "External Connections" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The ID of the external connection", "schema": { "type": "string", "format": "uuid" } }, { "name": "location_id", "in": "path", "required": true, "description": "The ID of the location to update", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "static_emergency_address_id": { "type": "string", "format": "uuid", "description": "A new static emergency address ID to update the location with" } }, "required": [ "static_emergency_address_id" ] } } } }, "responses": { "200": { "description": "Location successfully updated with no associated orders to process", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationResponse" } } } }, "202": { "description": "Location update accepted; associated orders being processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationResponse" } } } }, "404": { "description": "Location or external connection not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Unprocessable Entity - Location already has an accepted emergency address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-latency-category": "responsive" } }, "/verifications/by_phone_number/{phone_number}": { "get": { "tags": [ "Verify" ], "summary": "List verifications by phone number", "operationId": "ListVerifications", "parameters": [ { "required": true, "description": "The phone number associated with the verifications to retrieve.", "schema": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "name": "phone_number", "in": "path" } ], "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVerificationsResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verifications/by_phone_number/{phone_number}/actions/verify": { "post": { "tags": [ "Verify" ], "summary": "Submit a verification code. Deprecation notice: `verify_profile_id' is now a mandatory field. The sunset date for this change is 2022-04-02 00:00:00.", "operationId": "VerifyVerificationCode", "parameters": [ { "required": true, "description": "The phone number associated with the verification code being verified.", "schema": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "name": "phone_number", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyVerificationCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "Expected verify response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyVerificationCodeResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verifications/call": { "post": { "tags": [ "Verify" ], "summary": "Trigger a Call verification", "operationId": "CreateVerificationCall", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationRequestCall" } } }, "required": true }, "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verifications/flashcall": { "post": { "tags": [ "Verify" ], "summary": "Trigger a Flash call verification", "operationId": "CreateFlashcallVerification", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationRequestFlashcall" } } }, "required": true }, "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verifications/psd2": { "post": { "tags": [ "Verify" ], "summary": "Trigger a PSD2 verification", "operationId": "CreateVerificationPsd2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationRequestPSD2" } } }, "required": true }, "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verifications/sms": { "post": { "tags": [ "Verify" ], "summary": "Trigger a SMS verification", "operationId": "CreateVerificationSms", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationRequestSMS" } } }, "required": true }, "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verifications/whatsapp": { "post": { "tags": [ "Verify" ], "summary": "Trigger a Whatsapp verification", "operationId": "CreateVerificationWhatsapp", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationRequestWhatsapp" } } }, "required": true }, "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerificationResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verifications/{verification_id}": { "get": { "tags": [ "Verify" ], "summary": "Retrieve a verification", "operationId": "RetrieveVerification", "parameters": [ { "required": true, "description": "The identifier of the verification to retrieve.", "schema": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292" }, "name": "verification_id", "in": "path" } ], "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveVerificationResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verified_calls_display_profiles": { "get": { "summary": "Lists the Verified Calls Display Profiles owned by the current user/organization", "operationId": "ListProfiles", "tags": [ "Verified Calls Display Profile" ], "x-group-parameters": "true", "x-endpoint-cost": "light", "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListVerifiedCallsDisplayProfilesResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Creates a Verified Calls Display Profile", "description": "Creates a Verified Calls Display Profile associated with the given Business Identity", "operationId": "CreateProfile", "tags": [ "Verified Calls Display Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerifiedCallsDisplayProfileRequest" } } } }, "x-group-parameters": "true", "x-endpoint-cost": "medium", "responses": { "201": { "$ref": "#/components/responses/displayVerifiedCallsDisplayProfileResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verified_calls_display_profiles/{id}": { "delete": { "summary": "Deletes the Verified Calls Display Profile", "description": "Deletes the Verified Calls Display Profile. This action will fail if any verification requests have been made for this Verified Calls Display Profile. Please contact support@telnyx.com in case you want to delete a Verified Calls Display Profile in that situation.", "operationId": "DeleteProfile", "tags": [ "Verified Calls Display Profile" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Verified Calls Display Profile", "required": true, "schema": { "type": "string" } } ], "x-group-parameters": "true", "x-endpoint-cost": "medium", "responses": { "200": { "$ref": "#/components/responses/displayVerifiedCallsDisplayProfileResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Display the Verified Calls Display Profile", "operationId": "DisplayProfile", "tags": [ "Verified Calls Display Profile" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Verified Calls Display Profile", "required": true, "schema": { "type": "string" } } ], "x-group-parameters": "true", "x-endpoint-cost": "light", "responses": { "200": { "$ref": "#/components/responses/displayVerifiedCallsDisplayProfileResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update a Verified Calls Display Profile", "description": "Update an existing Verified Calls Display Profile and allows adding/removing nested Call Reasons and Phone Numbers. Different attributes can be updated depending on the Verified Calls Display Profile's status: For the VERIFICATION_STATE_PENDING status, no fields can be updated. For the VERIFICATION_STATE_VERIFIED status, it is allowed only to add/remove Call Reaons and Phone Numbers. For the other statuses, all fields can be updated. All existing Call Reasons and Phone Numbers must be sent during the request, or the update will fail.", "operationId": "UpdateProfile", "tags": [ "Verified Calls Display Profile" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Verified Calls Display Profile", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVerifiedCallsDisplayProfileRequest" } } } }, "x-group-parameters": "true", "x-endpoint-cost": "medium", "responses": { "200": { "description": "Verified Calls Display Profile was updated." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verified_calls_display_profiles/{id}/verification_request": { "post": { "summary": "Creates a Verification Request", "description": "Starts a new Verified Calls Display Profile verification process.", "operationId": "CreateProfileVerificationRequest", "tags": [ "Verified Calls Display Profile" ], "parameters": [ { "name": "id", "in": "path", "description": "Identifies the Verified Calls Display Profile", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "The Verification Request was issued." }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verified_numbers": { "get": { "tags": [ "Verified Numbers" ], "x-group-parameters": "true", "summary": "List all Verified Numbers", "description": "Gets a paginated list of Verified Numbers.", "operationId": "ListVerifiedNumbers", "parameters": [ { "required": false, "schema": { "title": "page[size]", "type": "integer", "default": 25 }, "name": "page[size]", "in": "query" }, { "required": false, "schema": { "title": "page[number]", "type": "integer", "default": 1 }, "name": "page[number]", "in": "query" } ], "responses": { "200": { "description": "Expected response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVerifiedNumbersResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedRequestErrorResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Verified Numbers" ], "summary": "Request phone number verification", "description": "Initiates phone number verification procedure.", "operationId": "CreateVerifiedNumber", "requestBody": { "content": { "application/json": { "schema": { "title": "Create Verified Number Request", "type": "object", "required": [ "phone_number", "verification_method" ], "properties": { "phone_number": { "example": "+15551234567", "type": "string" }, "verification_method": { "description": "Verification method.", "type": "string", "enum": [ "sms", "call" ], "example": "sms" } } } } }, "required": true }, "responses": { "200": { "description": "Expected response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVerifiedNumberResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedRequestErrorResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityErrorResponse" } }, "x-latency-category": "responsive" } }, "/verified_numbers/{phone_number}": { "delete": { "tags": [ "Verified Numbers" ], "summary": "Delete a verified number", "operationId": "DeleteVerifiedNumber", "parameters": [ { "required": true, "description": "The phone number being deleted.", "schema": { "example": "+15551234567", "type": "string", "description": "+E164 formatted phone number." }, "name": "phone_number", "in": "path" } ], "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifiedNumberResponseDataWrapper" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedRequestErrorResponse" }, "404": { "$ref": "#/components/responses/NotFoundErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Verified Numbers" ], "summary": "Retrieve a verified number", "operationId": "GetVerifiedNumber", "parameters": [ { "required": true, "description": "The phone number being requested.", "schema": { "example": "+15551234567", "type": "string", "description": "+E164 formatted phone number." }, "name": "phone_number", "in": "path" } ], "responses": { "200": { "description": "Expected verifications response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifiedNumberResponseDataWrapper" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedRequestErrorResponse" }, "404": { "$ref": "#/components/responses/NotFoundErrorResponse" } }, "x-latency-category": "responsive" } }, "/verified_numbers/{phone_number}/actions/verify": { "post": { "tags": [ "Verified Numbers" ], "summary": "Submit verification code", "operationId": "VerifyVerificationCode", "parameters": [ { "required": true, "description": "The phone number being verified.", "schema": { "example": "+15551234567", "type": "string", "description": "+E164 formatted phone number." }, "name": "phone_number", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Verify Verification Code Request", "type": "object", "required": [ "verification_code" ], "properties": { "verification_code": { "example": "123456", "type": "string" } } } } }, "required": true }, "responses": { "200": { "description": "Expected response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifiedNumberResponseDataWrapper" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" }, "401": { "$ref": "#/components/responses/UnauthorizedRequestErrorResponse" }, "404": { "$ref": "#/components/responses/NotFoundErrorResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntityErrorResponse" } }, "x-latency-category": "responsive" } }, "/verify_profiles": { "get": { "tags": [ "Verify" ], "x-group-parameters": "true", "summary": "List all Verify profiles", "description": "Gets a paginated list of Verify profiles.", "operationId": "ListProfiles", "parameters": [ { "required": false, "schema": { "title": "filter[name]", "type": "string", "description": "Optional filter for profile names." }, "name": "filter[name]", "in": "query" }, { "required": false, "schema": { "title": "page[size]", "type": "integer", "default": 25 }, "name": "page[size]", "in": "query" }, { "required": false, "schema": { "title": "page[number]", "type": "integer", "default": 1 }, "name": "page[number]", "in": "query" } ], "responses": { "200": { "description": "Expected Verify profile response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVerifyProfilesResponse" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "tags": [ "Verify" ], "summary": "Create a Verify profile", "description": "Creates a new Verify profile to associate verifications with.", "operationId": "CreateVerifyProfile", "requestBody": { "content": { "application/json": { "schema": { "title": "Create Verify Profile Request", "type": "object", "required": [ "name" ], "properties": { "name": { "example": "Test Profile", "type": "string" }, "webhook_url": { "type": "string", "example": "http://example.com/webhook" }, "webhook_failover_url": { "type": "string", "example": "http://example.com/webhook/failover" }, "sms": { "type": "object", "$ref": "#/components/schemas/CreateVerifyProfileSMSRequest" }, "psd2": { "type": "object", "$ref": "#/components/schemas/CreateVerifyProfilePSD2Request" }, "whatsapp": { "type": "object", "$ref": "#/components/schemas/CreateVerifyProfileWhatsappRequest" }, "call": { "type": "object", "$ref": "#/components/schemas/CreateVerifyProfileCallRequest" }, "flashcall": { "type": "object", "$ref": "#/components/schemas/CreateVerifyProfileFlashcallRequest" }, "language": { "type": "string", "example": "en-US" } } } } }, "required": true }, "responses": { "200": { "description": "Expected Verify profile response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyProfileResponseDataWrapper" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/verify_profiles/{verify_profile_id}": { "delete": { "tags": [ "Verify" ], "summary": "Delete a Verify profile", "operationId": "DeleteProfile", "parameters": [ { "required": true, "description": "The identifier of the Verify profile to delete.", "schema": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292" }, "name": "verify_profile_id", "in": "path" } ], "responses": { "200": { "description": "Expected Verify profile response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyProfileResponseDataWrapper" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "tags": [ "Verify" ], "summary": "Retrieve a Verify profile", "description": "Gets a single Verify profile.", "operationId": "GetVerifyProfile", "parameters": [ { "required": true, "description": "The identifier of the Verify profile to retrieve.", "schema": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292" }, "name": "verify_profile_id", "in": "path" } ], "responses": { "200": { "description": "Expected Verify profile response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyProfileResponseDataWrapper" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "tags": [ "Verify" ], "summary": "Update a Verify profile", "operationId": "UpdateVerifyProfile", "parameters": [ { "required": true, "description": "The identifier of the Verify profile to update.", "schema": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292" }, "name": "verify_profile_id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Update Verify Profile Request", "type": "object", "properties": { "name": { "example": "Test Profile", "type": "string" }, "webhook_url": { "type": "string", "example": "http://example.com/webhook" }, "webhook_failover_url": { "type": "string", "example": "http://example.com/webhook/failover" }, "sms": { "type": "object", "$ref": "#/components/schemas/UpdateVerifyProfileSMSRequest" }, "psd2": { "type": "object", "$ref": "#/components/schemas/UpdateVerifyProfilePSD2Request" }, "whatsapp": { "type": "object", "$ref": "#/components/schemas/UpdateVerifyProfileWhatsappRequest" }, "call": { "type": "object", "$ref": "#/components/schemas/UpdateVerifyProfileCallRequest" }, "flashcall": { "type": "object", "$ref": "#/components/schemas/UpdateVerifyProfileFlashcallRequest" }, "language": { "type": "string", "example": "en-US" } } } } }, "required": true }, "responses": { "200": { "description": "Expected Verify profile response to a valid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyProfileResponseDataWrapper" } } } }, "400": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/virtual_cross_connect_regions": { "get": { "summary": "List all Virtual Cross Connect Cloud Regions", "description": "List all Virtual Cross Connects Cloud Regions.

This endpoint shows which cloud regions are available for the `region_code` your Virtual Cross Connect will be provisioned in.", "operationId": "ListVirtualCrossConnectRegions", "tags": [ "Virtual Cross Connects" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[region_code]", "description": "The Telnyx region code", "in": "query", "required": false, "schema": { "type": "string", "example": "ashburn-va" } }, { "name": "filter[cloud_provider]", "description": "The Telnyx region code", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "aws", "azure", "gce" ], "description": "The Virtual Private Cloud provider.", "example": "aws" } } ], "responses": { "200": { "$ref": "#/components/responses/VirtualCrossConnectRegionListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/virtual_cross_connect_regions/{id}": { "get": { "summary": "Retrieve a Virtual Cross Connect Cloud Regions", "description": "Retrieve a Virtual Cross Connect Cloud Regions.", "operationId": "GetVirtualCrossConnectRegion", "tags": [ "Virtual Cross Connects" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/VirtualCrossConnectRegionResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/virtual_cross_connects": { "get": { "summary": "List all Virtual Cross Connects", "description": "List all Virtual Cross Connects.", "operationId": "ListVirtualCrossConnects", "tags": [ "Virtual Cross Connects" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[network_id]", "description": "The associated network id to filter on.", "in": "query", "required": false, "schema": { "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } } ], "responses": { "200": { "$ref": "#/components/responses/VirtualCrossConnectListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a Virtual Cross Connect", "description": "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.", "operationId": "CreateVirtualCrossConnect", "tags": [ "Virtual Cross Connects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualCrossConnectCreate" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/VirtualCrossConnectResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/virtual_cross_connects/{id}": { "delete": { "summary": "Delete a Virtual Cross Connect", "description": "Delete a Virtual Cross Connect.", "operationId": "DeleteVirtualCrossConnect", "tags": [ "Virtual Cross Connects" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/VirtualCrossConnectResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a Virtual Cross Connect", "description": "Retrieve a Virtual Cross Connect.", "operationId": "GetVirtualCrossConnect", "tags": [ "Virtual Cross Connects" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/VirtualCrossConnectResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update the Virtual Cross Connect", "description": "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`.", "operationId": "UpdateVirtualCrossConnect", "tags": [ "Virtual Cross Connects" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualCrossConnectPatch" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/VirtualCrossConnectResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/virtual_cross_connects/{id}/actions/provision": { "post": { "summary": "Provision a Virtual Cross Connect", "description": "Provision a new Virtual Cross Connect.

This endpoint is only necessary for GCE cloud regions. Once you have patched your Cloud IPs, you must POST this request to trigger the provision.", "operationId": "ProvisionVirtualCrossConnect", "tags": [ "Virtual Cross Connects" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "202": { "$ref": "#/components/responses/VirtualCrossConnectResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/webhook_deliveries": { "get": { "description": "Lists webhook_deliveries for the authenticated user", "summary": "List webhook deliveries", "operationId": "GetWebhookDeliveries", "tags": [ "Webhooks" ], "parameters": [ { "name": "filter[status][eq]", "in": "query", "description": "Return only webhook_deliveries matching the given `status`", "required": false, "schema": { "type": "string", "enum": [ "delivered", "failed" ], "example": "delivered" } }, { "name": "filter[event_type]", "in": "query", "description": "Return only webhook_deliveries matching the given value of `event_type`. Accepts multiple values separated by a `,`.", "required": false, "schema": { "type": "string", "example": "call_initiated,call.initiated" } }, { "name": "filter[webhook][contains]", "in": "query", "description": "Return only webhook deliveries whose `webhook` component contains the given text", "required": false, "schema": { "type": "string", "example": "call.initiated" } }, { "name": "filter[attempts][contains]", "in": "query", "description": "Return only webhook_deliveries whose `attempts` component contains the given text", "required": false, "schema": { "type": "string", "example": "https://fallback.example.com/webhooks" } }, { "name": "filter[started_at][gte]", "in": "query", "description": "Return only webhook_deliveries whose delivery started later than or at given ISO 8601 datetime", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, { "name": "filter[started_at][lte]", "in": "query", "description": "Return only webhook_deliveries whose delivery started earlier than or at given ISO 8601 datetime", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, { "name": "filter[finished_at][gte]", "in": "query", "description": "Return only webhook_deliveries whose delivery finished later than or at given ISO 8601 datetime", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, { "name": "filter[finished_at][lte]", "in": "query", "description": "Return only webhook_deliveries whose delivery finished earlier than or at given ISO 8601 datetime", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/ListWebhookDeliveriesResponse" }, "401": { "description": "Unauthorized" }, "422": { "description": "Unprocessable entity" } }, "x-latency-category": "responsive" } }, "/webhook_deliveries/{id}": { "get": { "summary": "Find webhook_delivery details by ID", "description": "Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.", "operationId": "GetWebhookDelivery", "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Uniquely identifies the webhook_delivery.", "schema": { "type": "string", "format": "uuid", "example": "C9C0797E-901D-4349-A33C-C2C8F31A92C2" } } ], "responses": { "200": { "description": "Webhook delivery record.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/webhook_delivery" } } } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "WebhookDelivery not found" } }, "x-latency-category": "responsive" } }, "/wireguard_interfaces": { "get": { "summary": "List all WireGuard Interfaces", "description": "List all WireGuard Interfaces.", "operationId": "ListWireguardInterfaces", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[network_id]", "description": "The associated network id to filter on.", "in": "query", "required": false, "schema": { "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } } ], "responses": { "200": { "$ref": "#/components/responses/WireguardInterfaceListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a WireGuard Interface", "description": "Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created.", "operationId": "CreateWireguardInterface", "tags": [ "WireGuard Interfaces" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WireguardInterfaceCreate" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/WireguardInterfaceResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/wireguard_interfaces/{id}": { "delete": { "summary": "Delete a WireGuard Interface", "description": "Delete a WireGuard Interface.", "operationId": "DeleteWireguardInterface", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/WireguardInterfaceResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve a WireGuard Interfaces", "description": "Retrieve a WireGuard Interfaces.", "operationId": "GetWireguardInterface", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/WireguardInterfaceResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/wireguard_peers": { "get": { "summary": "List all WireGuard Peers", "description": "List all WireGuard peers.", "operationId": "ListWireguardPeers", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" }, { "name": "filter[wireguard_interface_id]", "description": "The id of the associated WireGuard interface to filter on.", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } } ], "responses": { "200": { "$ref": "#/components/responses/WireguardPeerListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "summary": "Create a WireGuard Peer", "description": "Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created.", "operationId": "CreateWireguardPeer", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WireguardPeerCreate" } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/WireguardPeerResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/wireguard_peers/{id}": { "delete": { "summary": "Delete the WireGuard Peer", "description": "Delete the WireGuard peer.", "operationId": "DeleteWireguardPeer", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/WireguardPeerResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "summary": "Retrieve the WireGuard Peer", "description": "Retrieve the WireGuard peer.", "operationId": "GetWireguardPeer", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/WireguardPeerResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "patch": { "summary": "Update the WireGuard Peer", "description": "Update the WireGuard peer.", "operationId": "UpdateWireguardPeer", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WireguardPeerPatch" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/WireguardPeerResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/wireguard_peers/{id}/allowed_ips": { "get": { "summary": "List all Allowed IPs for a WireGuard Peer", "description": "List all Allowed IPs for a WireGuard peer.", "operationId": "ListWireguardPeerAllowedIps", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" }, { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/WireguardPeerAllowedIPListResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/wireguard_peers/{id}/allowed_ips/{child_id}": { "get": { "summary": "Retrieve the Allowed IP", "description": "Retrieve the Allowed IP.", "operationId": "GetWireguardPeerAllowedIp", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" }, { "$ref": "#/components/parameters/ChildId" } ], "responses": { "200": { "$ref": "#/components/responses/WireguardPeerAllowedIPResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/wireguard_peers/{id}/config": { "get": { "summary": "Retrieve Wireguard config template for Peer", "description": "Retrieve Wireguard config template for Peer", "operationId": "GetWireguardPeerConfig", "tags": [ "WireGuard Interfaces" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "description": "Successful response", "content": { "text/plain; charset=utf-8": { "schema": { "type": "string", "example": "[Interface]\nPrivateKey = \nAddress = 198.51.100.1/32\n\n[Peer]\nPublicKey = qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=\nAllowedIPs = 198.51.100.0/29\nEndpoint = 203.0.113.0:51871\nPersistentKeepalive = 25\n" } } } }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" } }, "/wireless/detail_records_reports": { "get": { "summary": "Get all Wireless Detail Records (WDRs) Reports", "description": "Returns the WDR Reports that match the given parameters.", "operationId": "GetWdrReports", "tags": [ "Reporting" ], "parameters": [ { "$ref": "#/components/parameters/PageNumber" }, { "$ref": "#/components/parameters/PageSize" } ], "responses": { "200": { "$ref": "#/components/responses/GetWdrReportsResponse" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "post": { "x-latency-category": "background", "summary": "Create a Wireless Detail Records (WDRs) Report", "description": "Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.\n", "operationId": "CreateWdrReport", "tags": [ "Reporting" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WdrReportRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/CreateWdrReportResponse" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/wireless/detail_records_reports/{id}": { "delete": { "summary": "Delete a Wireless Detail Record (WDR) Report", "description": "Deletes one specific WDR report", "operationId": "DeleteWdrReport", "tags": [ "Reporting" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/DeleteWdrReportResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } }, "x-latency-category": "responsive" }, "get": { "x-latency-category": "background", "summary": "Get a Wireless Detail Record (WDR) Report", "description": "Returns one specific WDR report", "operationId": "GetWdrReport", "tags": [ "Reporting" ], "parameters": [ { "$ref": "#/components/parameters/ResourceId" } ], "responses": { "200": { "$ref": "#/components/responses/GetWdrReportResponse" }, "404": { "$ref": "#/components/responses/ResourceNotFound" }, "default": { "$ref": "#/components/responses/GenericErrorResponse" } } } }, "/{bucketName}": { "delete": { "tags": [ "Bucket" ], "operationId": "DeleteBucket", "summary": "DeleteBucket", "description": "Deletes a bucket. The bucket must be empty for it to be deleted.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html" }, "responses": { "204": { "description": "Success" } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The name of the bucket.", "schema": { "type": "string" } } ], "x-latency-category": "responsive" }, "get": { "tags": [ "Object" ], "operationId": "ListObjects", "summary": "ListObjectsV2", "description": "List all objects contained in a given bucket.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html" }, "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/ListObjectsResponse" } } } }, "404": { "description": "Bucket does not exist." } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The name of the bucket.", "schema": { "type": "string", "minLength": 4, "maxLength": 64 } }, { "name": "list-type", "in": "query", "required": false, "schema": { "type": "integer", "enum": [ 2 ] } } ], "x-latency-category": "responsive" }, "head": { "tags": [ "Bucket" ], "operationId": "HeadBucket", "summary": "HeadBucket", "description": "Determines if a bucket exists and you have permission to access it.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html" }, "responses": { "200": { "description": "Success" }, "404": { "description": "NoSuchBucket" } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The name of the bucket.", "schema": { "type": "string" } } ], "x-latency-category": "responsive" }, "post": { "tags": [ "Object" ], "operationId": "DeleteObjects", "summary": "DeleteObjects", "description": "Deletes one or multiple objects from a given bucket.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html" }, "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteObjectsResponse" } } } } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The bucket name.", "schema": { "type": "string" } }, { "name": "delete", "in": "query", "required": true, "allowEmptyValue": true, "schema": { "type": "boolean", "enum": [ true ] } } ], "requestBody": { "required": true, "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/DeleteObjectsRequest" } } } }, "x-latency-category": "responsive" }, "put": { "tags": [ "Bucket" ], "operationId": "CreateBucket", "summary": "CreateBucket", "description": "Create a bucket.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html" }, "requestBody": { "content": { "text/xml": { "schema": { "$ref": "#/components/schemas/CreateBucketRequest" } } } }, "responses": { "200": { "description": "Success" }, "409": { "description": "BucketAlreadyExists", "content": { "text/xml": { "schema": { "type": "string", "xml": { "name": "BucketAlreadyExists" } } } } } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The name of the bucket.", "schema": { "type": "string", "example": "mybucket", "minLength": 4, "maxLength": 64 } } ], "x-latency-category": "responsive" } }, "/{bucketName}/{objectName}": { "delete": { "tags": [ "Object" ], "operationId": "DeleteObject", "summary": "DeleteObject", "description": "Delete an object from a given bucket.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html" }, "responses": { "204": { "description": "Success" } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The bucket name.", "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "required": true, "description": "The object name.", "schema": { "type": "string", "minLength": 1 } } ], "x-latency-category": "responsive" }, "get": { "tags": [ "Object" ], "operationId": "GetObject", "summary": "GetObject", "description": "Retrieves an object from a given bucket.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html" }, "responses": { "200": { "description": "Success", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "ObjectNotFound" } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The bucket name.", "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "required": true, "description": "The object name.", "schema": { "type": "string", "minLength": 1 } }, { "name": "uploadId", "in": "query", "required": false, "schema": { "type": "string" } } ], "x-latency-category": "responsive" }, "head": { "tags": [ "Object" ], "operationId": "HeadObject", "summary": "HeadObject", "description": "Retrieves metadata from an object without returning the object itself.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html" }, "responses": { "200": { "description": "Success", "headers": { "Date": { "schema": { "type": "string", "format": "date-time" } }, "Last-Modified": { "schema": { "type": "string", "format": "date-time" } }, "Content-Length": { "schema": { "type": "integer" } } } }, "404": { "description": "ObjectNotFound" } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The bucket name.", "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "required": true, "description": "The object name.", "schema": { "type": "string", "minLength": 1 } } ], "x-latency-category": "responsive" }, "put": { "tags": [ "Object" ], "operationId": "PutObject", "summary": "PutObject", "description": "Add an object to a bucket.", "externalDocs": { "url": "https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html" }, "responses": { "200": { "description": "Success" } }, "parameters": [ { "name": "bucketName", "in": "path", "required": true, "description": "The bucket name.", "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "required": true, "description": "The object name.", "schema": { "type": "string", "minLength": 1 } }, { "name": "Content-type", "in": "header", "schema": { "type": "string" } }, { "name": "partNumber", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "uploadId", "in": "query", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "x-latency-category": "responsive" } }, "/{bucketName}/{objectName}/uploads/{uploadID}": { "parameters": [ { "name": "bucketName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uploadID", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "maxLength": 36 } } ] } }, "components": { "callbacks": {}, "examples": { "Maximum20JobsAllowed": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "You can have at most 20 pending or in progress jobs", "source": { "pointer": "/base" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } }, "MaximumAllowedPhoneNumbers": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "1000 numbers is the maximum allowed.", "source": { "pointer": "/phone_numbers" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } }, "MinimumAllowedPhoneNumbers": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "You must provide at least 1 phone number.", "source": { "pointer": "/phone_numbers" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } }, "MixedIdsAndE164Values": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "You must specify either all phone numbers in the e164 format or all as phone number ids", "source": { "pointer": "/phone_numbers" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } }, "NotAuthorized": { "value": { "errors": [ { "code": "10006", "title": "Not authorized", "detail": "You are not authorized to access the requested resource.", "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10006" } } ] } }, "PhoneNumberOwnership": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "You must own every number in the bulk request", "source": { "pointer": "/phone_numbers" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } }, "PhoneNumbersMustBePresent": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "must be present", "source": { "pointer": "/phone_numbers" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } } }, "headers": {}, "links": {}, "parameters": { "AccountSid": { "name": "account_sid", "in": "path", "required": true, "description": "The id of the account the resource belongs to.", "schema": { "type": "string" } }, "ApplicationId": { "name": "application_id", "in": "path", "required": true, "description": "The ID of the TeXML application used for the call.", "schema": { "type": "string" } }, "AssociatedRecordType": { "name": "filter[associated_record_type][eq]", "in": "query", "description": "Filter by the associated record type", "schema": { "type": "string", "enum": [ "account", "phone_number" ], "example": "phone_number" } }, "BillingGroupId": { "name": "id", "in": "path", "description": "The id of the billing group", "required": true, "schema": { "type": "string", "format": "uuid" } }, "CallControlId": { "name": "call_control_id", "description": "Unique identifier and token for controlling the call", "in": "path", "required": true, "schema": { "type": "string" } }, "CallSid": { "name": "call_sid", "in": "path", "required": true, "description": "The CallSid that identifies the call to update.", "schema": { "type": "string" } }, "ChannelTypeId": { "name": "filter[channel_type_id][eq]", "in": "query", "description": "Filter by the id of a channel type", "schema": { "type": "string", "enum": [ "webhook", "sms", "email", "voice" ], "example": "webhook" } }, "ChildId": { "name": "child_id", "description": "Identifies the child resource", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "ConferenceSid": { "name": "conference_sid", "in": "path", "required": true, "description": "The ConferenceSid that uniquely identifies a conference.", "schema": { "type": "string" } }, "ConferenceStatus": { "name": "Status", "in": "query", "required": false, "description": "Filters conferences by status.", "schema": { "type": "string", "enum": [ "init", "in-progress", "completed" ] }, "example": "in-progress" }, "ConnectionId": { "name": "connection_id", "description": "Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection resource.", "in": "path", "required": true, "schema": { "type": "string" } }, "CreatedAtGtFilter": { "name": "filter[created_at][lt]", "in": "query", "description": "Filters records to those created after a specific date.", "schema": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z" } }, "CreatedAtLtFilter": { "name": "filter[created_at][lt]", "in": "query", "description": "Filters records to those created before a specific date.", "schema": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z" } }, "DateCreated": { "name": "DateCreated", "in": "query", "required": false, "description": "Filters conferences by the creation date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. DateCreated>=2023-05-22.", "schema": { "type": "string" }, "example": ">=2023-05-22" }, "DateUpdated": { "name": "DateUpdated", "in": "query", "required": false, "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.", "schema": { "type": "string" }, "example": ">=2023-05-22" }, "DocReqsActionFilter": { "name": "filter[action]", "in": "query", "description": "Filters requirements to those applying to a specific action.", "schema": { "type": "string", "enum": [ "ordering", "porting" ], "example": "porting" } }, "DocReqsCountryFilter": { "name": "filter[country_code]", "in": "query", "description": "Filters results to those applying to a 2-character (ISO 3166-1 alpha-2) country code", "schema": { "type": "string", "example": "US" } }, "DocReqsPhoneNumberTypeFilter": { "name": "filter[phone_number_type]", "in": "query", "description": "Filters results to those applying to a specific `phone_number_type`", "schema": { "type": "string", "enum": [ "local", "national", "toll-free" ], "example": "local" } }, "DocReqsRequirementId": { "name": "id", "in": "path", "description": "Uniquely identifies the requirement_type record", "example": "a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa", "required": true, "schema": { "type": "string", "format": "uuid" } }, "DocReqsRequirementTypeId": { "name": "id", "in": "path", "description": "Uniquely identifies the requirement_type record", "example": "a38c217a-8019-48f8-bff6-0fdd9939075b", "required": true, "schema": { "type": "string", "format": "uuid" } }, "DocReqsRequirementTypeNameFilter": { "name": "filter[name][contains]", "in": "query", "description": "Filters requirement types to those whose name contains a certain string.", "schema": { "type": "string", "example": "utility bill" } }, "DocReqsRequirementTypesSort": { "name": "sort[]", "in": "query", "description": "Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a `-` in front of the field name.", "required": false, "schema": { "type": "string", "enum": [ "created_at", "name", "updated_at" ], "example": "country_code" } }, "DocReqsRequirementsSort": { "name": "sort[]", "in": "query", "description": "Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a `-` in front of the field name.", "required": false, "schema": { "type": "string", "enum": [ "action", "country_code", "locality", "phone_number_type" ], "example": "country_code" } }, "DocServiceDocumentIdFilter": { "name": "filter[document_id]", "in": "query", "description": "Identifies the associated document to filter on.", "schema": { "type": "string", "format": "uuid", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "DocumentsCreatedAtGreaterThanFilter": { "name": "filter[created_at][gt]", "in": "query", "description": "Filter by created at greater than provided value.", "schema": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "example": "2021-04-09T22:25:27.521Z" } }, "DocumentsCreatedAtLessThanFilter": { "name": "filter[created_at][lt]", "in": "query", "description": "Filter by created at less than provided value.", "schema": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "example": "2021-04-09T22:25:27.521Z" } }, "DocumentsCustomerReferenceEqFilter": { "name": "filter[customer_reference][eq]", "in": "query", "description": "Filter documents by a customer references.", "schema": { "type": "string", "example": "MY REF 001" } }, "DocumentsCustomerReferenceInFilter": { "name": "filter[customer_reference][in][]", "in": "query", "description": "Filter documents by a list of customer references.", "schema": { "type": "string", "example": "MY REF 001" } }, "DocumentsFilenameContainsFilter": { "name": "filter[filename][contains]", "in": "query", "description": "Filter by string matching part of filename.", "schema": { "type": "string", "example": "invoice" } }, "DocumentsSort": { "name": "sort[]", "in": "query", "description": "Specifies the sort order for results. If you want to sort by a field in ascending order, include it as a sort parameter. If you want to sort in descending order, prepend a `-` in front of the field name.", "required": false, "schema": { "type": "string", "enum": [ "filename", "created_at", "updated_at" ], "example": "filename" } }, "EndTime": { "name": "EndTime", "in": "query", "required": false, "description": "Filters calls by their end date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. EndTime>=2023-05-22.", "schema": { "type": "string" }, "example": ">=2023-05-22" }, "FilterAddressBook": { "name": "filter[address_book][eq]", "in": "query", "required": false, "description": "If present, only returns results with the address_book flag set to the given value.", "schema": { "type": "string", "default": "null" } }, "FilterAddressByAdministrativeArea": { "name": "filter[address.administrative_area]", "description": "Filter by state or province where the address is located.", "schema": { "type": "string", "example": "IL" }, "in": "query" }, "FilterAddressByCountryCode": { "name": "filter[address.country_code]", "description": "Filter by the mobile operator two-character (ISO 3166-1 alpha-2) origin country code.", "schema": { "type": "string", "example": "US" }, "in": "query" }, "FilterAddressByExtendedAddress": { "name": "filter[address.extended_address]", "description": "Returns entries with matching name of the supplemental field for address information.", "schema": { "type": "string", "example": "Suite 504" }, "in": "query" }, "FilterAddressById": { "name": "filter[address.id]", "description": "Uniquely identifies the address for the order.", "schema": { "type": "string", "format": "int64", "example": "1293384261075731499" }, "in": "query" }, "FilterAddressByLocality": { "name": "filter[address.locality]", "description": "Filter by the name of the city where the address is located.", "schema": { "type": "string", "example": "Chicago" }, "in": "query" }, "FilterAddressByPostalCode": { "name": "filter[address.postal_code]", "description": "Filter by postal code for the address.", "schema": { "type": "string", "example": "60654" }, "in": "query" }, "FilterAddressByStreetAddress": { "name": "filter[address.street_address]", "description": "Returns entries with matching name of the street where the address is located.", "schema": { "type": "string", "example": "311 W Superior St" }, "in": "query" }, "FilterApplicationName": { "name": "filter[application_name][contains]", "in": "query", "required": false, "description": "If present, applications with application_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.", "schema": { "type": "string", "default": "null" } }, "FilterBasicStatusLifecycle": { "name": "filter[status]", "description": "Filter by a specific status of the resource's lifecycle.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "in-progress", "completed", "failed" ], "example": "in-progress" } }, "FilterBulkSIMCardActionId": { "name": "filter[bulk_sim_card_action_id]", "description": "Filter by a bulk SIM card action ID.", "in": "query", "required": false, "schema": { "format": "uuid", "type": "string", "example": "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9" } }, "FilterByPhoneNumber": { "name": "filter[phone_number]", "in": "query", "description": "Filter results by phone number", "schema": { "type": "string", "example": "+12003151212" } }, "FilterByPhoneNumberIn": { "name": "filter[phone_number][in][]", "in": "query", "description": "Filter results by a list of phone numbers", "schema": { "type": "array", "items": { "type": "string", "example": "+12003151212" } } }, "FilterByPortabilityStatus": { "name": "filter[portability_status]", "in": "query", "description": "Filter results by portability status", "schema": { "$ref": "#/components/schemas/PortabilityStatus" } }, "FilterByPortingOrderActivationStatus": { "name": "filter[activation_status]", "in": "query", "description": "Filter results by activation status", "schema": { "$ref": "#/components/schemas/PortingOrderActivationStatus" } }, "FilterByPortingOrderID": { "name": "filter[porting_order_id]", "in": "query", "description": "Filter results by porting order id", "schema": { "type": "string", "format": "uuid", "example": "f3575e15-32ce-400e-a4c0-dd78800c20b0" } }, "FilterByPortingOrderIdIn": { "name": "filter[porting_order_id][in][]", "in": "query", "description": "Filter results by a list of porting order ids", "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "example": "f3575e15-32ce-400e-a4c0-dd78800c20b0" } } }, "FilterByPortingOrderStatus": { "name": "filter[status]", "in": "query", "description": "Filter results by status", "schema": { "type": "string", "enum": [ "draft", "in-process", "submitted", "exception", "foc-date-confirmed", "cancel-pending", "ported", "cancelled" ], "example": "in-process" } }, "FilterByPortingOrderStatusIn": { "name": "filter[status][in][]", "in": "query", "description": "Filter porting orders by multiple statuses", "schema": { "type": "string", "enum": [ "draft", "in-process", "submitted", "exception", "foc-date-confirmed", "cancel-pending", "ported", "cancelled" ], "example": "in-process" } }, "FilterBySupportKeyEq": { "name": "filter[support_key][eq]", "in": "query", "description": "Filter results by support key", "schema": { "type": "string", "example": "sr_a12345" } }, "FilterBySupportKeyIn": { "name": "filter[support_key][in][]", "in": "query", "description": "Filter results by a list of support keys", "schema": { "type": "array", "items": { "type": "string", "example": "sr_a12345" } } }, "FilterCallEventStatus": { "name": "filter[status]", "in": "query", "description": "Event status", "required": false, "schema": { "type": "string", "enum": [ "delivered", "failed" ], "example": "delivered" } }, "FilterCallEventTimestampEqualTo": { "name": "filter[event_timestamp][eq]", "in": "query", "description": "Event timestamp: equal", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, "FilterCallEventTimestampGreaterThan": { "name": "filter[event_timestamp][gt]", "in": "query", "description": "Event timestamp: greater than", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, "FilterCallEventTimestampGreaterThanOrEqualTo": { "name": "filter[event_timestamp][gte]", "in": "query", "description": "Event timestamp: greater than or equal", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, "FilterCallEventTimestampLessThan": { "name": "filter[event_timestamp][lt]", "in": "query", "description": "Event timestamp: lower than", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, "FilterCallEventTimestampLessThanOrEqualTo": { "name": "filter[event_timestamp][lte]", "in": "query", "description": "Event timestamp: lower than or equal", "required": false, "schema": { "type": "string", "example": "2019-03-29T11:10:00Z" } }, "FilterCallEventType": { "name": "filter[type]", "in": "query", "description": "Event type", "required": false, "schema": { "type": "string", "enum": [ "command", "webhook" ], "example": "webhook" } }, "FilterCallLegId": { "name": "filter[call_leg_id]", "in": "query", "description": "The unique identifier of an individual call leg.", "required": false, "schema": { "type": "string", "format": "uuid" } }, "FilterCallSessionId": { "name": "filter[call_session_id]", "in": "query", "description": "The unique identifier of the call control session. A session may include multiple call leg events.", "required": false, "schema": { "type": "string", "format": "uuid" } }, "FilterCivicAddressId": { "name": "filter[civic_address_id][eq]", "in": "query", "description": "The civic address ID to filter by", "schema": { "type": "string", "format": "uuid", "example": "67ea7693-9cd5-4a68-8c76-abb3aa5bf5d2" } }, "FilterConferenceName": { "name": "filter[name]", "in": "query", "description": "If present, conferences will be filtered to those with a matching `name` attribute. Matching is case-sensitive", "schema": { "type": "string" } }, "FilterConferenceStatus": { "name": "filter[status]", "in": "query", "description": "If present, conferences will be filtered by status.", "schema": { "type": "string", "enum": [ "init", "in_progress", "completed" ] } }, "FilterConnectionName": { "name": "filter[connection_name][contains]", "in": "query", "description": "If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.", "schema": { "type": "string", "default": null, "example": "My Connection" } }, "FilterCostByAmount": { "name": "filter[cost.amount]", "description": "The total monetary amount of the order.", "schema": { "type": "string", "example": "2.53" }, "in": "query" }, "FilterCostByCurrency": { "name": "filter[cost.currency]", "description": "Filter by ISO 4217 currency string.", "schema": { "type": "string", "example": "USD" }, "in": "query" }, "FilterCreatedAt": { "name": "filter[created_at]", "description": "Filter by ISO 8601 formatted date-time string matching resource creation date-time.", "schema": { "type": "string", "format": "datetime", "example": "2018-02-02T22:25:27.521Z" }, "in": "query" }, "FilterCustomerReferenceContains": { "name": "filter[customer_reference][contains]", "in": "query", "required": false, "description": "If present, addresses with customer_reference containing the given value will be returned. Matching is not case-sensitive.", "schema": { "type": "string" } }, "FilterCustomerReferenceEquals": { "name": "filter[customer_reference][eq]", "in": "query", "required": false, "description": "Filter addresses via the customer reference set. Matching is not case-sensitive.", "schema": { "type": "string" } }, "FilterEmailContains": { "name": "filter[email][contains]", "in": "query", "required": false, "description": "If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.", "schema": { "type": "string", "default": "null" } }, "FilterEmailEq": { "name": "filter[email][eq]", "in": "query", "required": false, "description": "If present, only returns results with the email matching exactly the value given.", "schema": { "type": "string", "default": "null" } }, "FilterExternalConnectionId": { "name": "filter[external_connection_id]", "in": "query", "description": "The external connection ID to filter by or \"null\" to filter for logs without an external connection ID", "schema": { "type": "string", "example": "67ea7693-9cd5-4a68-8c76-abb3aa5bf5d2" } }, "FilterExternalSipConnection": { "name": "filter[external_sip_connection]", "in": "query", "description": "If present, connections with external_sip_connection matching the given value will be returned.", "schema": { "enum": [ "zoom", "operator_connect" ], "type": "string", "example": "zoom" } }, "FilterFqdn": { "name": "filter[fqdn]", "in": "query", "description": "If present, connections with an `fqdn` that equals the given value will be returned. Matching is case-sensitive, and the full string must match.", "schema": { "type": "string", "default": null } }, "FilterId": { "name": "filter[id]", "in": "query", "description": "If present, connections with id matching the given value will be returned.", "schema": { "type": "string", "default": null, "example": "1930241863466354012" } }, "FilterInnerOutboundVoiceProfileId": { "name": "filter[outbound.outbound_voice_profile_id]", "in": "query", "description": "Identifies the associated outbound voice profile.", "schema": { "type": "string", "format": "int64", "example": "1293384261075731499" } }, "FilterLocationId": { "name": "filter[location_id][eq]", "in": "query", "description": "The location ID to filter by", "schema": { "type": "string", "format": "uuid", "example": "52545f6f-9cd5-4a68-8c76-abb3aa5bf5d2" } }, "FilterName": { "name": "filter[name]", "in": "query", "description": "Filter by name", "schema": { "type": "string" } }, "FilterOrganizationEmailContains": { "name": "filter[organization_name][contains]", "in": "query", "required": false, "description": "If present, only returns results with the organization_name containing the given value. Matching is not case-sensitive. Requires at least three characters.", "schema": { "type": "string", "default": "null" } }, "FilterOrganizationEmailEq": { "name": "filter[organization_name][eq]", "in": "query", "required": false, "description": "If present, only returns results with the organization_name matching exactly the value given.", "schema": { "type": "string", "default": "null" } }, "FilterOutboundVoiceProfileId": { "name": "filter[outbound.outbound_voice_profile_id]", "in": "query", "required": false, "description": "Identifies the associated outbound voice profile.", "schema": { "type": "string", "format": "int64", "example": "1293384261075731499" } }, "FilterPhoneNumber": { "name": "filter[phone_number][contains]", "in": "query", "description": "If present, connections associated with the given phone_number will be returned. A full match is necessary with a e164 format.", "schema": { "type": "string", "default": null, "example": "+15555555555" } }, "FilterPhoneNumberContains": { "name": "filter[phone_number][contains]", "in": "query", "description": "The partial phone number to filter by. Requires 3-15 digits.", "schema": { "type": "string", "example": "+123" } }, "FilterPhoneNumberEq": { "name": "filter[phone_number][eq]", "in": "query", "description": "The phone number to filter by", "schema": { "type": "string", "format": "E164", "example": "+1234567890" } }, "FilterPhoneNumberLogMessageContains": { "name": "filter[telephone_number][contains]", "in": "query", "description": "The partial phone number to filter log messages for. Requires 3-15 digits.", "schema": { "type": "string", "example": "+123" } }, "FilterPhoneNumberLogMessageEq": { "name": "filter[telephone_number][eq]", "in": "query", "description": "The phone number to filter log messages for or \"null\" to filter for logs without a phone number", "schema": { "type": "string", "example": "+1234567890" } }, "FilterQuantity": { "name": "filter[quantity]", "description": "Filter orders by how many SIM cards were ordered.", "schema": { "type": "integer", "example": 21 }, "in": "query" }, "FilterQuantityLessThan": { "name": "filter[quantity][lt]", "description": "Returns orders with quantity lower than the specified argument.", "schema": { "type": "integer", "example": 21 }, "in": "query" }, "FilterReleaseStatus": { "name": "filter[status][eq]", "in": "query", "description": "The status of the release to filter by", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "pending_upload", "pending", "in_progress", "complete", "failed", "expired", "unknown" ] }, "example": [ "pending", "in_progress" ] } }, "FilterResourceId": { "name": "filter[resource_id]", "in": "query", "description": "Filter by resource_id", "schema": { "type": "string" } }, "FilterSIMCardGroupId": { "name": "filter[sim_card_group_id]", "description": "A valid SIM card group ID.", "schema": { "format": "uuid", "type": "string", "example": "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9" }, "in": "query" }, "FilterSIMCardId": { "name": "filter[sim_card_id]", "description": "A valid SIM card ID.", "schema": { "format": "uuid", "type": "string", "example": "47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9" }, "in": "query" }, "FilterSipUsername": { "name": "filter[sip_username]", "in": "query", "description": "Filter by sip_username", "schema": { "type": "string" } }, "FilterStatus": { "name": "filter[status]", "in": "query", "description": "Filter by status", "schema": { "type": "string" } }, "FilterStreetAddress": { "name": "filter[street_address][contains]", "in": "query", "required": false, "description": "If present, addresses with street_address containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.", "schema": { "type": "string", "default": "null" } }, "FilterUpdatedAt": { "name": "filter[updated_at]", "description": "Filter by ISO 8601 formatted date-time string matching resource last update date-time.", "schema": { "type": "string", "format": "datetime", "example": "2018-02-02T22:25:27.521Z" }, "in": "query" }, "FilterUploadStatus": { "name": "filter[status][eq]", "in": "query", "description": "The status of the upload to filter by", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "pending_upload", "pending", "in_progress", "success", "error" ] }, "example": [ "pending_upload", "pending" ] } }, "FilterUsedAsEmergency": { "name": "filter[used_as_emergency]", "in": "query", "required": false, "description": "If set as 'true', only addresses used as the emergency address for at least one active phone-number will be returned. When set to 'false', the opposite happens: only addresses not used as the emergency address from phone-numbers will be returned.", "schema": { "type": "string", "default": "null" } }, "FqdnId": { "name": "id", "description": "Identifies the resource.", "in": "path", "required": true, "schema": { "format": "int64", "type": "string", "example": "1517907029795014409" } }, "FriendlyName": { "name": "FriendlyName", "in": "query", "required": false, "description": "Filters conferences by their friendly name.", "schema": { "type": "string" }, "example": "weekly_review_call" }, "From": { "name": "From", "in": "query", "required": false, "description": "Filters calls by the from number.", "schema": { "type": "string" }, "example": "+1312345678" }, "GcbChannelZoneId": { "name": "channel_zone_id", "in": "path", "description": "Channel zone identifier", "required": true, "schema": { "type": "string" } }, "GcbPhoneNumber": { "description": "The phone number to be looked up", "in": "path", "name": "phone_number", "required": true, "schema": { "example": "+15554441234", "format": "+E.164", "type": "string" } }, "Id": { "name": "id", "description": "Identifies the resource.", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "IncludeCancelledAccounts": { "name": "include_cancelled_accounts", "in": "query", "required": false, "description": "Specifies if cancelled accounts should be included in the results.", "schema": { "type": "boolean", "example": "true", "default": "false" } }, "IncludeOTAUpdates": { "name": "include_ota_updates", "description": "It includes the associated OTA update objects in the response when present.", "schema": { "default": false, "type": "boolean", "example": true }, "in": "query" }, "IncludeSIMCardGroup": { "name": "include_sim_card_group", "in": "query", "description": "It includes the associated SIM card group object in the response when present.", "schema": { "type": "boolean", "default": false, "example": true } }, "IntId": { "name": "id", "description": "Identifies the resource.", "in": "path", "required": true, "schema": { "type": "string", "format": "int64", "example": "1293384261075731499" } }, "IpId": { "name": "id", "description": "Identifies the type of resource.", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "LedgerBillingGroupReportId": { "name": "id", "in": "path", "description": "The id of the ledger billing group report", "required": true, "schema": { "type": "string", "format": "uuid" } }, "LinkedRecordTypeFilter": { "name": "filter[linked_record_type]", "in": "query", "description": "The `linked_record_type` of the document to filter on.", "schema": { "type": "string", "example": "porting_order" } }, "LinkedResourceIdFilter": { "name": "filter[linked_resource_id]", "in": "query", "description": "The `linked_resource_id` of the document to filter on.", "schema": { "type": "string", "format": "uuid", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "MediaName": { "name": "media_name", "description": "Uniquely identifies a media resource.", "in": "path", "required": true, "schema": { "type": "string" } }, "MessagingProfileId": { "name": "id", "in": "path", "description": "The id of the messaging profile to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, "MessagingProfileMetric": { "name": "id", "in": "query", "description": "The id of the messaging profile(s) to retrieve", "required": false, "schema": { "type": "string", "format": "uuid" } }, "MessagingProfileMetricTimeFrame": { "name": "time_frame", "in": "query", "description": "The timeframe for which you'd like to retrieve metrics.", "required": false, "schema": { "type": "string", "default": "24h", "enum": [ "1h", "3h", "24h", "3d", "7d", "30d" ] } }, "NameFilter": { "name": "filter[name][contains]", "in": "query", "description": "Optional filter on outbound voice profile name.", "schema": { "type": "string", "example": "office-profile" } }, "NotificationChannelId": { "name": "filter[notification_channel][eq]", "in": "query", "description": "Filter by the id of a notification channel", "schema": { "type": "string", "example": "12455643-3cf1-4683-ad23-1cd32f7d5e0a" } }, "NotificationEventConditionId": { "name": "filter[notification_event_condition_id][eq]", "in": "query", "description": "Filter by the id of a notification channel", "schema": { "type": "string", "example": "12455643-3cf1-4683-ad23-1cd32f7d5e0a" } }, "NotificationProfileId": { "name": "filter[notification_profile_id][eq]", "in": "query", "description": "Filter by the id of a notification profile", "schema": { "type": "string", "example": "12455643-3cf1-4683-ad23-1cd32f7d5e0a" } }, "NumberLookupType": { "name": "type", "in": "query", "required": false, "description": "Specifies the type of number lookup to be performed", "schema": { "type": "string", "enum": [ "carrier", "caller-name" ] } }, "OptionalTag": { "name": "filter[tag]", "in": "query", "description": "Filter by tag", "schema": { "type": "string" } }, "Page": { "name": "Page", "in": "query", "required": false, "description": "The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.", "schema": { "type": "integer" }, "example": 1 }, "PageAfter": { "name": "page[after]", "in": "query", "description": "Opaque identifier of next page", "schema": { "type": "string", "default": "null" } }, "PageBefore": { "name": "page[before]", "in": "query", "description": "Opaque identifier of previous page", "schema": { "type": "string", "default": "null" } }, "PageLimit": { "name": "page[limit]", "in": "query", "description": "Limit of records per single page", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 20 } }, "PageNumber": { "name": "page[number]", "in": "query", "description": "The page number to load", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, "PageSize": { "name": "page[size]", "in": "query", "description": "The size of the page", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 20 } }, "PageSizeTexml": { "name": "PageSize", "in": "query", "required": false, "description": "The number of records to be displayed on a page", "schema": { "type": "integer" }, "example": 10 }, "PageToken": { "name": "PageToken", "in": "query", "required": false, "description": "Used to request the next page of results.", "schema": { "type": "string" } }, "PathCommentID": { "name": "id", "in": "path", "description": "Comment id", "required": true, "schema": { "type": "string" } }, "PathCustomerServiceRecordId": { "name": "customer_service_record_id", "in": "path", "description": "The ID of the customer service record", "required": true, "schema": { "type": "string" } }, "PathPhoneNumber": { "name": "phone_number", "in": "path", "description": "Phone number", "required": true, "schema": { "type": "string" } }, "PathPortingOrderID": { "name": "id", "description": "Porting Order id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "PathPortingOrdersActivationJobID": { "name": "activationJobId", "description": "Activation Job Identifier", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, "PhoneNumber": { "name": "phone_number", "description": "The phone number to be looked up", "in": "path", "required": true, "schema": { "type": "string", "example": "+18665552368" } }, "PhoneNumberEqFilter": { "name": "filter[phone_number][eq]", "in": "query", "description": "Filters records to those with a specified number.", "schema": { "type": "string", "example": "+12441239999" } }, "PhoneNumberInFilter": { "name": "filter[phone_number][in][]", "in": "query", "description": "Filters records to those with at least one number in the list.", "schema": { "type": "array", "items": { "type": "string", "example": "+12441239999" } } }, "QueryIncludePhoneNumbers": { "name": "include_phone_numbers", "in": "query", "required": false, "description": "Include the first 50 phone number objects in the results", "schema": { "type": "boolean", "default": true } }, "RecordingId": { "description": "Uniquely identifies the recording by id.", "name": "recording_id", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "RequiredTag": { "name": "filter[tag]", "required": true, "in": "query", "description": "Filter by tag, required by bulk operations.", "schema": { "type": "string" } }, "ResourceId": { "name": "id", "description": "Identifies the resource.", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "SIMCardId": { "name": "sim_card_id", "description": "Identifies a SIM card.", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } }, "ShortCodeId": { "name": "id", "in": "path", "description": "The id of the short code", "required": true, "schema": { "type": "string", "format": "uuid" } }, "Sort": { "name": "sort", "in": "query", "required": false, "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.", "schema": { "type": "string", "enum": [ "created_at", "email" ], "example": "email", "default": "created_at" } }, "SortAddress": { "name": "sort", "in": "query", "required": false, "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.", "schema": { "type": "string", "enum": [ "created_at", "first_name", "last_name", "business_name", "street_address" ], "example": "street_address", "default": "created_at" } }, "SortAuthenticationProvider": { "name": "sort", "in": "query", "required": false, "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.", "schema": { "type": "string", "enum": [ "name", "-name", "short_name", "-short_name", "active", "-active", "created_at", "-created_at", "updated_at", "-updated_at" ], "example": "name", "default": "-created_at" } }, "SortConnection": { "name": "sort", "in": "query", "required": false, "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.", "schema": { "type": "string", "enum": [ "created_at", "connection_name", "active" ], "example": "connection_name", "default": "created_at" } }, "SortOutboundVoiceProfile": { "name": "sort", "in": "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:
", "schema": { "type": "string", "enum": [ "enabled", "-enabled", "created_at", "-created_at", "name", "-name", "service_plan", "-service_plan", "traffic_type", "-traffic_type", "usage_payment_method", "-usage_payment_method" ], "default": "-created_at", "example": "name" } }, "StartTime": { "name": "StartTime", "in": "query", "required": false, "description": "Filters calls by the start date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. StartTime>=2023-05-22.", "schema": { "type": "string" }, "example": ">=2023-05-22" }, "Status": { "name": "Status", "in": "query", "required": false, "description": "Filters calls by status.", "schema": { "type": "string", "enum": [ "canceled", "completed", "failed", "busy", "no-answer" ] }, "example": "no-answer" }, "StatusEqFilter": { "name": "filter[status][eq]", "in": "query", "description": "Filters records to those with a specific status.", "schema": { "type": "string", "enum": [ "pending", "completed", "failed" ], "example": "pending" } }, "StatusInFilter": { "name": "filter[status][in][]", "in": "query", "description": "Filters records to those with a least one status in the list.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "pending", "completed", "failed" ], "example": "pending" } } }, "TexmlDateCreated": { "name": "DateCreated", "in": "query", "required": false, "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.", "schema": { "type": "string", "format": "datetime-iso8601", "example": "2023-05-22" } }, "TimestampGreater": { "name": "filter[timestamp][gt]", "description": "Filter by timestamp greater than", "in": "query", "required": false, "schema": { "format": "date-time", "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "TimestampLess": { "name": "filter[timestamp][lt]", "description": "Filter by timestamp less than", "in": "query", "required": false, "schema": { "format": "date-time", "type": "string", "example": "2019-01-01T00:00:00.000Z" } }, "To": { "name": "To", "in": "query", "required": false, "description": "Filters calls by the to number.", "schema": { "type": "string" }, "example": "+1312345678" }, "address_id": { "name": "address_id", "description": "Identifies a civic address or a location.", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "318fb664-d341-44d2-8405-e6bfb9ced6d9" } }, "id": { "name": "id", "description": "Identifies the resource.", "in": "path", "required": true, "schema": { "format": "int64", "type": "string", "example": "1293384261075731499" } }, "phone_number_id": { "name": "phone_number_id", "description": "A phone number's ID via the Telnyx API", "in": "path", "required": true, "schema": { "type": "string", "example": "1234567889" } }, "release_id": { "name": "release_id", "description": "Identifies a Release request", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "7b6a6449-b055-45a6-81f6-f6f0dffa4cc6" } }, "ticket_id": { "name": "ticket_id", "description": "Identifies an Upload request", "in": "path", "required": true, "schema": { "format": "uuid", "type": "string", "example": "7b6a6449-b055-45a6-81f6-f6f0dffa4cc6" } } }, "requestBodies": { "CreateCredentialsRequest": { "description": "Creates new credentials resource for given connection_id.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomStorageConfiguration" } } } }, "CreateCustomerServiceRecord": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "phone_number" ], "properties": { "phone_number": { "type": "string", "description": "A valid US phone number in E164 format.", "example": "+1234567890", "pattern": "^\\+1\\d{10}$" }, "webhook_url": { "type": "string", "description": "Callback URL to receive webhook notifications.", "example": "https://example.com/webhook" }, "additional_data": { "$ref": "#/components/schemas/CustomerServiceRecordAdditionalData" } } } } } }, "CreatePortingAdditionalDocuments": { "description": "A list of additional document parameters", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "additional_documents": { "type": "array", "maxItems": 100, "items": { "type": "object", "properties": { "document_type": { "type": "string", "description": "The type of document being created.", "enum": [ "loa", "invoice", "csr", "other" ] }, "document_id": { "type": "string", "description": "The document identification", "format": "uuid" } } } } }, "example": { "additional_documents": [ { "document_id": "22771a52-c43a-4539-80db-9dd9ec36e237", "document_type": "loa" }, { "document_id": "d91474e6-4ebc-4ec1-b379-c596eeb405d6", "document_type": "invoice" } ] } } } } }, "CreatePortingLOAConfiguration": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "The parameters for creating a new LOA configuration.", "required": [ "name", "logo", "company_name", "address", "contact" ], "properties": { "name": { "type": "string", "description": "The name of the LOA configuration", "example": "My LOA Configuration" }, "logo": { "type": "object", "description": "The logo of the LOA configuration", "required": [ "document_id" ], "properties": { "document_id": { "type": "string", "description": "The document identification", "format": "uuid" } } }, "company_name": { "type": "string", "description": "The name of the company", "example": "Telnyx" }, "address": { "type": "object", "description": "The address of the company.", "required": [ "street_address", "locality", "administrative_area", "postal_code", "country_code" ], "properties": { "street_address": { "type": "string", "description": "The street address of the company", "example": "311 W. Superior St" }, "extended_address": { "type": "string", "description": "The extended address of the company", "example": "Suite 504" }, "city": { "type": "string", "description": "The locality of the company", "example": "Chicago" }, "state": { "type": "string", "description": "The administrative area of the company", "example": "IL", "pattern": "^[A-Z]{2}$" }, "zip_code": { "type": "string", "description": "The postal code of the company", "example": "60654", "pattern": "^[0-9]{5}(?:-[0-9]{4})?$" }, "country_code": { "type": "string", "description": "The country code of the company", "example": "US", "pattern": "^[A-Z]{2}$" } } }, "contact": { "type": "object", "description": "The contact information of the company.", "required": [ "email", "phone_number" ], "properties": { "email": { "type": "string", "description": "The email address of the contact", "example": "testing@telnyx.com", "format": "email" }, "phone_number": { "type": "string", "description": "The phone number of the contact", "example": "+12003270001", "pattern": "^\\+\\d{11,15}$" } } } } } } } }, "CreatePortingPhoneNumberConfigurations": { "description": "A list of phone number configuration parameters", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_number_configurations": { "type": "array", "maxItems": 20, "items": { "type": "object", "required": [ "porting_phone_number_id", "user_bundle_id" ], "properties": { "porting_phone_number_id": { "type": "string", "format": "uuid", "description": "Identifies the porting phone number to be configured.", "example": "927f4687-318c-44bc-9f2f-22a5898143a4" }, "user_bundle_id": { "type": "string", "format": "uuid", "description": "Identifies the user bundle to be associated with the porting phone number.", "example": "ff901545-3e27-462a-ba9d-2b34654cab82" } } } } } } } } }, "CreatePortingReport": { "required": true, "content": { "application/json": { "schema": { "type": "object", "description": "The parameters for generating a new porting related report.", "required": [ "report_type", "params" ], "properties": { "report_type": { "type": "string", "description": "Identifies the type of report", "enum": [ "export_porting_orders_csv" ], "example": "export_porting_orders_csv" }, "params": { "oneOf": [ { "$ref": "#/components/schemas/ExportPortingOrdersCSVReport" } ] } } } } } }, "DeleteRecordingsRequest": { "description": "Deletes recordings for given ids.", "required": true, "content": { "application/json": { "schema": { "description": "List of Call Recordings IDs to delete.", "type": "array", "items": { "type": "string" } } } } }, "DialogflowConnectionRequest": { "description": "The params expected to create/update a Dialogflow Connection for given connection_id.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialogflowConnection" } } } }, "SendPortingVerificationCodes": { "description": "A list of phone numbers to send the verification codes to and the method to send them by", "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "phone_numbers": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "verification_method": { "type": "string", "enum": [ "sms", "call" ] } }, "example": { "phone_numbers": [ "+61424000001", "+61424000002" ], "verification_method": "sms" } } } } }, "SharePortingOrder": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expires_in_seconds": { "description": "The number of seconds the token will be valid for", "type": "integer", "minimum": 1, "maximum": 172800 }, "permissions": { "description": "The permissions the token will have", "type": "string", "enum": [ "porting_order.document.read", "porting_order.document.update" ] } }, "example": { "expires_in_seconds": 3600, "permissions": [ "porting_order.document.read", "porting_order.document.update" ] } } } } }, "TexmlCreateCallRecordingRequest": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TexmlCreateCallRecordingRequestBody" } } }, "description": "Starts call recording on a call." }, "TexmlUpdateCallRecordingRequest": { "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TexmlUpdateCallRecordingRequestBody" } } }, "description": "Update call recording on a call." }, "UpdatePortingOrdersActivationJob": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "activate_at": { "type": "string", "format": "date-time", "example": "2019-01-01T00:00:00Z", "description": "The desired activation time. The activation time should be between any of the activation windows." } } } } } }, "VerifyCustomerServiceRecordPhoneNumberCoverage": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "phone_numbers" ], "properties": { "phone_numbers": { "type": "array", "description": "The phone numbers list to be verified.", "items": { "type": "string", "description": "A valid US phone number in E164 format.", "example": "+1234567890", "pattern": "^\\+1\\d{10}$" } } } } } } }, "VerifyPortingVerificationCodes": { "description": "A list of phone numbers and their verification codes", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "verification_codes": { "type": "array", "maxItems": 100, "items": { "type": "object", "properties": { "phone_number": { "type": "string" }, "code": { "type": "string" } } } } }, "example": { "verification_codes": [ { "phone_number": "+61424000001", "code": "12345" }, { "phone_number": "+61424000002", "code": "54321" } ] } } } } } }, "responses": { "ActionSuccessResponse": { "description": "Success Action Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "result": { "type": "string", "example": "ok" } } } } } } } }, "ActiveCallsResponse": { "description": "Successful response with list of details about active calls.", "content": { "application/json": { "schema": { "type": "object", "title": "Active Calls Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveCall" } }, "meta": { "$ref": "#/components/schemas/CursorPaginationMeta" } } } } } }, "AddressResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Address" } } } } } }, "AuthenticationProviderResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AuthenticationProvider" } } } } } }, "AutoRechargePrefResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutoRechargePref" } } } } } }, "BadRequestResponse": { "description": "Bad request, the request was unacceptable, often due to missing a required parameter.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingParameter": { "value": { "errors": [ { "code": "10015", "title": "Bad Request", "detail": "The request failed because it was not well-formed.", "source": { "pointer": "/" }, "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10015" } } ] } } } } } }, "BucketAPIUsageResponse": { "description": "Bucket Usage", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BucketAPIUsageResponse" } } } } } } }, "BucketUsageResponse": { "description": "Bucket Storage Usage", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BucketUsage" } }, "meta": { "$ref": "#/components/schemas/PaginationMetaSimple" } } } } } }, "BulkCredentialResponse": { "description": "Successful response for Bulk credential requests", "content": { "application/json": { "schema": { "type": "object", "title": "Bulk Credential Response", "properties": { "data": { "type": "object", "properties": { "credentials": { "type": "integer", "description": "Amount of credentials affected", "example": 0 } } } } } } } }, "BulkDeleteRoomRecordingsResponse": { "description": "Successful response for Bulk Delete Room recordings requests", "content": { "application/json": { "schema": { "type": "object", "title": "Bulk Room Recordings Delete Response", "properties": { "data": { "type": "object", "properties": { "room_recordings": { "type": "integer", "description": "Amount of room recordings affected", "example": 5 } } } } } } } }, "BulkSIMCardActionCollectionResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BulkSIMCardActionDetailed" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } }, "description": "Successful response" }, "BulkSIMCardActionDetailedResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BulkSIMCardActionDetailed" } } } } }, "description": "Successful Response" }, "BulkSIMCardActionResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BulkSIMCardAction" } } } } }, "description": "Successful Response" }, "BulkSIMCardNetworkPreferenceResponse": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Multi requested SIM cards network preferences.", "type": "array", "items": { "$ref": "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } }, "BulkUploadDocServiceDocumentsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocServiceDocument" } } } } } } }, "CallControlApplicationResponse": { "description": "Successful response with details about a call control application.", "content": { "application/json": { "schema": { "type": "object", "title": "Call Control Application Response", "properties": { "data": { "$ref": "#/components/schemas/CallControlApplication" } } } } } }, "CallControlCommandResponse": { "description": "Successful response upon making a call control command.", "content": { "application/json": { "schema": { "type": "object", "title": "Call Control Command Response", "properties": { "data": { "$ref": "#/components/schemas/CallControlCommandResult" } } } } } }, "CancelFaxResponse": { "description": "Successful response upon accepting cancel fax command", "content": { "application/json": { "schema": { "type": "object", "title": "Successful response upon accepting cancel fax command", "example": { "data": { "result": "ok" } }, "properties": { "result": { "type": "string", "example": "ok" } } } } } }, "CancelPortingOrderResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingOrder" }, "meta": { "type": "object", "properties": { "phone_numbers_url": { "type": "string", "description": "Link to list all phone numbers" } } } }, "example": { "data": { "activation_settings": { "activation_status": null, "fast_port_eligible": true, "foc_datetime_actual": null, "foc_datetime_requested": "2022-04-08T15:00:00Z" }, "created_at": "2022-03-24T14:22:28Z", "customer_reference": "Test1234", "description": "FP Telnyx", "documents": { "loa": "3a5b98a0-5049-47c3-96e1-aa6c8d119117", "invoice": "3a5b98a0-5049-47c3-96e1-aa6c8d119117" }, "end_user": { "admin": { "account_number": "123abc", "auth_person_name": "Porter McPortersen II", "billing_phone_number": "+13035551234", "business_identifier": "abc123", "entity_name": "Porter McPortersen", "pin_passcode": "1234", "tax_identifier": "1234abcd" }, "location": { "administrative_area": "IL", "country_code": "US", "extended_address": "Suite 504", "locality": "Chicago", "postal_code": "60654", "street_address": "311 W. Superior St" } }, "id": "eef10fb8-f3df-4c67-97c5-e18179723222", "misc": { "new_billing_phone_number": null, "remaining_numbers_action": null, "type": "full" }, "old_service_provider_ocn": "Unreal Communications", "parent_support_key": "pr_4bec1a", "phone_number_configuration": { "billing_group_id": null, "connection_id": "1752379429071357070", "emergency_address_id": null, "messaging_profile_id": null, "tags": [] }, "phone_number_type": "local", "porting_phone_numbers_count": 1, "record_type": "porting_order", "requirements": [], "requirements_met": true, "status": { "details": [], "value": "cancel-pending" }, "support_key": "sr_10b316", "updated_at": "2022-03-24T16:43:35Z", "user_feedback": { "user_comment": null, "user_rating": null }, "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75", "webhook_url": "https://example.com/porting_webhooks" }, "meta": { "phone_numbers_url": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222" } } } } } }, "CommentResponse": { "description": "A Comment Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/Comment" }, { "type": "object" } ] } } } } } }, "ConferenceCommandResponse": { "description": "Successful response upon making a conference command.", "content": { "application/json": { "schema": { "type": "object", "title": "Conference Command Response", "properties": { "data": { "$ref": "#/components/schemas/ConferenceCommandResult" } } } } } }, "ConferenceResponse": { "description": "Successful response with details about a conference.", "content": { "application/json": { "schema": { "type": "object", "title": "Conference Response", "properties": { "data": { "$ref": "#/components/schemas/Conference" } } } } } }, "ConfirmPortingOrderResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingOrder" }, "meta": { "type": "object", "properties": { "phone_numbers_url": { "type": "string", "description": "Link to list all phone numbers" } } } }, "example": { "data": { "activation_settings": { "activation_status": null, "fast_port_eligible": true, "foc_datetime_actual": null, "foc_datetime_requested": "2022-04-08T15:00:00Z" }, "created_at": "2022-03-24T14:22:28Z", "customer_reference": "Test1234", "description": "FP Telnyx", "documents": { "loa": "3a5b98a0-5049-47c3-96e1-aa6c8d119117", "invoice": "3a5b98a0-5049-47c3-96e1-aa6c8d119117" }, "end_user": { "admin": { "account_number": "123abc", "auth_person_name": "Porter McPortersen II", "billing_phone_number": "+13035551234", "business_identifier": "abc123", "entity_name": "Porter McPortersen", "pin_passcode": "1234", "tax_identifier": "1234abcd" }, "location": { "administrative_area": "IL", "country_code": "US", "extended_address": "Suite 504", "locality": "Chicago", "postal_code": "60654", "street_address": "311 W. Superior St" } }, "id": "eef10fb8-f3df-4c67-97c5-e18179723222", "misc": { "new_billing_phone_number": null, "remaining_numbers_action": null, "type": "full" }, "old_service_provider_ocn": "Unreal Communications", "parent_support_key": "pr_4bec1a", "phone_number_configuration": { "billing_group_id": null, "connection_id": "1752379429071357070", "emergency_address_id": null, "messaging_profile_id": null, "tags": [] }, "phone_number_type": "local", "porting_phone_numbers_count": 1, "record_type": "porting_order", "requirements": [], "requirements_met": true, "status": { "details": [], "value": "in-process" }, "support_key": "sr_10b316", "updated_at": "2022-03-24T16:42:43Z", "user_feedback": { "user_comment": null, "user_rating": null }, "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75", "webhook_url": "https://example.com/porting_webhooks" }, "meta": { "phone_numbers_url": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222" } } } } } }, "ConnectionResponse": { "description": "Successful response with details about a connection.", "content": { "application/json": { "schema": { "type": "object", "title": "Connection Response", "properties": { "data": { "$ref": "#/components/schemas/Connection" } } } } } }, "CreateBillingGroupResponse": { "description": "Expected billing group response to a valid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BillingGroup" } } } } } }, "CreateCustomerServiceRecord": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerServiceRecord" } }, "example": { "data": { "id": "db7cebdb-21a8-4e89-8f51-e03ba6b799bb", "phone_number": "+2003271000", "status": "pending", "error_message": null, "result": null, "webhook_url": "https://example.com/webhook", "created_at": "2023-01-01T00:00:00Z", "updated_at": "2023-01-01T00:00:00Z" } } } } } }, "CreateLedgerBillingGroupReportResponse": { "description": "Expected ledger billing group report response to a valid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LedgerBillingGroupReport" } } } } } }, "CreatePortOutSupportingDocumentsResponse": { "description": "Portout Supporting Documents", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortOutSupportingDocument" } } } } } } }, "CreatePortingAdditionalDocuments": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingAdditionalDocument" } } }, "example": { "data": [ { "id": "2acd1061-33cb-49b8-8014-beb6dc3fedbf", "document_id": "40bc547a-7f96-4cd5-926a-da4842671e88", "document_type": "loa", "porting_order_id": "9d7b3b8e-4e67-4837-9c44-d110cd2c82a1", "record_type": "porting_additional_document", "created_at": "2023-06-01T10:00:00.00000Z", "updated_at": "2023-06-01T10:00:00.00000Z" } ] } } } } }, "CreatePortingLOAConfiguration": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingLOAConfiguration" } } } } } }, "CreatePortingPhoneNumberConfigurations": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingPhoneNumberConfiguration" } } } } } } }, "CreatePortingReport": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingReport" } } } } } }, "CreatePrivateWirelessGatewayResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PrivateWirelessGateway" } } } } } }, "CreateRoomClientTokenResponse": { "description": "Create room client token response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "token": { "type": "string", "format": "jwt", "example": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ" }, "token_expires_at": { "description": "ISO 8601 timestamp when the token expires.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59Z" }, "refresh_token": { "type": "string", "format": "jwt", "example": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ" }, "refresh_token_expires_at": { "description": "ISO 8601 timestamp when the refresh token expires.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59Z" } }, "example": { "token": "eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA", "token_expires_at": "2021-04-22T12:24:55Z", "refresh_token": "eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDkzNzA1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6ImQ3OWJlMzhjLWFkNTQtNGQ5ZC1hODc4LWExNjVjNTk0MGQwNyIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6InJlZnJlc2gifQ.FHsp7KlVXn1E5tTUiKZzmQ4of39gi57AakeQeqI0oAa8hzjFMVb0RGj-mxWTvHVen4GpgsUW_epqqaxK16viCA", "refresh_token_expires_at": "2021-04-22T12:15:05Z" } } } } } } }, "CreateRoomCompositionResponse": { "description": "Create room composition response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RoomComposition" } } } } } }, "CreateRoomResponse": { "description": "Create room response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Room" } } } } } }, "CreateSimCardDataUsageNotificationResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SimCardDataUsageNotification" } } } } } }, "CreateSimCardGroupResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardGroup" } } } } }, "description": "Successful Response" }, "CreateSimCardOrderResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardOrder" } } } } }, "description": "Successful Response" }, "CreateTeXMLSecretResponse": { "description": "Successful response upon creating a TeXML secret.", "content": { "application/json": { "schema": { "type": "object", "title": "Create TeXML Secret request", "properties": { "data": { "$ref": "#/components/schemas/CreateTeXMLSecretResult" } } } } } }, "CreateWdrReportResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WdrReport" } } } } } }, "CredentialConnectionResponse": { "description": "Successful response with details about a credential connection.", "content": { "application/json": { "schema": { "type": "object", "title": "Credential Connection Response", "properties": { "data": { "$ref": "#/components/schemas/CredentialConnection" } } } } } }, "CredentialsResponseBody": { "description": "A response with credentials resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialsResponse" } } } }, "CsvDownloadResponse": { "description": "Successful response with details about a CSV download.", "content": { "application/json": { "schema": { "type": "object", "title": "CSV Download Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CsvDownload" } } } } } } }, "DELETESIMCardNetworkPreferenceResponse": { "description": "A successful network preferences deletion response.

\nThe delete won't be done right away - this is an asynchronous operation. The request will return the resource with an in-progress OTA update resource (in the ota_updates node) representing the delete operation. Similarly to the PUT API, the resource will only be deleted when the OTA updated is successfully completed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates" } } } } } }, "DefaultGatewayResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DefaultGateway" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "DeleteBillingGroupResponse": { "description": "Expected billing group response to a valid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BillingGroup" } } } } } }, "DeletePhoneNumberResponse": { "description": "Successful response with details about a phone number.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Number Response", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberDeletedDetailed" } } } } } }, "DeletePrivateWirelessGatewayResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PrivateWirelessGateway" } } } } } }, "DeleteSimCardDataUsageNotificationResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SimCardDataUsageNotification" } } } } } }, "DeleteSimCardGroupResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardGroup" } } } } }, "description": "Successful Response" }, "DeleteSimCardResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCard" } } } } } }, "DeleteWdrReportResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WdrReport" } } } } } }, "DialParticipantResponse": { "description": "New participant resource.", "content": { "application/json": { "schema": { "type": "object", "title": "New participant resource", "properties": { "data": { "$ref": "#/components/schemas/NewParticipantResource" } } } } } }, "DialogflowConnectionResponseBody": { "description": "Return details of the Dialogflow connection associated with the given CallControl connection.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialogflowConnectionResponse" } } } }, "DocReqsListRequirementTypesResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocReqsRequirementTypeList" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "DocReqsRequirementResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocReqsRequirement" } } } } } }, "DocReqsRequirementTypeResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocReqsRequirementType" } } } } } }, "DocServiceDocumentResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocServiceDocument" } } } } } }, "DownloadDocServiceDocumentResponse": { "description": "Successful response", "content": { "*": { "schema": { "type": "string", "format": "binary" } } } }, "DownloadLOATemplate": { "description": "Successful response", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary", "example": "%PDF-1.4..." } } } }, "DynamicEmergencyAddressResponse": { "description": "Dynamic Emergency Address Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DynamicEmergencyAddress" } } } } } }, "DynamicEmergencyEndpointResponse": { "description": "Dynamic Emergency Endpoint Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DynamicEmergencyEndpoint" } } } } } }, "EmptyResponse": { "description": "Empty response", "application/json": { "schema": { "type": "object", "title": "Empty response", "properties": {} } } }, "ExternalConnectionResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "External Connection Response", "properties": { "data": { "$ref": "#/components/schemas/ExternalConnection" } } } } } }, "FaxApplicationResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Fax Application Response", "properties": { "data": { "$ref": "#/components/schemas/FaxApplication" } } } } } }, "Forbidden": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ForbiddenErrorResponse": { "description": "You do not have permission to perform the requested action on the specified resource or resources.", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenError" } } } } } } }, "ForbiddenResponse": { "description": "Unauthorized response. Happens when the current user is not authorized to access the endpoint." }, "FqdnConnectionResponse": { "description": "Successful response with details about an FQDN connection.", "content": { "application/json": { "schema": { "type": "object", "title": "FQDN Connection Response", "properties": { "data": { "$ref": "#/components/schemas/FqdnConnection" } } } } } }, "FqdnResponse": { "description": "Successful response with details about an FQDN connection.", "content": { "application/json": { "schema": { "type": "object", "title": "FQDN Response", "properties": { "data": { "$ref": "#/components/schemas/Fqdn" } } } } } }, "GenericErrorResponse": { "description": "Unexpected error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "GetAllAddressResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetAllAuthenticationProviderResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuthenticationProvider" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetAllCivicAddressesResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get All Civic Addresses Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CivicAddress" } } } } } } }, "GetAllExternalConnectionResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get All External Connections Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalConnection" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetAllFaxApplicationsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get All Fax Applications Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FaxApplication" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetAllPrivateWirelessGatewaysResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PrivateWirelessGateway" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetAllSimCardGroupsResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SearchedSIMCardGroup" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } }, "description": "Successful response" }, "GetAllSimCardOrdersResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SIMCardOrder" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } }, "description": "Successful response" }, "GetAllTelephonyCredentialResponse": { "description": "Successful response with multiple credentials", "content": { "application/json": { "schema": { "type": "object", "title": "Get All Telephony Credential Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TelephonyCredential" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetAllTexmlApplicationsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get All Texml Applications Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TexmlApplication" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetCallResponse": { "description": "Call resource.", "content": { "application/json": { "schema": { "type": "object", "title": "Call resource", "properties": { "data": { "$ref": "#/components/schemas/CallResource" } } } } } }, "GetCallsResponse": { "description": "Multiple call resources.", "content": { "application/json": { "schema": { "type": "object", "title": "Multiple call resources", "properties": { "data": { "$ref": "#/components/schemas/CallResourceIndex" } } } } } }, "GetCivicAddressResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get Civic Address Response", "properties": { "data": { "$ref": "#/components/schemas/CivicAddress" } } } } } }, "GetConferenceRecordingsResponse": { "description": "Multiple conference recording resources.", "content": { "application/json": { "schema": { "type": "object", "title": "Multiple conference recording resources", "properties": { "data": { "$ref": "#/components/schemas/ConferenceRecordingResourceIndex" } } } } } }, "GetConferenceResponse": { "description": "Conference resource.", "content": { "application/json": { "schema": { "type": "object", "title": "Conference resource", "properties": { "data": { "$ref": "#/components/schemas/ConferenceResource" } } } } } }, "GetConferencesResponse": { "description": "Multiple conference resources.", "content": { "application/json": { "schema": { "type": "object", "title": "Multiple conference resources", "properties": { "data": { "$ref": "#/components/schemas/ConferenceResourceIndex" } } } } } }, "GetExternalConnectionPhoneNumberResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get External Connection Phone Number Response", "properties": { "data": { "$ref": "#/components/schemas/ExternalConnectionPhoneNumber" } } } } } }, "GetFaxResponse": { "description": "Get fax response", "content": { "application/json": { "schema": { "type": "object", "title": "Get Fax Response", "properties": { "data": { "$ref": "#/components/schemas/Fax" } } } } } }, "GetGcbChannelZoneRequestResponse": { "description": "Requested channel zone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GcbChannelZone" } } } }, "GetGcbChannelZonesRequestResponse": { "description": "A list of channel zones", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GcbChannelZone" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetGcbPhoneNumbersRequestResponse": { "description": "A list of phone numbers", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GcbPhoneNumber" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GetLogMessageResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get Log Message Response", "properties": { "log_messages": { "type": "array", "items": { "$ref": "#/components/schemas/LogMessage" }, "minItems": 1, "maxItems": 1 } } } } } }, "GetParticipantResponse": { "description": "Participant resource.", "content": { "application/json": { "schema": { "type": "object", "title": "Participant resource", "properties": { "data": { "$ref": "#/components/schemas/ParticipantResource" } } } } } }, "GetParticipantsResponse": { "description": "Multiple participant resources.", "content": { "application/json": { "schema": { "type": "object", "title": "Multiple participant resources", "properties": { "data": { "$ref": "#/components/schemas/ParticipantResourceIndex" } } } } } }, "GetPrivateWirelessGatewayResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PrivateWirelessGateway" } } } } } }, "GetReleaseResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get Release Response", "properties": { "data": { "$ref": "#/components/schemas/Release" } } } } } }, "GetRoomCompositionResponse": { "description": "Get room composition response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RoomComposition" } } } } } }, "GetRoomParticipantResponse": { "description": "Get room participant response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RoomParticipant" } } } } } }, "GetRoomRecordingResponse": { "description": "Get room recording response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RoomRecording" } } } } } }, "GetRoomResponse": { "description": "Get room response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Room" } } } } } }, "GetRoomSessionResponse": { "description": "Get room session response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RoomSession" } } } } } }, "GetSimCardDataUsageNotificationResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SimCardDataUsageNotification" } } } } } }, "GetSimCardGroupResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardGroup" } } } } }, "description": "Successful Response" }, "GetSimCardOrderResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardOrder" } } } } }, "description": "Successful Response" }, "GetSimCardResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCard" } } } } } }, "GetUploadResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get Upload Response", "properties": { "data": { "$ref": "#/components/schemas/Upload" } } } } } }, "GetUploadsStatusResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Get Uploads Status Response", "properties": { "data": { "type": "object", "properties": { "pending_numbers_count": { "type": "integer", "description": "The count of phone numbers that are pending assignment to the external connection." }, "pending_orders_count": { "type": "integer", "description": "The count of number uploads that have not yet been uploaded to Microsoft." } } } } } } } }, "GetWdrReportResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WdrReport" } } } } } }, "GetWdrReportsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WdrReport" } } } } } } }, "GlobalIpAllowedPortListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIPAllowedPort" } } } } } } }, "GlobalIpAssignmentListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIpAssignment" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GlobalIpAssignmentResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GlobalIpAssignment" } } } } } }, "GlobalIpAssignmentUsageResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIpAssignmentUsageMetric" } } } } } } }, "GlobalIpHealthCheckListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIPHealthCheck" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GlobalIpHealthCheckResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GlobalIPHealthCheck" } } } } } }, "GlobalIpHealthCheckTypesResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIpHealthCheckType" } } } } } } }, "GlobalIpHealthResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIpAssignmentHealthMetric" } } } } } } }, "GlobalIpLatencyResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIpLatencyMetric" } } } } } } }, "GlobalIpListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIP" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "GlobalIpProtocolListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIPProtocol" } } } } } } }, "GlobalIpResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GlobalIP" } } } } } }, "GlobalIpUsageResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalIpUsageMetric" } } } } } } }, "InitiateCallResponse": { "description": "Successful response upon initiating a TeXML call.", "content": { "application/json": { "schema": { "type": "object", "title": "Initiate TeXML Call Response", "properties": { "data": { "$ref": "#/components/schemas/InitiateCallResult" } } } } } }, "InventoryCoverageResponse": { "description": "Successful response with a list of inventory coverage levels", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryCoverage" } }, "meta": { "$ref": "#/components/schemas/InventoryCoverageMetadata" } } } } } }, "IpConnectionResponse": { "description": "Successful response with details about an IP connection.", "content": { "application/json": { "schema": { "type": "object", "title": "Ip Connection Response", "properties": { "data": { "$ref": "#/components/schemas/IpConnection" } } } } } }, "IpResponse": { "description": "Successful response with details about an IP.", "content": { "application/json": { "schema": { "type": "object", "title": "Ip Response", "properties": { "data": { "$ref": "#/components/schemas/Ip" } } } } } }, "ListAllowedFocWindows": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingOrdersAllowedFocWindow" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListAvailablePhoneNumbersBlockResponse": { "description": "Successful response with a list of available phone numbers blocks.", "content": { "application/json": { "schema": { "type": "object", "title": "List Available Phone Numbers Blocks Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AvailablePhoneNumberBlock" } }, "meta": { "$ref": "#/components/schemas/AvailablePhoneNumbersMetadata" } } } } } }, "ListAvailablePhoneNumbersResponse": { "description": "Successful response with a list of available phone numbers.", "content": { "application/json": { "schema": { "type": "object", "title": "List Available Phone Numbers Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AvailablePhoneNumber" } }, "meta": { "$ref": "#/components/schemas/AvailablePhoneNumbersMetadata" } } } } } }, "ListBillingGroupsResponse": { "description": "A paginated array of billing groups", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BillingGroup" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListBusinessIdentitiesResponse": { "description": "Successful response with a list of Business Identities.", "content": { "application/json": { "schema": { "type": "object", "title": "List Business Identities Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessIdentity" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListCallControlApplicationsResponse": { "description": "Successful response with a list of call control applications.", "content": { "application/json": { "schema": { "type": "object", "title": "List Call Control Applications Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CallControlApplication" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListCallEventsResponse": { "description": "Successful response with a list of call events.", "content": { "application/json": { "schema": { "type": "object", "title": "List Call Events Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CallEvent" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListConferencesResponse": { "description": "Successful response with a list of conferences.", "content": { "application/json": { "schema": { "type": "object", "title": "List Conferences Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Conference" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListConnectionsResponse": { "description": "Successful response with a list of connections.", "content": { "application/json": { "schema": { "type": "object", "title": "List Connections Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListCredentialConnectionsResponse": { "description": "Successful response with a list of credential connections.", "content": { "application/json": { "schema": { "type": "object", "title": "List Credential Connections Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialConnection" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListCsvDownloadsResponse": { "description": "Successful response with a list of CSV downloads.", "content": { "application/json": { "schema": { "type": "object", "title": "List CSV Downloads Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CsvDownload" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListCustomerServiceRecordPhoneNumberCoverage": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerServiceRecordPhoneNumberCoverage" } } } } } } }, "ListCustomerServiceRecords": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerServiceRecord" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListDocServiceDocumentLinksResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocServiceDocumentLink" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListDocServiceDocumentsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DocServiceDocument" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListDraftPortingOrdersWithoutPagination": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingOrder" } } }, "example": { "data": [ { "activation_settings": { "activation_status": null, "fast_port_eligible": true, "foc_datetime_actual": null, "foc_datetime_requested": null }, "created_at": "2022-03-17T18:01:01Z", "customer_reference": null, "description": "FP Telnyx", "documents": { "loa": null, "invoice": null }, "end_user": { "admin": { "account_number": null, "auth_person_name": null, "billing_phone_number": null, "business_identifier": null, "entity_name": null, "pin_passcode": null, "tax_identifier": null }, "location": { "administrative_area": null, "country_code": null, "extended_address": null, "locality": null, "postal_code": null, "street_address": null } }, "id": "b0ea6d6f-de31-4079-a536-992e0c98b037", "misc": null, "old_service_provider_ocn": "Unreal Communications", "parent_support_key": null, "phone_number_configuration": { "billing_group_id": null, "connection_id": null, "emergency_address_id": null, "messaging_profile_id": null, "tags": [] }, "phone_number_type": "local", "phone_numbers": [ { "activation_status": null, "phone_number": "{e.164 TN}", "phone_number_type": "local", "portability_status": "confirmed", "porting_order_id": "b0ea6d6f-de31-4079-a536-992e0c98b037", "porting_order_status": "draft", "record_type": "porting_phone_number", "requirements_status": "requirement-info-pending", "support_key": null } ], "porting_phone_numbers_count": 1, "record_type": "porting_order", "requirements": [], "requirements_met": false, "status": { "details": [], "value": "draft" }, "support_key": null, "updated_at": "2022-03-17T18:01:01Z", "user_feedback": { "user_comment": null, "user_rating": null }, "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75", "webhook_url": null } ] } } } } }, "ListExternalConnectionPhoneNumbersResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "List External Connection Phone Numbers Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalConnectionPhoneNumber" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListFaxesResponse": { "description": "List faxes response", "content": { "application/json": { "schema": { "type": "object", "title": "List Faxes Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fax" } }, "meta": { "type": "object", "example": { "page_number": 2, "page_size": 1, "total_pages": 3, "total_results": 3 } } } } } } }, "ListFqdnConnectionsResponse": { "description": "Successful response with a list of FQDN connections.", "content": { "application/json": { "schema": { "type": "object", "title": "List FQDN Connections Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FqdnConnection" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListFqdnsResponse": { "description": "Successful response with a list of FQDN connections.", "content": { "application/json": { "schema": { "type": "object", "title": "List FQDNs Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fqdn" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListIpConnectionsResponse": { "description": "Successful response with a list of IP connections.", "content": { "application/json": { "schema": { "type": "object", "title": "List Ip Connections Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IpConnection" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListIpsResponse": { "description": "Successful response with a list of IPs.", "content": { "application/json": { "schema": { "type": "object", "title": "List Ips Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Ip" } } } } } } }, "ListLogMessagesResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "List Log Messages Response", "properties": { "log_messages": { "type": "array", "items": { "$ref": "#/components/schemas/LogMessage" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListManagedAccountsAllocatableGlobalOutboundChannelsResponse": { "description": "Successful response with information about allocatable global outbound channels.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedAccountsGlobalOutboundChannels" } } } } } }, "ListManagedAccountsResponse": { "description": "Successful response with a list of managed accounts.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedAccountMultiListing" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListMediaResponse": { "description": "A response with a list of media resources", "content": { "application/json": { "schema": { "type": "object", "title": "List of media resources response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MediaResource" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListMessagingHostedNumberOrdersResponse": { "description": "Successful response with a list of messaging hosted number orders.", "content": { "application/json": { "schema": { "type": "object", "title": "List Messaging Hosted Number Order Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessagingHostedNumberOrder" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListMessagingProfileMetrics": { "description": "Successful response with a list of messaging profile metrics.", "content": { "application/json": { "schema": { "type": "object", "title": "List Messaging Profile Metrics Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessagingProfileHighLevelMetrics" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListMessagingProfilePhoneNumbersResponse": { "description": "Successful response with a list of messaging profile phone numbers.", "content": { "application/json": { "schema": { "type": "object", "title": "List Messaging Profile Phone Numbers Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberWithMessagingSettings" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListMessagingProfileShortCodesResponse": { "description": "Successful response with a list of messaging profile short codes.", "content": { "application/json": { "schema": { "type": "object", "title": "List Messaging Profile Short Codes Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShortCode" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListMessagingProfilesResponse": { "description": "Successful response with a list of messaging profiles.", "content": { "application/json": { "schema": { "type": "object", "title": "List Messaging Profiles Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessagingProfile" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListMessagingUrlDomains": { "description": "Successful response with details about a messaging URL domain.", "content": { "application/json": { "schema": { "type": "object", "title": "List Messaging Profile Url Domains Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessagingUrlDomain" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListNumberBlockOrdersResponse": { "description": "Successful response with a list of number block orders.", "content": { "application/json": { "schema": { "type": "object", "title": "List Number Block Orders Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberBlockOrder" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListNumberOrderDocumentsResponse": { "description": "Successful response with a list of number order documents.", "content": { "application/json": { "schema": { "type": "object", "title": "List Number Order Documents Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberOrderDocument" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListNumberOrderPhoneNumbersResponse": { "description": "Successful response with a list of number order phone numbers.", "content": { "application/json": { "schema": { "type": "object", "title": "List Number Order Phone Numbers Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberOrderPhoneNumber" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListNumberOrdersResponse": { "description": "Successful response with a list of number orders.", "content": { "application/json": { "schema": { "type": "object", "title": "List Number Orders Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberOrder" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListNumberReservationsResponse": { "description": "Successful response with a list of number reservations.", "content": { "application/json": { "schema": { "type": "object", "title": "List Number Reservations Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NumberReservation" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListOutboundVoiceProfilesResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "List Outbound Voice Profiles Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundVoiceProfile" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListParticipantsResponse": { "description": "Successful response with a list of conference participants.", "content": { "application/json": { "schema": { "type": "object", "title": "List Participants Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Participant" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPhoneNumberBlocksJobsResponse": { "description": "Successful response with a list of phone number blocks background jobs.", "content": { "application/json": { "schema": { "type": "object", "title": "List Phone Number Blocks Background Jobs Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberBlocksJob" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPhoneNumbersJobsResponse": { "description": "Successful response with a list of phone numbers background jobs.", "content": { "application/json": { "schema": { "type": "object", "title": "List Phone Numbers Background Jobs Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumbersJob" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPhoneNumbersResponse": { "description": "Successful response with a list of phone numbers.", "content": { "application/json": { "schema": { "type": "object", "title": "List Phone Numbers Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberDetailed" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPhoneNumbersWithMessagingSettingsResponse": { "description": "Successful response with a list of phone numbers with messaging settings.", "content": { "application/json": { "schema": { "type": "object", "title": "List Messaging Settings Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberWithMessagingSettings" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPhoneNumbersWithVoiceSettingsResponse": { "description": "Successful response with a list of phone numbers with voice settings.", "content": { "application/json": { "schema": { "type": "object", "title": "List Phone Numbers With Voice Settings Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberWithVoiceSettings" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPortingAdditionalDocuments": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingAdditionalDocument" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "example": { "data": [ { "id": "2acd1061-33cb-49b8-8014-beb6dc3fedbf", "document_id": "40bc547a-7f96-4cd5-926a-da4842671e88", "document_type": "loa", "porting_order_id": "9d7b3b8e-4e67-4837-9c44-d110cd2c82a1", "record_type": "porting_additional_document", "created_at": "2023-06-01T10:00:00.00000Z", "updated_at": "2023-06-01T10:00:00.00000Z" } ], "meta": { "total_pages": 1, "total_results": 1, "page_number": 1, "page_size": 25 } } } } } }, "ListPortingLOAConfigurations": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingLOAConfiguration" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPortingOrder": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingOrder" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPortingOrderRequirements": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingOrderRequirementDetail" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPortingOrdersActivationJobs": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingOrdersActivationJob" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPortingOrdersComments": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingOrdersComment" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPortingOrdersExceptionTypes": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingOrdersExceptionType" } } } } } } }, "ListPortingPhoneNumberConfigurations": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingPhoneNumberConfiguration" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPortingPhoneNumbers": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingPhoneNumber" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } }, "text/csv": { "schema": { "type": "string", "example": "phone_number,phone_number_type,porting_order_id,support_key,porting_order_status\r\n+12003155566,local,5f940c35-ef28-4408-bb95-af73b047d589,sr_a12345,draft\r\n" } } } }, "ListPortingReports": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingReport" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListPortingVerificationCodes": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingVerificationCode" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } }, "example": { "data": [ { "id": "52090326-6533-4421-bcf4-bd0117cf3954", "phone_number": "+61424000001", "verified": true, "porting_order_id": "f28e6ecc-29a8-430b-bd0b-d93055f70604", "created_at": "2020-10-22T15:00:00.000Z", "updated_at": "2020-10-22T15:00:00.000Z" }, { "id": "cf076b8e-645b-4040-8209-543c5909775f", "phone_number": "+61424000002", "verified": false, "porting_order_id": "f28e6ecc-29a8-430b-bd0b-d93055f70604", "created_at": "2020-10-22T15:00:00.000Z", "updated_at": "2020-10-22T15:00:00.000Z" } ], "meta": { "total_pages": 1, "total_results": 2, "page_number": 1, "page_size": 2 } } } } } }, "ListPortoutComments": { "description": "Portout Comments", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortoutComment" } }, "meta": { "$ref": "#/components/schemas/Metadata" } } } } } }, "ListPortoutResponse": { "description": "Portout Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortoutDetails" } }, "meta": { "$ref": "#/components/schemas/Metadata" } } } } } }, "ListPushCredentialsResponse": { "description": "Mobile mobile push credentials", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PushCredential" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "ListQueueCallsResponse": { "description": "Successful response with a list of calls in a queue.", "content": { "application/json": { "schema": { "type": "object", "title": "List Queue Calls Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/QueueCall" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListRecordingsResponse": { "description": "Successful response with a list of recordings.", "content": { "application/json": { "schema": { "type": "object", "title": "List Recordings Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Recording" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListReleasesResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "List Releases Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Release" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListRequirementsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DocReqsRequirementList" }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListRoomCompositionsResponse": { "description": "List room compositions response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoomComposition" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListRoomParticipantsResponse": { "description": "List room participants response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoomParticipant" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListRoomRecordingsResponse": { "description": "List room recordings response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoomRecording" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListRoomSessionsResponse": { "description": "List room sessions response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoomSession" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListRoomsResponse": { "description": "List rooms response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Room" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListShortCodesResponse": { "description": "Successful response with a list of short codes.", "content": { "application/json": { "schema": { "type": "object", "title": "List Short Codes Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShortCode" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListSubNumberOrdersResponse": { "description": "Successful response with a list of sub number orders.", "content": { "application/json": { "schema": { "type": "object", "title": "List Sub Number Orders Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubNumberOrder" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListTagsResponse": { "description": "Successful response with multiple tags", "content": { "application/json": { "schema": { "type": "object", "title": "List Tags Response", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string", "example": "a_tag" }, "amount": { "type": "integer", "example": 1 } } } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListUploadsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "List Uploads Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Upload" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListVerifiedCallsDisplayProfilesResponse": { "description": "Successful response with a list of Verified Calls Display Profiles.", "content": { "application/json": { "schema": { "type": "object", "title": "List Verified Calls Display Profiles Response", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "ListWebhookDeliveriesResponse": { "description": "A paginated array of webhook_delivery attempts", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/webhook_delivery" } }, "meta": { "$ref": "#/components/schemas/PaginationMetaSimple" } } } } } }, "ManagedAccountResponse": { "description": "Successful response with information about a single managed account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ManagedAccount" } } } } } }, "MediaDownloadResponse": { "description": "A response describing a media resource", "content": { "*/*": { "schema": { "type": "string", "format": "binary" } } } }, "MediaResponse": { "description": "A response describing a media resource", "content": { "application/json": { "schema": { "type": "object", "title": "Media resource response", "properties": { "data": { "$ref": "#/components/schemas/MediaResource" } } } } } }, "MessageResponse": { "description": "Successful response with details about a message.", "content": { "application/json": { "schema": { "type": "object", "title": "Message Response", "properties": { "data": { "$ref": "#/components/schemas/OutboundMessagePayload" } } } } } }, "MessagingHostedNumberOrderResponse": { "description": "Successful response with details about a messaging hosted number order.", "content": { "application/json": { "schema": { "type": "object", "title": "Retrieve Messaging Hosted Number Order Response", "properties": { "data": { "$ref": "#/components/schemas/MessagingHostedNumberOrder" } } } } } }, "MessagingHostedNumberResponse": { "description": "Successful response with details about a messaging hosted number.", "content": { "application/json": { "schema": { "type": "object", "title": "Retrieve Messaging Hosted Number Response", "properties": { "data": { "$ref": "#/components/schemas/HostedNumber" } } } } } }, "MessagingProfileResponse": { "description": "Successful response with details about a messaging profile.", "content": { "application/json": { "schema": { "type": "object", "title": "Messaging Profile Response", "properties": { "data": { "$ref": "#/components/schemas/MessagingProfile" } } } } } }, "NetworkInterfaceListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkInterface" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "NetworkListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Network" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "NetworkResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Network" } } } } } }, "NotFoundErrorResponse": { "description": "Resource Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "NotFoundResponse": { "description": "Resource not found", "content": { "application/json": { "schema": { "type": "object", "title": "Resource not found", "properties": { "data": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } } }, "NumberBlockOrderResponse": { "description": "Successful response with details about a number block order.", "content": { "application/json": { "schema": { "type": "object", "title": "Number Block Order Response", "properties": { "data": { "$ref": "#/components/schemas/NumberBlockOrder" } } } } } }, "NumberLookupResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Number Lookup Response", "properties": { "data": { "$ref": "#/components/schemas/NumberLookupRecord" } } } } } }, "NumberOrderDocumentResponse": { "description": "Successful response with details about a number order document.", "content": { "application/json": { "schema": { "type": "object", "title": "Number Order Document Response", "properties": { "data": { "$ref": "#/components/schemas/NumberOrderDocument" } } } } } }, "NumberOrderPhoneNumberResponse": { "description": "Successful response with details about a number order phone number.", "content": { "application/json": { "schema": { "type": "object", "title": "Number Order Phone Number Response", "properties": { "data": { "$ref": "#/components/schemas/NumberOrderPhoneNumber" } } } } } }, "NumberOrderResponse": { "description": "Successful response with details about a number order.", "content": { "application/json": { "schema": { "type": "object", "title": "Number Order Response", "properties": { "data": { "$ref": "#/components/schemas/NumberOrderWithPhoneNumbers" } } } } } }, "NumberReservationResponse": { "description": "Successful response with details about a number reservation.", "content": { "application/json": { "schema": { "type": "object", "title": "Number Reservation Response", "properties": { "data": { "$ref": "#/components/schemas/NumberReservation" } } } } } }, "OTAUpdateResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompleteOTAUpdate" } } } } } }, "OutboundVoiceProfileResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Outbound Voice Profile Response", "properties": { "data": { "$ref": "#/components/schemas/OutboundVoiceProfile" } } } } } }, "PUTSIMCardNetworkPreferenceResponse": { "description": "A successful network preferences definition response.

\nThe sent mobile_network_operators_preferences parameter won't be applied to the main resource right away - this is an asynchronous operation. While interacting with this API, you will face the following scenarios:\n\n * The first request for this API will return an empty mobile_network_operators_preferences with an in-progress OTA update resource in the ota_updates node containing the exact sent parameters to indicate the operation progress. The value will be applied to the principal object when the OTA update finishes its processing, thus indicating the SIM card network preference current state. \n * The subsequent requests will contain the current state, that is what's applied to the SIM card settings, and return the related OTA update in the ota_updates node.\n \nThe returned OTA updated (present in the ota_updates node) will, by default, be the resource related to the operation, not all of them.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates" } } } } } }, "PatchGcbChannelZoneRequestResponse": { "description": "Successfuly patched channel zone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GcbChannelZone" } } } }, "PatchRoomResponse": { "description": "Update room response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Room" } } } } } }, "PhoneNumberResponse": { "description": "Successful response with details about a phone number.", "content": { "application/json": { "schema": { "type": "object", "title": "Phone Number Response", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberDetailed" } } } } } }, "PhoneNumberWithMessagingSettingsResponse": { "description": "Successful response with details about a phone number including voice settings.", "content": { "application/json": { "schema": { "type": "object", "title": "Retrieve Messaging Settings Response", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberWithMessagingSettings" } } } } } }, "PhoneNumberWithVoiceSettingsResponse": { "description": "Successful response with details about a phone number including voice settings.", "content": { "application/json": { "schema": { "type": "object", "title": "Retrieve Phone Number Voice Response", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberWithVoiceSettings" } } } } } }, "PortOutListSupportingDocumentsResponse": { "description": "Portout Supporting Documents", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortOutSupportingDocument" } } } } } } }, "PortabilityCheckResponse": { "description": "PortabilityCheck Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortabilityCheckDetails" } } } } } } }, "PortoutCommentResponse": { "description": "Portout Comment Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortoutComment" } } } } } }, "PortoutResponse": { "description": "Portout Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortoutDetails" } } } } } }, "PostGcbPhoneNumberRequestResponse": { "description": "A new inserted phone number", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GcbPhoneNumber" } } } }, "PresignedObjectUrlResponse": { "description": "Presigned URL Object Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedObjectUrl" } } } }, "PublicInternetGatewayListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PublicInternetGatewayRead" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "PublicInternetGatewayResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PublicInternetGatewayRead" } } } } } }, "PushCredentialResponse": { "description": "Success response with details about a push credential", "properties": { "data": { "$ref": "#/components/schemas/PushCredential" } } }, "QueueCallResponse": { "description": "Successful response with details about a call in a queue.", "content": { "application/json": { "schema": { "type": "object", "title": "Queue Call Response", "properties": { "data": { "$ref": "#/components/schemas/QueueCall" } } } } } }, "QueueResponse": { "description": "Successful response with details about a queue.", "content": { "application/json": { "schema": { "type": "object", "title": "Queue Response", "properties": { "data": { "$ref": "#/components/schemas/Queue" } } } } } }, "ReadCommentResponse": { "description": "A Comment Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReadComment" }, { "type": "object" } ] } } } } } }, "RecordingResponse": { "description": "Successful response with details about a recording.", "content": { "application/json": { "schema": { "type": "object", "title": "Get Recording Response", "properties": { "data": { "$ref": "#/components/schemas/Recording" } } } } } }, "RecordingResponseBody": { "description": "A response with recording resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordingResponse" } } } }, "RecordingsResponseBody": { "description": "A response with recordings.", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecordingResponse" } } } } } } }, "RefreshFaxResponse": { "description": "Refresh fax response", "content": { "application/json": { "schema": { "type": "object", "title": "Refresh Fax Response", "example": { "data": { "result": "ok" } }, "properties": { "result": { "type": "string", "example": "ok" } } } } } }, "RefreshRoomClientTokenResponse": { "description": "Refresh room client token response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "token": { "type": "string", "format": "jwt", "example": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ" }, "token_expires_at": { "description": "ISO 8601 timestamp when the token expires.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59Z" } }, "example": { "token": "eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0.eyJhdWQiOiJ0ZWxueXhfYWNjZXNzX3Rva2VuIiwiZXhwIjoxNjE5MDk0Mjk1LCJncmFudHMiOlt7ImFjdGlvbnMiOlsiam9pbiJdLCJyZXNvdXJjZXMiOlsidGVsbnl4OnZpZGVvOnJvb21zOjllMmEwY2JlLWNlNjYtNDExZS1hMWFjLTQ2OGYwYjEwM2M5YSJdLCJzdWJqZWN0cyI6WyJ0ZWxueXg6dXNlcnM6NzgyYjJjYmUtODQ2Ni00ZTNmLWE0ZDMtOTc4MWViNTc3ZTUwIl19XSwiZ3JhbnRzX3ZlcnNpb24iOiIxLjAuMCIsImlhdCI6MTYxOTA5MzY5NSwiaXNzIjoidGVsbnl4X2FjY2Vzc190b2tlbiIsImp0aSI6IjllNjIyOTA2LTc1ZTctNDBiNi1iOTAwLTc1NGIxZjNlZDMyZiIsIm5iZiI6MTYxOTA5MzY5NCwic3ViIjoibnVsbCIsInR5cCI6ImFjY2VzcyJ9.1JGK9PyHkTtoP_iMu-8TzXH_fhmnsDtZZOAJLDzLW6DDtAb80wZ93l1VH5yNx5tFqwIFG0t48dRiBKWlW-nzDA", "token_expires_at": "2021-04-22T12:24:55Z" } } } } } } }, "RegionListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Region" } } } } } } }, "RegisterCallResponse": { "description": "Successful response upon making a register call command.", "content": { "application/json": { "schema": { "type": "object", "title": "Register Call Response", "properties": { "data": { "type": "object", "title": "Register Call Command Result", "example": { "result": "ok" }, "properties": { "result": { "type": "string", "example": "ok" } } } } } } } }, "RegisterSimCardsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "description": "Successfully registered SIM cards.", "type": "array", "items": { "$ref": "#/components/schemas/SimpleSIMCard" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } }, "RegistrationStatusResponse": { "description": "Successful response with details about a credential connection registration status.", "content": { "application/json": { "schema": { "type": "object", "title": "Registration Status Response", "properties": { "data": { "type": "object", "title": "Registration Status", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "registration_status" }, "status": { "type": "string", "description": "The current registration status of your SIP connection", "enum": [ "Not Applicable", "Not Registered", "Failed", "Expired", "Registered", "Unregistered" ] }, "sip_username": { "type": "string", "description": "The user name of the SIP connection", "example": "sip_username" }, "ip_address": { "type": "string", "description": "The ip used during the SIP connection", "example": "190.106.106.121" }, "transport": { "type": "string", "description": "The protocol of the SIP connection", "example": "TCP" }, "port": { "type": "integer", "description": "The port of the SIP connection", "example": 37223 }, "user_agent": { "type": "string", "description": "The user agent of the SIP connection", "example": "Z 5.4.12 v2.10.13.2-mod" }, "last_registration": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was last updated.", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "data": { "record_type": "registration_status", "status": "Expired", "sip_username": "rogerp", "ip_address": "190.106.106.121", "transport": "UDP", "port": 37223, "user_agent": "Z 5.4.12 v2.10.13.2-mod", "last_registration": "2021-09-28T15:11:02", "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } } } } } } } }, "ResourceNotFound": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "ResourceNotFoundErrorResponse": { "description": "Resource not found", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceNotFoundError" } } } } } } }, "RetrieveBillingGroupResponse": { "description": "Expected billing group response to a valid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BillingGroup" } } } } } }, "RetrieveCallStatusResponse": { "description": "Successful response with details about a call status.", "content": { "application/json": { "schema": { "type": "object", "title": "Retrieve Call Status Response", "properties": { "data": { "$ref": "#/components/schemas/Call" } } } } } }, "RetrieveLedgerBillingGroupReportResponse": { "description": "Expected ledger billing group report response to a valid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LedgerBillingGroupReport" } } } } } }, "RetrieveMessagingProfileMetrics": { "description": "Successful response with details about a messaging profile's metrics.", "content": { "application/json": { "schema": { "type": "object", "title": "Retrieve Messaging Profile Metrics Response", "properties": { "data": { "$ref": "#/components/schemas/MessagingProfileDetailedMetrics" } } } } } }, "RetrievePortoutResponse": { "description": "Expected portout response to a valid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortoutDetails" } } } } } }, "SIMCardActionResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardAction" } } } } }, "description": "Successful Response" }, "SIMCardActivationCodeResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardActivationCode" } } } } } }, "SIMCardDeviceDetailsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardDeviceDetails" } } } } } }, "SIMCardGroupActionResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardGroupAction" } } } } }, "description": "Successful Response" }, "SIMCardNetworkPreferenceResponse": { "description": "A successful network preferences definition response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardNetworkPreference" } } } } } }, "SIMCardNetworkPreferenceWithOTAUpdatesResponse": { "description": "A successful network preferences definition response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardNetworkPreferenceWithOTAUpdates" } } } } } }, "SIMCardOrdersPreviewResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardOrderPreview" } } } } } }, "SIMCardPublicIPResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardPublicIP" } } } } } }, "SSLCertificateResponse": { "description": "SSL Certificate Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SSLCertificate" } } } } } }, "SearchMobileNetworkOperatorsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MobileNetworkOperator" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "SearchOTAUpdateResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SimplifiedOTAUpdate" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "SearchSimCardsResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SimpleSIMCard" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "SendFaxResponse": { "description": "Send fax response", "content": { "application/json": { "schema": { "type": "object", "title": "Send Fax Response", "properties": { "data": { "$ref": "#/components/schemas/Fax" } } } } } }, "SharePortingOrder": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingOrderSharingToken" } } }, "example": { "id": "03a35311-ad92-46b3-95d7-8ad6dccf2d7c", "porting_order_id": "fd4b86c8-497d-4c6d-9609-a789e4e14cfe", "expires_in_seconds": 3600, "permissions": [ "porting_order.document.read", "porting_order.document.update" ], "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODk4OTQ2NzcsImlzdCI6MTY4OTg5MTA3NywicGVybWlzc2lvbnMiOlsicG9ydGluZ19vcmRlci5kb2N1bWVudC5yZWFkIl0sInBvcnRpbmdfb3JkZXJfaWQiOiJmZDRiODZjOC00OTdkLTRjNmQtOTYwOS1hNzg5ZTRlMTRjZmUifQ.CT0HRF6OLj7VPZ8p5Y_0S8rOL8SEUznwJJkR-YReKwc", "record_type": "porting_order_sharing_token", "expires_at": "2023-07-20T23:11:17Z", "created_at": "2023-07-20T22:11:17.292573Z" } } } }, "ShortCodeResponse": { "description": "Successful response with details about a short code.", "content": { "application/json": { "schema": { "type": "object", "title": "Short Code Response", "properties": { "data": { "$ref": "#/components/schemas/ShortCode" } } } } } }, "ShowCustomerServiceRecord": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomerServiceRecord" } } } } } }, "ShowPortingLOAConfiguration": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingLOAConfiguration" } } } } } }, "ShowPortingOrder": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingOrder" }, "meta": { "type": "object", "properties": { "phone_numbers_url": { "type": "string", "description": "Link to list all phone numbers", "example": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222" } } } } } } } }, "ShowPortingOrdersActivationJob": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingOrdersActivationJob" } } } } } }, "ShowPortingOrdersComment": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingOrdersComment" } } } } } }, "ShowPortingPhoneNumber": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingPhoneNumber" }, "meta": { "type": "object", "properties": { "porting_order_url": { "type": "string", "format": "uri", "description": "Link to list porting order", "example": "/porting_orders/a700d03c-4062-4091-8189-1b75216cf7a2" } } } } } } } }, "ShowPortingReport": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingReport" } } } } } }, "SimCardActionCollectionResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SIMCardAction" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } }, "description": "Successful response" }, "SimCardDataUsageNotificationCollectionResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SimCardDataUsageNotification" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } }, "description": "Successful response" }, "SimCardGroupActionCollectionResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SIMCardGroupAction" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } }, "description": "Successful response" }, "SimpleSimCardResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SimpleSIMCard" } } } } } }, "SubNumberOrderResponse": { "description": "Successful response with details about a sub number order.", "content": { "application/json": { "schema": { "type": "object", "title": "Sub Number Order Response", "properties": { "data": { "$ref": "#/components/schemas/SubNumberOrder" } } } } } }, "SubRequestByPortingOrder": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetSubRequestByPortingOrder" } } } } } }, "TelephonyCredentialResponse": { "description": "Successful response with details about a credential", "content": { "application/json": { "schema": { "type": "object", "title": "Telephony Credential Response", "properties": { "data": { "$ref": "#/components/schemas/TelephonyCredential" } } } } } }, "TexmlApplicationResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "title": "Texml Application Response", "properties": { "data": { "$ref": "#/components/schemas/TexmlApplication" } } } } } }, "TexmlCreateCallRecordingResponse": { "description": "Successful call recording create response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TexmlCreateCallRecordingResponseBody" } } } }, "TexmlGetCallRecordingResponse": { "description": "Retrieves call recording resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TexmlGetCallRecordingResponseBody" } } } }, "TexmlGetCallRecordingsResponse": { "description": "Successful Get Call Recordings Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TexmlGetCallRecordingsResponseBody" } } } }, "UnauthenticatedResponse": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "Authentication Failed": { "value": { "errors": [ { "code": "10009", "title": "Authentication failed", "detail": "Could not understand the provided credentials.", "meta": { "url": "https://developers.telnyx.com/docs/overview/errors/10009" } } ] } } } } } }, "UnauthorizedErrorResponse": { "description": "The required authentication headers were either invalid or not included in the request.", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnauthorizedError" } } } } } } }, "UnauthorizedRequestErrorResponse": { "description": "Unauthorized Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "UnauthorizedResponse": { "description": "Unauthenticated response. Happens when the current user cannot be authenticated." }, "UnexpectedErrorResponse": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnexpectedError" } } } } } } }, "UnprocessableEntity": { "description": "Unprocessable entity. Check the 'detail' field in response for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "UnprocessableEntityErrorResponse": { "description": "Unprocessable entity. Check the 'detail' field in response for details.", "content": { "application/json": { "schema": { "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnprocessableEntityError" } } } } } } }, "UnprocessableEntityResponse": { "description": "Unprocessable entity" }, "UnprocessableManagedAccountEntity": { "description": "Unprocessable entity. Check the 'detail' field in response for details.", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/UnprocessableEntityError" } } } } } } }, "UpdateBillingGroupResponse": { "description": "Expected billing group response to a valid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BillingGroup" } } } } } }, "UpdateManagedAccountGlobalChannelLimitResponse": { "description": "Successful response with information about the allocatable global outbound channels for the given account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SingleManagedAccountGlobalOutboundChannels" } } } } } }, "UpdatePortingLOAConfiguration": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingLOAConfiguration" } } } } } }, "UpdatePortingOrderResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortingOrder" }, "meta": { "type": "object", "properties": { "phone_numbers_url": { "type": "string", "description": "Link to list all phone numbers" } } } }, "example": { "data": { "activation_settings": { "activation_status": null, "fast_port_eligible": true, "foc_datetime_actual": null, "foc_datetime_requested": "2022-04-08T15:00:00Z" }, "created_at": "2022-03-24T14:22:28Z", "customer_reference": "Test1234", "description": "FP Telnyx", "documents": { "loa": null, "invoice": null }, "end_user": { "admin": { "account_number": "123abc", "auth_person_name": "Porter McPortersen II", "billing_phone_number": "+13035551234", "business_identifier": "abc123", "entity_name": "Porter McPortersen", "pin_passcode": "1234", "tax_identifier": "1234abcd" }, "location": { "administrative_area": "IL", "country_code": "US", "extended_address": "Suite 504", "locality": "Chicago", "postal_code": "60654", "street_address": "311 W. Superior St" } }, "id": "eef10fb8-f3df-4c67-97c5-e18179723222", "misc": { "new_billing_phone_number": null, "remaining_numbers_action": null, "type": "full" }, "old_service_provider_ocn": "Unreal Communications", "parent_support_key": null, "phone_number_configuration": { "billing_group_id": null, "connection_id": "1752379429071357070", "emergency_address_id": null, "messaging_profile_id": null, "tags": [] }, "phone_number_type": "local", "porting_phone_numbers_count": 1, "record_type": "porting_order", "requirements": [], "requirements_met": false, "status": { "details": [], "value": "draft" }, "support_key": null, "updated_at": "2022-03-24T14:26:53Z", "user_feedback": { "user_comment": null, "user_rating": null }, "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75", "webhook_url": "https://example.com/porting_webhooks" }, "meta": { "phone_numbers_url": "/v2/porting_phone_numbers?filter[porting_order_id]=eef10fb8-f3df-4c67-97c5-e18179723222" } } } } } }, "UpdatePortoutResponse": { "description": "Expected portout response to a valid request", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PortoutDetails" } } } } } }, "UpdateSimCardDataUsageNotificationResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SimCardDataUsageNotification" } } } } } }, "UpdateSimCardGroupResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCardGroup" } } } } }, "description": "Successful Response" }, "UpdateSimCardResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SIMCard" } } } } } }, "UpdateTeXMLCallResponse": { "description": "Successful response upon updating a TeXML call.", "content": { "application/json": { "schema": { "type": "object", "title": "TeXML REST Command Response", "properties": { "data": { "$ref": "#/components/schemas/UpdateCommandResult" } } } } } }, "UserBalanceResponse": { "description": "Get user balance details", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserBalance" } } } } } }, "ValidateAddressResponse": { "description": "Action response", "content": { "application/json": { "schema": { "type": "object", "title": "Validate address action response", "properties": { "data": { "$ref": "#/components/schemas/ValidateAddressResult" } } } } } }, "VerifyPortingVerificationCodes": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PortingVerificationCode" } } }, "example": { "data": [ { "id": "52090326-6533-4421-bcf4-bd0117cf3954", "phone_number": "+61424000001", "verified": true, "porting_order_id": "f28e6ecc-29a8-430b-bd0b-d93055f70604", "created_at": "2020-10-22T15:00:00.000Z", "updated_at": "2020-10-22T15:00:00.000Z" }, { "id": "cf076b8e-645b-4040-8209-543c5909775f", "phone_number": "+61424000002", "verified": false, "porting_order_id": "f28e6ecc-29a8-430b-bd0b-d93055f70604", "created_at": "2020-10-22T15:00:00.000Z", "updated_at": "2020-10-22T15:00:00.000Z" } ] } } } } }, "VirtualCrossConnectListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualCrossConnectCombined" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "VirtualCrossConnectRegionListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualCrossConnectRegion" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "VirtualCrossConnectRegionResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/VirtualCrossConnectRegion" } } } } } }, "VirtualCrossConnectResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/VirtualCrossConnectCombined" } } } } } }, "WireguardInterfaceListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WireguardInterfaceRead" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "WireguardInterfaceResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WireguardInterfaceRead" } } } } } }, "WireguardPeerAllowedIPListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WireguardPeerAllowedIP" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "WireguardPeerAllowedIPResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WireguardPeerAllowedIP" } } } } } }, "WireguardPeerListResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WireguardPeer" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "WireguardPeerResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WireguardPeer" } } } } } }, "WirelessConnectivityLogCollectionResponse": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WirelessConnectivityLog" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } }, "description": "Successful response" }, "displayBusinessIdentityResponse": { "description": "Successful response with a Business Identity.", "content": { "application/json": { "schema": { "type": "object", "title": "Show Business Identity Response", "properties": { "data": { "$ref": "#/components/schemas/BusinessIdentity" } } } } } }, "displayVerifiedCallsDisplayProfileResponse": { "description": "Successful response with a Verified Calls Display Profile.", "content": { "application/json": { "schema": { "type": "object", "title": "Show Verified Calls Display Profile Response", "properties": { "data": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile" } } } } } }, "listCommentsResponse": { "description": "An array of Comment Responses", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "listDynamicEmergencyAddresses": { "description": "Dynamic Emergency Address Responses", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicEmergencyAddress" } }, "meta": { "$ref": "#/components/schemas/Metadata" } } } } } }, "listDynamicEmergencyEndpoints": { "description": "Dynamic Emergency Endpoints Responses", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicEmergencyEndpoint" } }, "meta": { "$ref": "#/components/schemas/Metadata" } } } } } }, "listRegulatoryRequirements": { "description": "An array of Regulatory Requiremenst Responses", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RegulatoryRequirements" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } } }, "schemas": { "AcceptSuggestionsRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the address." } } }, "AccessIPAddressListResponseSchema": { "title": "AccessIPAddressListResponseSchema", "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/AccessIPAddressResponseSchema" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "AccessIPAddressPOST": { "title": "AccessIPAddressPOST", "required": [ "ip_address" ], "type": "object", "properties": { "ip_address": { "title": "Ip Address", "type": "string" }, "description": { "title": "Description", "type": "string" } } }, "AccessIPAddressResponseSchema": { "title": "AccessIPAddressResponseSchema", "required": [ "id", "ip_address", "source", "status", "user_id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "ip_address": { "title": "Ip Address", "type": "string" }, "source": { "title": "Source", "type": "string" }, "status": { "$ref": "#/components/schemas/CloudflareSyncStatus" }, "description": { "title": "Description", "type": "string" }, "user_id": { "title": "User Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string", "format": "date-time" }, "updated_at": { "title": "Updated At", "type": "string", "format": "date-time" } } }, "AccessIPRangeListResponseSchema": { "title": "AccessIPRangeListResponseSchema", "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/AccessIPRangeResponseSchema" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "AccessIPRangePOST": { "title": "AccessIPRangePOST", "required": [ "cidr_block" ], "type": "object", "properties": { "cidr_block": { "title": "Cidr Block", "type": "string" }, "description": { "title": "Description", "type": "string" } } }, "AccessIPRangeResponseSchema": { "title": "AccessIPRangeResponseSchema", "required": [ "id", "cidr_block", "status", "user_id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "cidr_block": { "title": "Cidr Block", "type": "string" }, "status": { "$ref": "#/components/schemas/CloudflareSyncStatus" }, "description": { "title": "Description", "type": "string" }, "user_id": { "title": "User Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string", "format": "date-time" }, "updated_at": { "title": "Updated At", "type": "string", "format": "date-time" } } }, "AccountSid": { "type": "string", "example": "61bf923e-5e4d-4595-a110-56190ea18a1b" }, "ActionsParticipantsRequest": { "type": "object", "properties": { "participants": { "description": "Either a list of participant id to perform the action on, or the keyword \"all\" to perform the action on all participant.", "oneOf": [ { "type": "string", "example": "all", "enum": [ "all" ] }, { "type": "array", "items": { "type": "string", "format": "uuid", "example": "7b61621f-62e0-4aad-ab11-9fd19e272e73" } } ] }, "exclude": { "description": "List of participant id to exclude from the action.", "type": "array", "items": { "type": "string", "format": "uuid", "example": "7b61621f-62e0-4aad-ab11-9fd19e272e73" } } } }, "ActiveCall": { "type": "object", "title": "Active Call", "required": [ "call_control_id", "call_leg_id", "call_session_id", "client_state", "record_type", "call_duration" ], "example": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768", "call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "call_duration": 50, "record_type": "call" }, "properties": { "record_type": { "type": "string", "enum": [ "call" ], "example": "call" }, "call_session_id": { "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call", "type": "string", "example": "428c31b6-7af4-4bcb-b68e-5013ef9657c1" }, "call_leg_id": { "description": "ID that is unique to the call and can be used to correlate webhook events", "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1" }, "call_control_id": { "description": "Unique identifier and token for controlling the call.", "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" }, "client_state": { "description": "State received from a command.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "call_duration": { "description": "Indicates the duration of the call in seconds", "type": "integer", "example": 50 } } }, "Address": { "type": "object", "title": "Address", "properties": { "id": { "type": "string", "format": "int64", "description": "Uniquely identifies the address.", "example": "1293384261075731499" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "address" }, "customer_reference": { "$ref": "#/components/schemas/customer_reference" }, "first_name": { "$ref": "#/components/schemas/first_name" }, "last_name": { "$ref": "#/components/schemas/last_name" }, "business_name": { "$ref": "#/components/schemas/business_name" }, "phone_number": { "$ref": "#/components/schemas/phone_number" }, "street_address": { "$ref": "#/components/schemas/street_address" }, "extended_address": { "$ref": "#/components/schemas/extended_address" }, "locality": { "$ref": "#/components/schemas/locality" }, "administrative_area": { "$ref": "#/components/schemas/administrative_area" }, "neighborhood": { "$ref": "#/components/schemas/neighborhood" }, "borough": { "$ref": "#/components/schemas/borough" }, "postal_code": { "$ref": "#/components/schemas/postal_code" }, "country_code": { "$ref": "#/components/schemas/country_code" }, "address_book": { "$ref": "#/components/schemas/address_book" }, "validate_address": { "$ref": "#/components/schemas/validate_address" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" } } }, "AddressCreate": { "type": "object", "required": [ "first_name", "last_name", "business_name", "street_address", "locality", "country_code" ], "properties": { "customer_reference": { "$ref": "#/components/schemas/customer_reference" }, "first_name": { "$ref": "#/components/schemas/first_name" }, "last_name": { "$ref": "#/components/schemas/last_name" }, "business_name": { "$ref": "#/components/schemas/business_name" }, "phone_number": { "$ref": "#/components/schemas/phone_number" }, "street_address": { "$ref": "#/components/schemas/street_address" }, "extended_address": { "$ref": "#/components/schemas/extended_address" }, "locality": { "$ref": "#/components/schemas/locality" }, "administrative_area": { "$ref": "#/components/schemas/administrative_area" }, "neighborhood": { "$ref": "#/components/schemas/neighborhood" }, "borough": { "$ref": "#/components/schemas/borough" }, "postal_code": { "$ref": "#/components/schemas/postal_code" }, "country_code": { "$ref": "#/components/schemas/country_code" }, "address_book": { "$ref": "#/components/schemas/address_book" }, "validate_address": { "$ref": "#/components/schemas/validate_address" } } }, "AddressSuggestionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "accepted": { "type": "boolean", "description": "Indicates if the address suggestions are accepted." }, "id": { "type": "string", "format": "uuid", "description": "The UUID of the location." }, "record_type": { "type": "string", "enum": [ "address_suggestion" ] } } } } }, "AltBusinessIdType": { "title": "AltBusinessIdType", "enum": [ "NONE", "DUNS", "GIIN", "LEI" ], "description": "An enumeration." }, "AmdDetailRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "Feature invocation id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "invoked_at": { "type": "string", "description": "Feature invocation time", "format": "date-time", "example": "2020-07-01T00:00:00Z" }, "feature": { "type": "string", "description": "Feature name", "enum": [ "PREMIUM" ] }, "tags": { "type": "string", "description": "User-provided tags", "example": "tag1,tag2" }, "billing_group_id": { "type": "string", "description": "Billing Group id", "example": "01977831-abdd-4894-84f3-244385621424" }, "billing_group_name": { "type": "string", "description": "Name of the Billing Group specified in billing_group_id", "example": "Billing group name" }, "connection_id": { "type": "string", "description": "Connection id", "example": "1684947189014463919" }, "connection_name": { "type": "string", "description": "Connection name", "example": "Name of the connection with id specified in connection_id field" }, "call_leg_id": { "type": "string", "description": "Telnyx UUID that identifies the related call leg", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "call_session_id": { "type": "string", "description": "Telnyx UUID that identifies the related call session", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "is_telnyx_billable": { "type": "boolean", "description": "Indicates whether Telnyx billing charges might be applicable", "example": true }, "rate": { "type": "string", "description": "Currency amount per billing unit used to calculate the Telnyx billing cost", "example": "0.002" }, "rate_measured_in": { "type": "string", "description": "Billing unit used to calculate the Telnyx billing cost", "example": "invocations" }, "cost": { "type": "string", "description": "Currency amount for Telnyx billing cost", "example": "0.004" }, "currency": { "type": "string", "description": "Telnyx account currency used to describe monetary values, including billing cost", "example": "USD" }, "record_type": { "type": "string", "example": "amd_detail_record", "default": "amd_detail_record" } }, "required": [ "record_type" ] }, "AnchorsiteOverride": { "title": "Anchorsite Override", "type": "string", "description": "`Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.", "enum": [ "Latency", "Chicago, IL", "Ashburn, VA", "San Jose, CA", "Sydney, Australia", "Amsterdam, Netherlands", "London, UK", "Toronto, Canada", "Vancouver, Canada", "Frankfurt, Germany" ], "default": "Latency", "example": "Amsterdam, Netherlands" }, "AnswerRequest": { "type": "object", "title": "Answer Request", "properties": { "billing_group_id": { "description": "Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID.", "type": "string", "format": "uuid", "example": "f5586561-8ff0-4291-a0ac-84fe544797bd" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "custom_headers": { "description": "Custom headers to be added to the SIP INVITE response.", "type": "array", "example": [ { "name": "head_1", "value": "val_1" }, { "name": "head_2", "value": "val_2" } ], "items": { "$ref": "#/components/schemas/CustomSipHeader" } }, "sip_headers": { "description": "SIP headers to be added to the SIP INVITE response. Currently only User-to-User header is supported.", "type": "array", "example": [ { "name": "User-to-User", "value": "value" } ], "items": { "$ref": "#/components/schemas/SipHeader" } }, "sound_modifications": { "$ref": "#/components/schemas/SoundModifications" }, "stream_url": { "description": "The destination WebSocket address where the stream is going to be delivered.", "type": "string", "example": "wss://www.example.com/websocket" }, "stream_track": { "description": "Specifies which track should be streamed.", "type": "string", "enum": [ "inbound_track", "outbound_track", "both_tracks" ], "default": "inbound_track", "example": "both_tracks" }, "send_silence_when_idle": { "description": "Generate silence RTP packets when no transmission available.", "type": "boolean", "default": false, "example": true }, "webhook_url": { "description": "Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.", "type": "string", "example": "https://www.example.com/server-b/" }, "webhook_url_method": { "description": "HTTP request type used for `webhook_url`.", "default": "POST", "type": "string", "enum": [ "POST", "GET" ], "example": "GET" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "webhook_url": "https://www.example.com/server-b/", "webhook_url_method": "POST", "send_silence_when_idle": true } }, "ApplicationName": { "title": "Application Name", "type": "string", "description": "A user-assigned name to help manage the application.", "example": "call-router" }, "AssignProfileToCampaignRequest": { "title": "AssignProfileToCampaignRequest", "required": [ "messagingProfileId" ], "type": "object", "properties": { "messagingProfileId": { "title": "Messagingprofileid", "type": "string", "description": "The ID of the messaging profile that you want to link to the specified campaign.", "example": "4001767e-ce0f-4cae-9d5f-0d5e636e7809" }, "tcrCampaignId": { "title": "Tcrcampaignid", "type": "string", "description": "The TCR ID of the shared campaign you want to link to the specified messaging profile (for campaigns not created using Telnyx 10DLC services only). If you supply this ID in the request, do not also include a campaignId.", "example": "CWZTFH1" }, "campaignId": { "title": "Campaignid", "type": "string", "description": "The ID of the campaign you want to link to the specified messaging profile. If you supply this ID in the request, do not also include a tcrCampaignId.", "example": "4b300178-131c-d902-d54e-72d90ba1620j" } } }, "AssignProfileToCampaignResponse": { "title": "AssignProfileToCampaignResponse", "required": [ "messagingProfileId", "taskId" ], "type": "object", "properties": { "messagingProfileId": { "title": "Messagingprofileid", "type": "string", "description": "The ID of the messaging profile that you want to link to the specified campaign.", "example": "4001767e-ce0f-4cae-9d5f-0d5e636e7809" }, "tcrCampaignId": { "title": "Tcrcampaignid", "type": "string", "description": "The TCR ID of the shared campaign you want to link to the specified messaging profile (for campaigns not created using Telnyx 10DLC services only). If you supply this ID in the request, do not also include a campaignId.", "example": "CWZTFH1" }, "campaignId": { "title": "Campaignid", "type": "string", "description": "The ID of the campaign you want to link to the specified messaging profile. If you supply this ID in the request, do not also include a tcrCampaignId.", "example": "4b300178-131c-d902-d54e-72d90ba1620j" }, "taskId": { "title": "Taskid", "type": "string", "description": "The ID of the task associated with assigning a messaging profile to a campaign.", "example": "667a80f8-b0a9-49d0-b9ab-a7a1bcc45086" } } }, "AssignmentStatus": { "description": "An enumeration.", "enum": [ "pending", "assigned", "failed" ], "title": "AssignmentStatus", "type": "string" }, "AssignmentTaskStatusResponse": { "title": "AssignmentTaskStatusResponse", "required": [ "taskId", "status" ], "type": "object", "properties": { "taskId": { "title": "Taskid", "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/TaskStatus" } ], "type": "string", "description": "The status of the task associated with assigning a messaging profile to a campaign.", "example": "pending" }, "createdAt": { "title": "Createdat", "type": "string", "format": "date-time" }, "updatedAt": { "title": "Updatedat", "type": "string", "format": "date-time" } } }, "AuthenticationProvider": { "type": "object", "title": "AuthenticationProvider", "properties": { "id": { "type": "string", "format": "uuid", "description": "Uniquely identifies the authentication provider.", "example": "35146afd-df93-4963-b1e9-1a085e2ae874" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "authentication_provider" }, "name": { "$ref": "#/components/schemas/name" }, "short_name": { "$ref": "#/components/schemas/short_name" }, "organization_id": { "$ref": "#/components/schemas/organization_id" }, "active": { "$ref": "#/components/schemas/active" }, "settings": { "type": "object", "description": "The settings associated with the authentication provider.", "properties": { "assertion_consumer_service_url": { "type": "string", "description": "The Assertion Consumer Service URL for the service provider (Telnyx).", "example": "https://api.telnyx.com/sso/saml/auth/myorg" }, "service_provider_entity_id": { "type": "string", "description": "The Entity ID for the service provider (Telnyx).", "example": "https://api.telnyx.com/sso/saml/metadata/myorg" }, "idp_entity_id": { "type": "string", "description": "The Entity ID for the identity provider (IdP).", "example": "https://myorg.myidp.com/saml/metadata" }, "idp_sso_target_url": { "type": "string", "description": "The SSO target url for the identity provider (IdP).", "example": "https://myorg.myidp.com/trust/saml2/http-post/sso" }, "idp_cert_fingerprint": { "type": "string", "description": "The certificate fingerprint for the identity provider (IdP)", "example": "13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7" }, "idp_cert_fingerprint_algorithm": { "type": "string", "description": "The algorithm used to generate the identity provider's (IdP) certificate fingerprint", "enum": [ "sha1", "sha256", "sha384", "sha512" ], "example": "sha256", "default": "sha1" }, "name_identifier_format": { "type": "string", "description": "The name identifier format associated with the authentication provider. This must be the same for both the Identity Provider (IdP) and the service provider (Telnyx).", "example": "urn:oasis:names:tc:SAML:1.1:nameid-format" } } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" } } }, "AuthenticationProviderCreate": { "type": "object", "required": [ "name", "short_name", "settings" ], "properties": { "name": { "$ref": "#/components/schemas/name" }, "short_name": { "$ref": "#/components/schemas/short_name" }, "active": { "$ref": "#/components/schemas/active" }, "settings": { "$ref": "#/components/schemas/settings" }, "settings_url": { "$ref": "#/components/schemas/settings_url" } } }, "AutoRechargePref": { "type": "object", "properties": { "id": { "type": "string", "example": "1524126400473204723", "description": "The unique identifier for the auto recharge preference." }, "record_type": { "type": "string", "example": "auto_recharge_pref", "description": "The record type." }, "threshold_amount": { "type": "string", "example": "104.00", "format": "decimal", "description": "The threshold amount at which the account will be recharged." }, "recharge_amount": { "type": "string", "example": "104.00", "format": "decimal", "description": "The amount to recharge the account, the actual recharge amount will be the amount necessary to reach the threshold amount plus the recharge amount." }, "enabled": { "type": "boolean", "example": true, "description": "Whether auto recharge is enabled." }, "invoice_enabled": { "type": "boolean", "example": true }, "preference": { "type": "string", "enum": [ "credit_paypal", "ach" ], "example": "credit_paypal", "description": "The payment preference for auto recharge." } } }, "AutoRechargePrefRequest": { "type": "object", "properties": { "threshold_amount": { "type": "string", "example": "104.00", "format": "decimal", "description": "The threshold amount at which the account will be recharged." }, "recharge_amount": { "type": "string", "example": "104.00", "format": "decimal", "description": "The amount to recharge the account, the actual recharge amount will be the amount necessary to reach the threshold amount plus the recharge amount." }, "enabled": { "type": "boolean", "example": true, "description": "Whether auto recharge is enabled." }, "invoice_enabled": { "type": "boolean", "example": true }, "preference": { "type": "string", "enum": [ "credit_paypal", "ach" ], "example": "credit_paypal", "description": "The payment preference for auto recharge." } } }, "AutoRespConfigCreateSchema": { "title": "AutoRespConfigCreateSchema", "required": [ "op", "keywords", "country_code" ], "type": "object", "properties": { "op": { "title": "Op", "enum": [ "start", "stop", "info" ], "type": "string" }, "keywords": { "title": "Keywords", "type": "array", "items": { "type": "string" }, "example": [ "keyword1", "keyword2" ] }, "resp_text": { "title": "Resp Text", "type": "string", "example": "Thank you for your message" }, "country_code": { "title": "Country Code", "type": "string", "example": "US" } } }, "AutorespConfigResponseSchema": { "title": "AutorespConfigResponseSchema", "required": [ "data" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AutorespConfigSchema" } } }, "AutorespConfigSchema": { "title": "AutorespConfigSchema", "required": [ "op", "keywords", "country_code", "id", "created_at", "updated_at" ], "type": "object", "properties": { "op": { "title": "Op", "enum": [ "start", "stop", "info" ], "type": "string", "example": "start" }, "keywords": { "title": "Keywords", "type": "array", "items": { "type": "string" }, "example": [ "START", "BEGIN" ] }, "resp_text": { "title": "Resp Text", "type": "string", "example": "Thank you for subscribing to our service." }, "country_code": { "title": "Country Code", "type": "string", "example": "*" }, "id": { "title": "Id", "type": "string", "example": "b8f9c1c0-5b5a-4b1e-8c1c-0b5a4b1e8c1c" }, "created_at": { "title": "Created At", "type": "string", "format": "date-time" }, "updated_at": { "title": "Updated At", "type": "string", "format": "date-time" } } }, "AutorespConfigsResponseSchema": { "title": "AutorespConfigsResponseSchema", "description": "List of Auto-Response Settings", "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/AutorespConfigSchema" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "AvailablePhoneNumber": { "type": "object", "properties": { "record_type": { "type": "string", "example": "available_phone_number", "enum": [ "available_phone_number" ] }, "phone_number": { "type": "string", "example": "+19705555098" }, "vanity_format": { "type": "string" }, "best_effort": { "type": "boolean", "description": "Specifies whether the phone number is an exact match based on the search criteria or not.", "example": false }, "quickship": { "type": "boolean", "description": "Specifies whether the phone number can receive calls immediately after purchase or not.", "example": true }, "reservable": { "type": "boolean", "description": "Specifies whether the phone number can be reserved before purchase or not.", "example": true }, "region_information": { "type": "array", "items": { "$ref": "#/components/schemas/RegionInformation" } }, "cost_information": { "$ref": "#/components/schemas/CostInformation" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } } }, "example": { "record_type": "available_phone_number", "phone_number": "+19705555098", "vanity_format": "", "best_effort": false, "quickship": true, "reservable": true, "region_information": [ { "region_type": "country_code", "region_name": "US" } ], "cost_information": { "upfront_cost": "3.21", "monthly_cost": "6.54", "currency": "USD" }, "features": [ { "name": "sms" }, { "name": "voice" } ] } }, "AvailablePhoneNumberBlock": { "type": "object", "properties": { "record_type": { "type": "string", "example": "available_phone_number_block", "enum": [ "available_phone_number_block" ] }, "starting_number": { "type": "string", "example": "+19705555000" }, "range": { "type": "integer", "example": 10 }, "region_information": { "type": "array", "items": { "$ref": "#/components/schemas/RegionInformation" } }, "cost_information": { "$ref": "#/components/schemas/CostInformation" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } } }, "example": { "record_type": "available_phone_number_block", "phone_number": "+19705555000", "range": 10, "region_information": [ { "region_type": "country_code", "region_name": "US" } ], "cost_information": { "upfront_cost": "3.21", "monthly_cost": "6.54", "currency": "USD" }, "features": [ { "name": "sms" }, { "name": "voice" } ] } }, "AvailablePhoneNumbersMetadata": { "type": "object", "example": { "total_results": 100, "best_effort_results": 50 }, "properties": { "total_results": { "type": "integer", "example": 1 }, "best_effort_results": { "type": "integer", "example": 0 } } }, "AwsAccessKeyId": { "description": "AWS credentials access key id.", "type": "string", "example": "AKIAIOSFODNN7EXAMPLE" }, "AwsSecretAccessKey": { "description": "AWS secret access key.", "type": "string", "example": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" }, "AzureAccountKey": { "description": "Azure Blob Storage account key", "type": "string", "example": "bPxRfiCYEXAMPLEKEY" }, "AzureAccountName": { "description": "Azure Blob Storage account name", "type": "string", "example": "my-account" }, "AzureConfigurationData": { "type": "object", "title": "Azure Blob Storage Configuration Data", "properties": { "bucket": { "$ref": "#/components/schemas/Bucket" }, "account_name": { "$ref": "#/components/schemas/AzureAccountName" }, "account_key": { "$ref": "#/components/schemas/AzureAccountKey" } } }, "BillingGroup": { "type": "object", "properties": { "record_type": { "type": "string", "example": "billing_group", "enum": [ "billing_group" ], "description": "Identifies the type of the resource." }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource.", "example": "f5586561-8ff0-4291-a0ac-84fe544797bd" }, "organization_id": { "type": "string", "format": "uuid", "description": "Identifies the organization that owns the resource.", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "name": { "type": "string", "format": "string", "description": "A user-specified name for the billing group", "example": "My billing group name" }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2019-10-15T10:07:15.527Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2019-10-15T10:07:15.527Z" }, "deleted_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was removed.", "example": null } }, "example": { "record_type": "billing_group", "id": "f5586561-8ff0-4291-a0ac-84fe544797bd", "organization_id": "f1486bae-f067-460c-ad43-73a92848f902", "name": "My billing group name", "created_at": "2019-10-15T10:07:15.527Z", "updated_at": "2019-10-15T10:07:15.527Z", "deleted_at": null } }, "BrandBasic": { "title": "ListedBrand", "type": "object", "properties": { "brandId": { "type": "string", "description": "Unique identifier assigned to the brand.", "example": "4b206179-f731-8ab7-f19c-34e19d22ide9" }, "entityType": { "$ref": "#/components/schemas/EntityType", "type": "string", "description": "Entity type behind the brand. This is the form of business establishment.", "example": "PRIVATE_PROFIT" }, "companyName": { "type": "string", "description": "(Required for Non-profit/private/public) Legal company name.", "example": "Example Company Inc." }, "displayName": { "type": "string", "description": "Display or marketing name of the brand.", "example": "Example Company" }, "email": { "type": "string", "description": "Valid email address of brand support contact.", "example": "examplename@examplecompany.com" }, "website": { "type": "string", "description": "Brand website URL.", "example": "www.examplecompany.com" }, "createAt": { "type": "string", "description": "Date and time that the brand was created at.", "example": "2021-03-08T17:57:48.801186" }, "updatedAt": { "type": "string", "description": "Date and time that the brand was last updated at.", "example": "2021-03-08T17:57:48.801186" } } }, "BrandFeedback": { "title": "BrandFeedback", "required": [ "brandId", "category" ], "type": "object", "properties": { "brandId": { "title": "Brandid", "type": "string", "description": "ID of the brand being queried about", "example": "d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5" }, "category": { "title": "Category", "type": "array", "items": { "$ref": "#/components/schemas/BrandFeedbackCategory" }, "description": "A list of reasons why brand creation/revetting didn't go as planned" } } }, "BrandFeedbackCategory": { "title": "BrandFeedbackCategory", "required": [ "id", "displayName", "description", "fields" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "One of `TAX_ID`, `STOCK_SYMBOL`, `GOVERNMENT_ENTITY`, `NONPROFIT`, and `OTHERS`", "example": "TAX_ID" }, "displayName": { "title": "Displayname", "type": "string", "description": "Human-readable version of the `id` field", "example": "Tax Id" }, "description": { "title": "Description", "type": "string", "description": "Long-form description of the feedback with additional information", "example": "Tax Id does not match with the company name or business type." }, "fields": { "title": "Fields", "type": "array", "items": { "type": "string" }, "description": "List of relevant fields in the originally-submitted brand json", "example": [ "ein", "companyName", "entityType" ] } } }, "BrandIdentityStatus": { "title": "BrandIdentityStatus", "enum": [ "VERIFIED", "UNVERIFIED", "SELF_DECLARED", "VETTED_VERIFIED" ], "description": "\n The verification status of an active brand\n " }, "BrandOptionalAttributes": { "title": "BrandOptionalAttributes", "type": "object", "properties": { "taxExemptStatus": { "title": "Taxexemptstatus", "type": "string", "description": "The tax exempt status of the brand" } } }, "BrandRecordSetCSP": { "title": "BrandRecordSetCSP", "type": "object", "properties": { "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/BrandBasic" } }, "page": { "title": "Page", "type": "integer", "example": 1 }, "totalRecords": { "title": "Totalrecords", "type": "integer", "example": 1 } } }, "BrandRelationship": { "title": "BrandRelationship", "enum": [ "BASIC_ACCOUNT", "SMALL_ACCOUNT", "MEDIUM_ACCOUNT", "LARGE_ACCOUNT", "KEY_ACCOUNT" ], "description": "Brand relationship to the CSP." }, "BrandRequest": { "title": "Brand", "required": [ "entityType", "displayName", "country", "email", "vertical" ], "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/EntityType" }, "cspId": { "title": "Cspid", "type": "string", "description": "Unique identifier assigned to the csp by the registry." }, "brandId": { "title": "Brandid", "type": "string", "description": "Unique identifier assigned to the brand.", "example": "4b206179-f731-8ab7-f19c-34e19d22ide9" }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display or marketing name of the brand.", "example": "Example Company" }, "companyName": { "title": "Companyname", "maxLength": 100, "type": "string", "description": "(Required for Non-profit/private/public) Legal company name.", "example": "Example Company Inc." }, "ein": { "title": "Ein", "maxLength": 20, "type": "string", "description": "(Required for Non-profit/private/public) Government assigned corporate tax ID. EIN is 9-digits in U.S. The only entity type which does not require an EIN is a Sole Proprietor.", "example": "142536893" }, "phone": { "title": "Phone", "maxLength": 20, "type": "string", "description": "Valid phone number in e.164 international format.", "example": "+13259390512" }, "street": { "title": "Street", "maxLength": 100, "type": "string", "description": "Street number and name.", "example": "123 Example St." }, "city": { "title": "City", "maxLength": 100, "type": "string", "description": "City name", "example": "Chicago" }, "state": { "title": "State", "maxLength": 20, "type": "string", "description": "State. Must be 2 letters code for United States.", "example": "IL" }, "postalCode": { "title": "Postalcode", "maxLength": 10, "type": "string", "description": "Postal codes. Use 5 digit zipcode for United States", "example": "60654" }, "country": { "title": "Country", "maxLength": 2, "type": "string", "description": "ISO2 2 characters country code. Example: US - United States", "example": "US" }, "email": { "title": "Email", "maxLength": 100, "type": "string", "description": "Valid email address of brand support contact.", "example": "examplename@examplecompany.com" }, "stockSymbol": { "title": "Stocksymbol", "maxLength": 10, "type": "string", "description": "(Required for public company) stock symbol.", "example": "ABC" }, "stockExchange": { "$ref": "#/components/schemas/StockExchange" }, "ipAddress": { "title": "Ipaddress", "maxLength": 50, "type": "string", "description": "IP address of the browser requesting to create brand identity." }, "website": { "title": "Website", "maxLength": 100, "type": "string", "description": "Brand website URL.", "example": "www.examplecompany.com" }, "vertical": { "$ref": "#/components/schemas/Vertical" }, "altBusinessId": { "title": "Altbusinessid", "maxLength": 50, "type": "string", "description": "Alternate business identifier such as DUNS, LEI, or GIIN" }, "altBusinessIdType": { "$ref": "#/components/schemas/AltBusinessIdType" }, "universalEin": { "title": "Universalein", "type": "string", "description": "Universal EIN of Brand, Read Only." } } }, "BrandResponse": { "title": "Brand", "required": [ "entityType", "displayName", "country", "email", "vertical" ], "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/EntityType" }, "cspId": { "title": "Cspid", "type": "string", "description": "Unique identifier assigned to the csp by the registry." }, "brandId": { "title": "Brandid", "type": "string", "description": "Unique identifier assigned to the brand.", "example": "4b206179-f731-8ab7-f19c-34e19d22ide9" }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display or marketing name of the brand.", "example": "Example Company" }, "companyName": { "title": "Companyname", "maxLength": 100, "type": "string", "description": "(Required for Non-profit/private/public) Legal company name.", "example": "Example Company Inc." }, "ein": { "title": "Ein", "maxLength": 20, "type": "string", "description": "(Required for Non-profit/private/public) Government assigned corporate tax ID. EIN is 9-digits in U.S. The only entity type which does not require an EIN is a Sole Proprietor.", "example": "142536893" }, "phone": { "title": "Phone", "maxLength": 20, "type": "string", "description": "Valid phone number in e.164 international format.", "example": "+13259390512" }, "street": { "title": "Street", "maxLength": 100, "type": "string", "description": "Street number and name.", "example": "123 Example St." }, "city": { "title": "City", "maxLength": 100, "type": "string", "description": "City name", "example": "Chicago" }, "state": { "title": "State", "maxLength": 20, "type": "string", "description": "State. Must be 2 letters code for United States.", "example": "IL" }, "postalCode": { "title": "Postalcode", "maxLength": 10, "type": "string", "description": "Postal codes. Use 5 digit zipcode for United States", "example": "60654" }, "country": { "title": "Country", "maxLength": 2, "type": "string", "description": "ISO2 2 characters country code. Example: US - United States", "example": "US" }, "email": { "title": "Email", "maxLength": 100, "type": "string", "description": "Valid email address of brand support contact.", "example": "examplename@examplecompany.com" }, "stockSymbol": { "title": "Stocksymbol", "maxLength": 10, "type": "string", "description": "(Required for public company) stock symbol.", "example": "ABC" }, "stockExchange": { "$ref": "#/components/schemas/StockExchange" }, "ipAddress": { "title": "Ipaddress", "maxLength": 50, "type": "string", "description": "IP address of the browser requesting to create brand identity." }, "website": { "title": "Website", "maxLength": 100, "type": "string", "description": "Brand website URL.", "example": "www.examplecompany.com" }, "brandRelationship": { "$ref": "#/components/schemas/BrandRelationship" }, "vertical": { "$ref": "#/components/schemas/Vertical" }, "altBusinessId": { "title": "Altbusinessid", "maxLength": 50, "type": "string", "description": "Alternate business identifier such as DUNS, LEI, or GIIN" }, "altBusinessIdType": { "$ref": "#/components/schemas/AltBusinessIdType" }, "universalEin": { "title": "Universalein", "type": "string", "description": "Universal EIN of Brand, Read Only." }, "identityStatus": { "title": "identityStatus", "description": "TCR assessment of the brand identification status.", "type": "string", "example": "VERIFIED" } } }, "BrandStatus": { "properties": { "displayName": { "description": "The display name of the brand submitted via bulk creation.", "example": "John's Donuts", "title": "Displayname", "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/CreationStatus" } ], "description": "The current status of the brand.", "example": "pending" }, "brandId": { "description": "The ID of the brand created via bulk creation. This brand will only have a brandId after the brand has been created.", "example": "4b20017a-2f50-4c90-c9e6-5f67304cbde9", "title": "Brandid", "type": "string" }, "created_at": { "description": "The date and time that the brand was created.", "example": "2021-06-30T10:49:04-07:00", "format": "date-time", "title": "Created At", "type": "string" }, "error": { "description": "Errors related to a brand creation failure.", "example": "Missing firstName attribute.", "title": "Error", "type": "string" } }, "required": [ "displayName", "status" ], "title": "BrandStatus", "type": "object" }, "BridgeRequest": { "type": "object", "title": "Bridge Request", "required": [ "call_control_id" ], "properties": { "call_control_id": { "description": "The Call Control ID of the call you want to bridge with, can't be used together with queue parameter or video_room_id parameter.", "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "queue": { "description": "The name of the queue you want to bridge with, can't be used together with call_control_id parameter or video_room_id parameter. Bridging with a queue means bridging with the first call in the queue. The call will always be removed from the queue regardless of whether bridging succeeds. Returns an error when the queue is empty.", "type": "string", "example": "support" }, "video_room_id": { "description": "The ID of the video room you want to bridge with, can't be used together with call_control_id parameter or queue parameter.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "video_room_context": { "description": "The additional parameter that will be passed to the video conference. It is a text field and the user can decide how to use it. For example, you can set the participant name or pass JSON text. It can be used only with video_room_id parameter.", "type": "string", "example": "Alice" }, "park_after_unbridge": { "description": "Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up or is transferred). If supplied with the value `self`, the current leg will be parked after unbridge. If not set, the default behavior is to hang up the leg.", "type": "string", "example": "self" } }, "example": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "park_after_unbridge": "self" } }, "Bucket": { "description": "Name of the bucket to be used to store recording files.", "type": "string", "example": "example-bucket" }, "BucketAPIUsageResponse": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/BucketOps" } }, "total": { "$ref": "#/components/schemas/BucketOpsTotal" }, "timestamp": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time the usage was recorded" } } }, "BucketNotFoundError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/NotFoundError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "BucketOps": { "type": "object", "properties": { "bytes_sent": { "type": "integer", "description": "The number of bytes sent", "example": 123456 }, "bytes_received": { "type": "integer", "description": "The number of bytes received", "example": 123456 }, "ops": { "type": "integer", "description": "The number of operations", "example": 123456 }, "successful_ops": { "type": "integer", "description": "The number of successful operations", "example": 123456 }, "category": { "type": "string", "enum": [ "list_bucket", "list_buckets", "get-bucket_location", "create_bucket", "stat_bucket", "get_bucket_versioning", "set_bucket_versioning", "get_obj", "put_obj", "delete_obj" ], "description": "The category of the bucket operation", "example": "put_obj" } } }, "BucketOpsTotal": { "type": "object", "properties": { "bytes_sent": { "type": "integer", "description": "The number of bytes sent", "example": 123456 }, "bytes_received": { "type": "integer", "description": "The number of bytes received", "example": 123456 }, "ops": { "type": "integer", "description": "The number of operations", "example": 123456 }, "successful_ops": { "type": "integer", "description": "The number of successful operations", "example": 123456 } } }, "BucketUsage": { "type": "object", "properties": { "size": { "type": "integer", "description": "The size of the bucket in bytes", "example": 123456 }, "size_kb": { "type": "integer", "description": "The size of the bucket in kilobytes", "example": 123456 }, "num_objects": { "type": "integer", "description": "The number of objects in the bucket", "example": 123456 }, "timestamp": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time the snapshot was taken" } } }, "BulkCreationDetailedStatusResponse": { "properties": { "meta": { "$ref": "#/components/schemas/campaign_registry__api__schemas__bulk_creation__Meta" }, "records": { "items": { "$ref": "#/components/schemas/DetailedTaskStatus" }, "title": "Records", "type": "array" } }, "required": [ "records", "meta" ], "title": "BulkCreationDetailedStatusResponse", "type": "object" }, "BulkCreationRequest": { "properties": { "brands": { "items": { "$ref": "#/components/schemas/SoleProprietorData" }, "title": "Brands", "type": "array" } }, "required": [ "brands" ], "title": "BulkCreationRequest", "type": "object" }, "BulkCreationResponse": { "properties": { "brandCount": { "description": "The total number of brands to be created.", "example": 10, "title": "Brandcount", "type": "integer" }, "taskId": { "description": "The ID of the task associated with bulk Sole Proprietor brand and campaign creation.", "example": "667a80f8-b0a9-49d0-b9ab-a7a1bcc45086", "title": "Taskid", "type": "string" } }, "required": [ "brandCount", "taskId" ], "title": "BulkCreationResponse", "type": "object" }, "BulkCreationStatusResponse": { "properties": { "taskId": { "description": "The ID of the task associated with bulk Sole Proprietor brand and campaign creation.", "example": "4b60017a-2f50-4c90-c9e6-5f67304cbde2", "title": "Taskid", "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/campaign_registry__api__schemas__bulk_creation__TaskStatus" } ], "description": "The current status of this task", "example": "pending" }, "createdAt": { "description": "The date and time the task was initiated", "example": "2021-06-30T10:48:22-07:00", "format": "date-time", "title": "Createdat", "type": "string" }, "updatedAt": { "description": "The date and time the task's status was updated", "example": "2021-06-30T10:49:04-07:00", "format": "date-time", "title": "Updatedat", "type": "string" } }, "required": [ "taskId", "status" ], "title": "BulkCreationStatusResponse", "type": "object" }, "BulkCreationTasksResponse": { "properties": { "meta": { "$ref": "#/components/schemas/campaign_registry__api__schemas__bulk_creation__Meta" }, "records": { "items": { "$ref": "#/components/schemas/BulkCreationStatusResponse" }, "title": "Records", "type": "array" } }, "required": [ "records", "meta" ], "title": "BulkCreationTasksResponse", "type": "object" }, "BulkCredentialRequest": { "type": "object", "title": "Bulk Credential Request", "required": [ "tag", "connection_id" ], "properties": { "name": { "description": "A default name for all credentials.", "type": "string", "example": "Default Credentials" }, "tag": { "description": "Tags a credential for bulk operations. A single tag can hold at maximum 1000 credentials.", "type": "string", "example": "My Credentials" }, "amount": { "description": "Amount of credentials to be created. A single tag can hold at maximum 1000 credentials", "type": "integer", "example": 100 }, "connection_id": { "type": "string", "description": "Identifies the connection this credential is associated with.", "example": "1234567890" } }, "example": { "name": "Default Name", "tag": "My Credentials", "connection_id": "804252963366242252" } }, "BulkSIMCardAction": { "type": "object", "description": "This object represents a bulk SIM card action. It groups SIM card actions created through a bulk endpoint under a single resource for further lookup.", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "record_type": { "type": "string", "example": "bulk_sim_card_action", "readOnly": true }, "action_type": { "type": "string", "description": "The operation type. It can be one of the following:
\n", "enum": [ "bulk_set_public_ips" ], "readOnly": true, "example": "bulk_set_public_ips" }, "settings": { "type": "object", "description": "A JSON object representation of the bulk action payload.", "example": {}, "readOnly": true }, "created_at": { "$ref": "#/components/schemas/CreatedAt" }, "updated_at": { "$ref": "#/components/schemas/UpdatedAt" } } }, "BulkSIMCardActionDetailed": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "record_type": { "type": "string", "example": "bulk_sim_card_action", "readOnly": true }, "action_type": { "type": "string", "description": "The operation type. It can be one of the following:
\n", "enum": [ "bulk_set_public_ips" ], "readOnly": true, "example": "bulk_set_public_ips" }, "settings": { "type": "object", "description": "A JSON object representation of the bulk action payload.", "example": {}, "readOnly": true }, "sim_card_actions_summary": { "type": "array", "items": { "$ref": "#/components/schemas/SIMCardActionsSummary" } }, "created_at": { "$ref": "#/components/schemas/CreatedAt" }, "updated_at": { "$ref": "#/components/schemas/UpdatedAt" } } }, "BusinessIdentity": { "type": "object", "properties": { "record_type": { "type": "string", "example": "business_identity", "readOnly": true }, "id": { "type": "string", "format": "uuid", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "organization_id": { "type": "string", "format": "uuid", "description": "The ID of the organization that owns the record", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "name": { "type": "string", "description": "The name of the business identity on the telnyx platform", "example": "Telnyx" }, "business_email": { "type": "string", "description": "The email of the business", "example": "contact@telnyx.com" }, "business_name": { "type": "string", "description": "The name of the business", "example": "Telnyx LLC" }, "business_phone_number": { "type": "string", "example": "+12345678900" }, "business_description": { "type": "string", "example": "Telnyx's business identity for global presence." }, "submission_acknowledgement": { "type": "boolean", "description": "User acceptance of the terms of submission" }, "website_url": { "type": "array", "items": { "type": "string" }, "maximum": 2, "example": [ "https://telnyx.com", "https://portal.telnyx.com" ] }, "address": { "type": "object", "description": "The primary address of the business", "properties": { "record_type": { "type": "string", "example": "address", "readOnly": true }, "id": { "type": "string", "format": "uuid", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "city": { "type": "string", "example": "Chicago" }, "country": { "type": "string", "example": "US" }, "extended_address": { "type": "string", "example": "Suite 504" }, "postal_code": { "type": "string", "example": "11111" }, "state": { "type": "string", "example": "IL" }, "street": { "type": "string", "example": "311 W. Superior St" } } }, "contacts": { "type": "array", "items": { "type": "object", "description": "A contact person for the business", "properties": { "record_type": { "type": "string", "example": "contact", "readOnly": true }, "id": { "type": "string", "format": "uuid", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "email": { "type": "string", "example": "johnsmith@telnyx.com" }, "first_name": { "type": "string", "example": "John" }, "job_title": { "type": "string", "example": "CEO" }, "last_name": { "type": "string", "example": "Smith" }, "phone_number": { "type": "string", "example": "+12345678900" } } } }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8601 datetime string for when the business identity was added to the Telnyx platform", "example": "2018-01-01T00:00:00Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8601 datetime string for when the business identity was updated", "example": "2018-01-01T00:00:00Z", "readOnly": true } }, "example": { "id": "6786c69b-0063-47de-865f-cf64b7e7f59e", "name": "Telnyx", "organization_id": "633514e3-32d7-4d26-a959-1bc67c4f435d", "submission_acknowledgement": true, "business_name": "Telnyx LLC", "business_description": "Telnyx global presence profile", "business_email": "contact@telnyx.com", "business_phone_number": "+12345678900", "website_url": [ "https://www.telnyx.com", "https://portal.telnyx.com" ], "created_at": "2021-06-10T18:53:11.254650", "updated_at": "2021-06-10T18:53:11.254650", "address": { "id": "573eed9e-d86b-48f0-a578-d04fea4d0020", "record_type": "address", "street": "311 W. Superior St.", "postal_code": "60654", "city": "Chicago", "state": "IL", "country": "USA", "extended_address": "Suite 504", "created_at": "2021-06-10T18:53:11.254650", "updated_at": "2021-06-10T18:53:11.254650" }, "contacts": [ { "id": "621fa2e6-78b2-4695-8620-66a8b46f17e3", "record_type": "contact", "email": "johnsmith@telnyx.com", "first_name": "John", "job_title": "CEO", "last_name": "Smith", "phone_number": "+12345678900", "created_at": "2021-06-10T18:53:11.254650", "updated_at": "2021-06-10T18:53:11.254650" } ] } }, "Call": { "type": "object", "title": "Call", "required": [ "call_control_id", "call_leg_id", "call_session_id", "is_alive", "record_type" ], "example": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768", "call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "is_alive": false, "call_duration": 50, "record_type": "call" }, "properties": { "record_type": { "type": "string", "enum": [ "call" ], "example": "call" }, "call_session_id": { "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call", "type": "string", "example": "428c31b6-7af4-4bcb-b68e-5013ef9657c1" }, "call_leg_id": { "description": "ID that is unique to the call and can be used to correlate webhook events", "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1" }, "call_control_id": { "description": "Unique identifier and token for controlling the call.", "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" }, "is_alive": { "description": "Indicates whether the call is alive or not. For Dial command it will always be `false` (dialing is asynchronous).", "type": "boolean", "example": true }, "client_state": { "description": "State received from a command.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "call_duration": { "description": "Indicates the duration of the call in seconds", "type": "integer", "example": 50 } } }, "CallAnswered": { "type": "object", "title": "Call Answered", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.answered", "enum": [ "call.answered" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "custom_headers": { "description": "Custom headers set on answer command", "type": "array", "example": [ { "name": "head_1", "value": "val_1" }, { "name": "head_2", "value": "val_2" } ], "items": { "$ref": "#/components/schemas/CustomSipHeader" } }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "state": { "type": "string", "example": "answered", "enum": [ "answered" ], "description": "State received from a command." } } } }, "example": { "record_type": "event", "event_type": "call.answered", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "state": "answered" } } }, "CallAnsweredEvent": { "type": "object", "title": "Call Answered Event", "properties": { "data": { "$ref": "#/components/schemas/CallAnswered" } } }, "CallBridged": { "type": "object", "title": "Call Bridged", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.bridged", "enum": [ "call.bridged" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "state": { "type": "string", "example": "bridged", "enum": [ "bridged" ], "description": "State received from a command." } } } }, "example": { "record_type": "event", "event_type": "call.bridged", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "state": "bridged" } } }, "CallBridgedEvent": { "type": "object", "title": "Call Bridged Event", "properties": { "data": { "$ref": "#/components/schemas/CallBridged" } } }, "CallControlApplication": { "type": "object", "title": "Call Control Application", "properties": { "active": { "type": "boolean", "description": "Specifies whether the connection can be used.", "default": true }, "anchorsite_override": { "type": "string", "description": "`Latency` directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.\n", "enum": [ "\"Latency\"", "\"Chicago, IL\"", "\"Ashburn, VA\"", "\"San Jose, CA\"" ], "example": "\"Amsterdam, Netherlands\"", "default": "\"Latency\"" }, "application_name": { "type": "string", "description": "A user-assigned name to help manage the application.", "example": "call-router" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the resource was created", "example": "2018-02-02T22:25:27.521Z" }, "dtmf_type": { "type": "string", "description": "Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.", "enum": [ "RFC 2833", "Inband", "SIP INFO" ], "example": "Inband", "default": "RFC 2833" }, "first_command_timeout": { "type": "boolean", "description": "Specifies whether calls to phone numbers associated with this connection should hangup after timing out.", "example": true, "default": false }, "first_command_timeout_secs": { "type": "integer", "description": "Specifies how many seconds to wait before timing out a dial command.", "example": 10, "default": 30 }, "id": { "type": "string", "format": "int64", "example": "1293384261075731499" }, "inbound": { "$ref": "#/components/schemas/CallControlApplicationInbound" }, "outbound": { "$ref": "#/components/schemas/CallControlApplicationOutbound" }, "record_type": { "type": "string", "enum": [ "call_control_application" ], "default": "call_control_application" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the resource was last updated", "example": "2018-02-02T22:25:27.521Z" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as `https`.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as `https`.", "example": "https://example.com" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "example": 25, "default": null, "nullable": true } }, "example": { "active": false, "anchorsite_override": "\"Latency\"", "application_name": "call-router", "created_at": "2018-02-02T22:25:27.521Z", "dtmf_type": "Inband", "first_command_timeout": true, "first_command_timeout_secs": 10, "id": "1293384261075731499", "inbound": { "channel_limit": 10, "shaken_stir_enabled": true, "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" }, "record_type": "call_control_application", "updated_at": "2018-02-02T22:25:27.521Z", "webhook_api_version": "1", "webhook_event_failover_url": "https://failover.example.com", "webhook_event_url": "https://example.com", "webhook_timeout_secs": 25 } }, "CallControlApplicationInbound": { "type": "object", "title": "Call Control Application Inbound", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection.", "example": 10, "default": null }, "shaken_stir_enabled": { "type": "boolean", "description": "When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.", "default": false, "example": false }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.", "example": "example", "default": null }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ], "example": "only_my_connections", "default": "from_anyone" } } }, "CallControlApplicationOutbound": { "type": "object", "title": "Call Control Application Outbound", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of outbound calls to phone numbers associated with this connection.", "example": 10, "default": null }, "outbound_voice_profile_id": { "type": "string", "format": "int64", "description": "Identifies the associated outbound voice profile.", "example": "1293384261075731499" } } }, "CallControlCommandResult": { "type": "object", "title": "Call Control Command Result", "example": { "result": "ok" }, "properties": { "result": { "type": "string", "example": "ok" } } }, "CallControlId": { "type": "string", "example": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA" }, "CallCost": { "type": "object", "title": "Call Cost Received Event", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of resource." }, "event_type": { "type": "string", "example": "call.cost", "enum": [ "call.cost" ], "description": "The type of the event being delivered" }, "id": { "type": "string", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "format": "uuid", "description": "Uniquely identifies a webhook" }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "meta": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "attempt": { "type": "integer", "description": "The number of attempts made to deliver the webhook", "example": 1, "minimum": 1 }, "delivered_to": { "type": "string", "description": "The URL where webhook was sent", "example": "https://example.com" } } } } }, "payload": { "type": "object", "properties": { "billed_duration_secs": { "type": "integer", "description": "The number of seconds for which this call will be billed", "example": 0, "minimum": 0 }, "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Identifies the type of resource." }, "cost_parts": { "type": "array", "items": { "type": "object", "properties": { "billed_duration_secs": { "type": "integer", "description": "The number of seconds for which this item will be billed", "example": 0, "minimum": 0 }, "call_part": { "type": "string", "description": "The service incurring a charge", "example": "call-control" }, "cost": { "type": "number", "description": "The billed cost of the item, in currency shown in the `currency` field", "example": 0.0, "minimum": 0.0 }, "currency": { "type": "string", "description": "The currency in which `cost` is measured", "example": "USD" }, "rate": { "type": "number", "description": "The cost per unit of the item incurring a charge", "example": 0.001, "minimum": 0.0 } } } }, "total_cost": { "type": "number", "description": "The billed cost of the call", "example": 0.0, "minimum": 0.0 }, "status": { "type": "string", "enum": [ "valid", "invalid", "call_hangup", "cancelled", "cancelled_amd" ], "example": "valid", "description": "Reflects how command ended." } } } } }, "CallDtmfReceived": { "type": "object", "title": "Call DTMF Received", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.dtmf.received", "enum": [ "call.dtmf.received" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Identifies the type of resource." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "digit": { "type": "string", "example": "#", "description": "The received DTMF digit or symbol." } } } }, "example": { "record_type": "event", "event_type": "call.dtmf.received", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "digit": "#" } } }, "CallDtmfReceivedEvent": { "type": "object", "title": "Call DTMF Received Event", "properties": { "data": { "$ref": "#/components/schemas/CallDtmfReceived" } } }, "CallEnqueued": { "type": "object", "title": "Call Enqueued", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.enqueued", "enum": [ "call.enqueued" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "queue": { "type": "string", "example": "support", "description": "The name of the queue" }, "current_position": { "type": "integer", "example": 7, "description": "Current position of the call in the queue." } } } }, "example": { "record_type": "event", "event_type": "call.enqueued", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "queue": "support", "current_position": 5 } } }, "CallEnqueuedEvent": { "type": "object", "title": "Call Enqueued Event", "properties": { "data": { "$ref": "#/components/schemas/CallEnqueued" } } }, "CallEvent": { "type": "object", "title": "Call Event", "required": [ "record_type", "call_leg_id", "call_session_id", "event_timestamp", "name", "type", "metadata" ], "properties": { "record_type": { "type": "string", "enum": [ "call_event" ], "example": "call_event" }, "call_leg_id": { "type": "string", "description": "Uniquely identifies an individual call leg.", "example": "308fe500-5213-11e9-ace7-02420a0f0668" }, "call_session_id": { "type": "string", "description": "Uniquely identifies the call control session. A session may include multiple call leg events.", "example": "308fec30-5213-11e9-9d3f-02420a0f0668" }, "event_timestamp": { "type": "string", "description": "Event timestamp", "example": "2019-03-29T11:10:19.127783Z" }, "name": { "type": "string", "description": "Event name", "example": "call.hangup" }, "type": { "type": "string", "description": "Event type", "enum": [ "command", "webhook" ], "example": "webhook" }, "metadata": { "type": "object", "description": "Event metadata, which includes raw event, and extra information based on event type" } }, "example": { "record_type": "call_event", "call_leg_id": "308fe500-5213-11e9-ace7-02420a0f0668", "call_session_id": "308fec30-5213-11e9-9d3f-02420a0f0668", "event_timestamp": "2019-03-29T11:10:19.127783Z", "name": "call.hangup", "type": "webhook", "metadata": {} } }, "CallForkStarted": { "type": "object", "title": "Call Fork Started", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.fork.started", "enum": [ "call.fork.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_control_id": { "type": "string", "example": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "description": "Unique ID for controlling the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "stream_type": { "type": "string", "example": "raw", "enum": [ "raw", "decrypted" ], "description": "Type of media streamed. It can be either 'raw' or 'decrypted'." } } } }, "example": { "record_type": "event", "event_type": "call.fork.started", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "call_control_id": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "stream_type": "decrypted" } } }, "CallForkStartedEvent": { "type": "object", "title": "Call Fork Started Event", "properties": { "data": { "$ref": "#/components/schemas/CallForkStarted" } } }, "CallForkStopped": { "type": "object", "title": "Call Fork Stopped", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.fork.stopped", "enum": [ "call.fork.stopped" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_control_id": { "type": "string", "example": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "description": "Unique ID for controlling the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "stream_type": { "type": "string", "example": "raw", "enum": [ "raw", "decrypted" ], "description": "Type of media streamed. It can be either 'raw' or 'decrypted'." } } } }, "example": { "record_type": "event", "event_type": "call.fork.stopped", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "call_control_id": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "stream_type": "decrypted" } } }, "CallForkStoppedEvent": { "type": "object", "title": "Call Fork Stopped Event", "properties": { "data": { "$ref": "#/components/schemas/CallForkStopped" } } }, "CallForwarding": { "description": "The call forwarding settings for a phone number.", "type": "object", "properties": { "call_forwarding_enabled": { "type": "boolean", "default": true, "description": "Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.", "example": true }, "forwards_to": { "type": "string", "description": "The phone number to which inbound calls to this number are forwarded. Inbound calls will not be forwarded if this field is left blank. If set, must be a +E.164-formatted phone number." }, "forwarding_type": { "type": "string", "description": "Call forwarding type. 'forwards_to' must be set for this to have an effect.", "enum": [ "always", "on_failure" ], "example": "always" } }, "example": { "call_forwarding_enabled": true, "forwards_to": "+13035559123", "forwarding_type": "always" } }, "CallGatherEnded": { "type": "object", "title": "Call Gather Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.gather.ended", "enum": [ "call.gather.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "digits": { "type": "string", "example": "5503", "description": "The received DTMF digit or symbol." }, "status": { "type": "string", "enum": [ "valid", "invalid", "call_hangup", "cancelled", "cancelled_amd", "timeout" ], "example": "valid", "description": "Reflects how command ended." } } } }, "example": { "record_type": "event", "event_type": "call.gather.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "digits": "123", "status": "valid" } } }, "CallGatherEndedEvent": { "type": "object", "title": "Call Gather Ended Event", "properties": { "data": { "$ref": "#/components/schemas/CallGatherEnded" } } }, "CallHangup": { "type": "object", "title": "Call Hangup", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.hangup", "enum": [ "call.hangup" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "start_time": { "type": "string", "format": "date-time", "example": "2018-02-02T22:20:27.521992Z", "description": "ISO 8601 datetime of when the call started." }, "state": { "type": "string", "example": "hangup", "enum": [ "hangup" ], "description": "State received from a command." }, "hangup_cause": { "type": "string", "example": "call_rejected", "enum": [ "call_rejected", "normal_clearing", "originator_cancel", "timeout", "time_limit", "user_busy", "not_found", "unspecified" ], "description": "The reason the call was ended (`call_rejected`, `normal_clearing`, `originator_cancel`, `timeout`, `time_limit`, `user_busy`, `not_found` or `unspecified`)." }, "hangup_source": { "type": "string", "example": "caller", "enum": [ "caller", "callee", "unknown" ], "description": "The party who ended the call (`callee`, `caller`, `unknown`)." }, "sip_hangup_cause": { "type": "string", "example": "603", "description": "The reason the call was ended (SIP response code). If the SIP response is unavailable (in inbound calls for example) this is set to `unspecified`." } } } }, "example": { "record_type": "event", "event_type": "call.hangup", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "start_time": "2018-02-02T22:20:27.521992Z", "state": "hangup", "hangup_cause": "call_rejected", "hangup_source": "caller", "sip_hangup_cause": "603" } } }, "CallHangupEvent": { "type": "object", "title": "Call Hangup Event", "properties": { "data": { "$ref": "#/components/schemas/CallHangup" } } }, "CallInitiated": { "type": "object", "title": "Call Initiated", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.initiated", "enum": [ "call.initiated" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "custom_headers": { "description": "Custom headers from sip invite", "type": "array", "example": [ { "name": "head_1", "value": "val_1" }, { "name": "head_2", "value": "val_2" } ], "items": { "$ref": "#/components/schemas/CustomSipHeader" } }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "direction": { "type": "string", "example": "incoming", "enum": [ "incoming", "outgoing" ], "description": "Whether the call is `incoming` or `outgoing`." }, "state": { "type": "string", "example": "parked", "enum": [ "parked", "bridging" ], "description": "State received from a command." } } } }, "example": { "record_type": "event", "event_type": "call.initiated", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "direction": "incoming", "state": "parked" } } }, "CallInitiatedEvent": { "type": "object", "title": "Call Initiated Event", "properties": { "data": { "$ref": "#/components/schemas/CallInitiated" } } }, "CallLeftQueue": { "type": "object", "title": "Call Left Queue", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.dequeued", "enum": [ "call.dequeued" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "queue": { "type": "string", "example": "support", "description": "The name of the queue" }, "queue_position": { "type": "integer", "example": 7, "description": "Last position of the call in the queue." }, "reason": { "type": "string", "description": "The reason for leaving the queue", "example": "bridged", "enum": [ "bridged", "bridging-in-process", "hangup", "leave", "timeout" ] } } } }, "example": { "record_type": "event", "event_type": "call.dequeued", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "queue": "support", "queue_position": 3, "reason": "leave" } } }, "CallLeftQueueEvent": { "type": "object", "title": "Call Left Queue Event", "properties": { "data": { "$ref": "#/components/schemas/CallLeftQueue" } } }, "CallMachineDetectionEnded": { "type": "object", "title": "Call Machine Detection Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.machine.detection.ended", "enum": [ "call.machine.detection.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "result": { "type": "string", "example": "machine", "enum": [ "human", "machine", "not_sure" ], "description": "Answering machine detection result." } } } }, "example": { "record_type": "event", "event_type": "call.machine.detection.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "result": "human" } } }, "CallMachineDetectionEndedEvent": { "type": "object", "title": "Call Machine Detection Ended Event", "properties": { "data": { "$ref": "#/components/schemas/CallMachineDetectionEnded" } } }, "CallMachineGreetingEnded": { "type": "object", "title": "Call Machine Greeting Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.machine.greeting.ended", "enum": [ "call.machine.greeting.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "result": { "type": "string", "example": "ended", "enum": [ "ended", "not_sure" ], "description": "Answering machine greeting ended result." } } } }, "example": { "record_type": "event", "event_type": "call.machine.greeting.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "result": "ended" } } }, "CallMachineGreetingEndedEvent": { "type": "object", "title": "Call Machine Greeting Ended Event", "properties": { "data": { "$ref": "#/components/schemas/CallMachineGreetingEnded" } } }, "CallMachinePremiumDetectionEnded": { "type": "object", "title": "Call Machine Premium Detection Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.machine.premium.detection.ended", "enum": [ "call.machine.premium.detection.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "result": { "type": "string", "example": "machine", "enum": [ "human_residence", "human_business", "machine", "silence", "fax_detected" ], "description": "Premium Answering Machine Detection result." } } } }, "example": { "record_type": "event", "event_type": "call.machine.premium.detection.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "result": "machine" } } }, "CallMachinePremiumDetectionEndedEvent": { "type": "object", "title": "Call Machine Premium Detection Ended Event", "properties": { "data": { "$ref": "#/components/schemas/CallMachinePremiumDetectionEnded" } } }, "CallMachinePremiumGreetingEnded": { "type": "object", "title": "Call Machine Premium Greeting Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.machine.premium.greeting.ended", "enum": [ "call.machine.premium.greeting.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "result": { "type": "string", "example": "beep_detected", "enum": [ "beep_detected" ], "description": "Premium Answering Machine Greeting Ended result." } } } }, "example": { "record_type": "event", "event_type": "call.machine.premium.greeting.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "from": "+35319605860", "to": "+35319605860", "result": "beep_detected" } } }, "CallMachinePremiumGreetingEndedEvent": { "type": "object", "title": "Call Machine Premium Greeting Ended Event", "properties": { "data": { "$ref": "#/components/schemas/CallMachinePremiumGreetingEnded" } } }, "CallPlaybackEnded": { "type": "object", "title": "Call Playback Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.playback.ended", "enum": [ "call.playback.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "media_url": { "type": "string", "example": "http://example.com/audio.wav", "description": "The audio URL being played back, if audio_url has been used to start." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The name of the audio media file being played back, if media_name has been used to start." }, "overlay": { "type": "boolean", "example": false, "description": "Whether the stopped audio was in overlay mode or not." }, "status": { "type": "string", "enum": [ "file_not_found", "call_hangup", "unknown", "failed", "cancelled_amd", "completed", "failed" ], "example": "completed", "description": "Reflects how command ended." } } } }, "example": { "record_type": "event", "event_type": "call.playback.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "media_name": "my_media_uploaded_to_media_storage_api", "overlay": false, "status": "completed" } } }, "CallPlaybackEndedEvent": { "type": "object", "title": "Call Playback Ended Event", "properties": { "data": { "$ref": "#/components/schemas/CallPlaybackEnded" } } }, "CallPlaybackStarted": { "type": "object", "title": "Call Playback Started", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.playback.started", "enum": [ "call.playback.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "media_url": { "type": "string", "example": "http://example.com/audio.wav", "description": "The audio URL being played back, if audio_url has been used to start." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The name of the audio media file being played back, if media_name has been used to start." }, "overlay": { "type": "boolean", "example": false, "description": "Whether the audio is going to be played in overlay mode or not." } } } }, "example": { "record_type": "event", "event_type": "call.playback.started", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "media_url": "http://example.com/audio.wav", "overlay": false } } }, "CallPlaybackStartedEvent": { "type": "object", "title": "Call Playback Started Event", "properties": { "data": { "$ref": "#/components/schemas/CallPlaybackStarted" } } }, "CallRecording": { "description": "The call recording settings for a phone number.", "type": "object", "properties": { "inbound_call_recording_enabled": { "type": "boolean", "default": false, "description": "When enabled, any inbound call to this number will be recorded." }, "inbound_call_recording_format": { "type": "string", "enum": [ "wav", "mp3" ], "default": "wav", "description": "The audio file format for calls being recorded." }, "inbound_call_recording_channels": { "type": "string", "enum": [ "single", "dual" ], "default": "single", "description": "When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B." } }, "example": { "inbound_call_recording_enabled": true, "inbound_call_recording_format": "wav", "inbound_call_recording_channels": "single" } }, "CallRecordingSaved": { "type": "object", "title": "Call Recording Saved", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.recording.saved", "enum": [ "call.recording.saved" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "recording_started_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:20:27.521992Z", "description": "ISO 8601 datetime of when recording started." }, "recording_ended_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when recording ended." }, "channels": { "type": "string", "example": "single", "enum": [ "single", "dual" ], "description": "Whether recording was recorded in `single` or `dual` channel." }, "recording_urls": { "type": "object", "description": "Recording URLs in requested format. These URLs are valid for 10 minutes. After 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings documentation, or via Mission Control under Reporting -> Recordings.", "properties": { "mp3": { "type": "string", "nullable": true, "example": "http://example.com/recording.mp3", "description": "Recording URL in requested `mp3` format." }, "wav": { "type": "string", "nullable": true, "example": "http://example.com/recording.wav", "description": "Recording URL in requested `wav` format." } } }, "public_recording_urls": { "type": "object", "description": "Recording URLs in requested format. The URL is valid for as long as the file exists. For security purposes, this feature is activated on a per request basis. Please contact customer support with your Account ID to request activation.", "properties": { "mp3": { "type": "string", "nullable": true, "example": "http://example.com/recording.mp3", "description": "Recording URL in requested `mp3` format." }, "wav": { "type": "string", "nullable": true, "example": "http://example.com/recording.wav", "description": "Recording URL in requested `wav` format." } } } } } }, "example": { "record_type": "event", "event_type": "call.recording.saved", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "recording_started_at": "2018-02-02T22:20:27.521992Z", "recording_ended_at": "2018-02-02T22:20:27.521992Z", "channels": "single", "recording_urls": { "mp3": "http://example.com/recording.mp3", "wav": "http://example.com/recording.wav" }, "public_recording_urls": { "mp3": "http://example.com/recording.mp3", "wav": "http://example.com/recording.wav" } } } }, "CallRecordingSavedEvent": { "type": "object", "title": "Call Recording Saved Event", "properties": { "data": { "$ref": "#/components/schemas/CallRecordingSaved" } } }, "CallReferCompleted": { "type": "object", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.refer.completed", "enum": [ "call.refer.completed" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "description": "Unique ID for controlling the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "sip_notify_response": { "type": "integer", "example": 200, "description": "SIP NOTIFY event status for tracking the REFER attempt." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." } } } }, "example": { "record_type": "event", "event_type": "call.refer.completed", "id": "4ce4366d-8d87-44be-a00b-942154e9c5f5", "occurred_at": "2020-03-30T13:29:44.650000Z", "payload": { "call_control_id": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "call_leg_id": "817f7de8-728a-11ea-9ce6-02420a0f8969", "call_session_id": "817f8c2a-728a-11ea-9cbe-02420a0f8969", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "connection_id": "1289082222292239760", "from": "+35319605860", "sip_notify_response": 200, "to": "+13129457420" } } }, "CallReferCompletedEvent": { "type": "object", "title": "Call Refer Completed Event", "properties": { "data": { "$ref": "#/components/schemas/CallReferCompleted" } } }, "CallReferFailed": { "type": "object", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.refer.failed", "enum": [ "call.refer.failed" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "description": "Unique ID for controlling the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "sip_notify_response": { "type": "integer", "example": 603, "description": "SIP NOTIFY event status for tracking the REFER attempt." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." } } } }, "example": { "record_type": "event", "event_type": "call.refer.failed", "id": "fbeb70e0-54eb-4e26-8d19-56b43e66f754", "occurred_at": "2020-03-30T13:29:42.130013Z", "payload": { "call_control_id": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "call_leg_id": "817f7de8-728a-11ea-9ce6-02420a0f8969", "call_session_id": "817f8c2a-728a-11ea-9cbe-02420a0f8969", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "connection_id": "1289082222292239760", "from": "+35319605860", "sip_notify_response": 603, "to": "+13129457420" } } }, "CallReferFailedEvent": { "type": "object", "title": "Call Refer Failed Event", "properties": { "data": { "$ref": "#/components/schemas/CallReferFailed" } } }, "CallReferStarted": { "type": "object", "title": "Call Refer Started", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.refer.started", "enum": [ "call.refer.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "description": "Unique ID for controlling the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "sip_notify_response": { "type": "integer", "example": 100, "description": "SIP NOTIFY event status for tracking the REFER attempt." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." } } } }, "example": { "record_type": "event", "event_type": "call.refer.started", "id": "fbeb70e0-54eb-4e26-8d19-56b43e66f754", "occurred_at": "2020-03-30T13:29:42.130013Z", "payload": { "call_control_id": "v2:OycMASgvIjsGIAVEx8x3n9rYeKnUJx6a3V8VGhs5futnr17KZhujZA", "call_leg_id": "817f7de8-728a-11ea-9ce6-02420a0f8969", "call_session_id": "817f8c2a-728a-11ea-9cbe-02420a0f8969", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "connection_id": "1289082222292239760", "from": "+35319605860", "sip_notify_response": 100, "to": "+13129457420" } } }, "CallReferStartedEvent": { "type": "object", "title": "Call Refer Started Event", "properties": { "data": { "$ref": "#/components/schemas/CallReferStarted" } } }, "CallRequest": { "type": "object", "title": "Dial Request", "required": [ "connection_id", "to", "from" ], "example": { "to": "+18005550100 or sip:username@sip.telnyx.com", "from": "+18005550101", "from_display_name": "Company Name", "connection_id": "7267xxxxxxxxxxxxxx", "audio_url": "http://www.example.com/sounds/greeting.wav", "timeout_secs": 60, "timeout_limit_secs": 60, "webhook_url": "https://www.example.com/server-b/", "webhook_url_method": "POST", "answering_machine_detection": "detect", "answering_machine_detection_config": { "total_analysis_time_millis": 5000, "after_greeting_silence_millis": 1000, "between_words_silence_millis": 1000, "greeting_duration_millis": 1000, "initial_silence_millis": 1000, "maximum_number_of_words": 1000, "maximum_word_length_millis": 2000, "silence_threshold": 512, "greeting_total_analysis_time_millis": 50000, "greeting_silence_duration_millis": 2000 }, "custom_headers": [ { "name": "head_1", "value": "val_1" }, { "name": "head_2", "value": "val_2" } ], "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "link_to": "ilditnZK_eVysupV21KzmzN_sM29ygfauQojpm4BgFtfX5hXAcjotg==", "media_encryption": "SRTP", "sip_auth_username": "username", "sip_auth_password": "password", "sip_headers": [ { "name": "User-to-User", "value": "12345" } ], "sip_transport_protocol": "TLS", "stream_url": "wss://www.example.com/websocket", "stream_track": "both_tracks", "send_silence_when_idle": true, "enable_dialogflow": false, "dialogflow_config": { "analyze_sentiment": false, "partial_automated_agent_reply": false } }, "properties": { "to": { "description": "The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided using an array of strings", "oneOf": [ { "type": "string", "example": "+18005550100 or sip:username@sip.telnyx.com" }, { "type": "array", "items": { "type": "string" }, "example": "[\"+18005550100\", \"sip:username@sip.telnyx.com\"]" } ] }, "from": { "description": "The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format.", "type": "string", "example": "+18005550101" }, "from_display_name": { "description": "The `from_display_name` string to be used as the caller id name (SIP From Display Name) presented to the destination (`to` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the `from` field.", "type": "string", "example": "Company Name" }, "connection_id": { "type": "string", "description": "The ID of the Call Control App (formerly ID of the connection) to be used when dialing the destination." }, "audio_url": { "type": "string", "example": "http://example.com/message.wav", "description": "The URL of a file to be played back to the callee when the call is answered. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played back to the callee when the call is answered. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file." }, "preferred_codecs": { "type": "string", "description": "The list of comma-separated codecs in a preferred order for the forked media to be received.", "example": "G722,PCMU,PCMA,G729,OPUS,VP8,H264" }, "timeout_secs": { "description": "The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being called. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds.", "default": 30, "type": "integer", "example": 60, "format": "int32" }, "time_limit_secs": { "description": "Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length.", "default": 14400, "type": "integer", "example": 600, "format": "int32", "minimum": 30, "maximum": 14400 }, "answering_machine_detection": { "description": "Enables Answering Machine Detection. Telnyx offers Premium and Standard detections. With Premium detection, when a call is answered, Telnyx runs real-time detection and sends a `call.machine.premium.detection.ended` webhook with one of the following results: `human_residence`, `human_business`, `machine`, `silence` or `fax_detected`. If we detect a beep, we also send a `call.machine.premium.greeting.ended` webhook with the result of `beep_detected`. If we detect a beep before `call.machine.premium.detection.ended` we only send `call.machine.premium.greeting.ended`, and if we detect a beep after `call.machine.premium.detection.ended`, we send both webhooks. With Standard detection, when a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If `greeting_end` or `detect_words` is used and a `machine` is detected, you will receive another `call.machine.greeting.ended` webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive `call.machine.greeting.ended` if a beep is detected.", "default": "disabled", "type": "string", "enum": [ "premium", "detect", "detect_beep", "detect_words", "greeting_end", "disabled" ] }, "answering_machine_detection_config": { "description": "Optional configuration parameters to modify 'answering_machine_detection' performance.", "type": "object", "properties": { "total_analysis_time_millis": { "description": "Maximum timeout threshold for overall detection.", "default": 3500, "type": "integer", "example": 5000, "format": "int32" }, "after_greeting_silence_millis": { "description": "Silence duration threshold after a greeting message or voice for it be considered human.", "default": 800, "type": "integer", "example": 1000, "format": "int32" }, "between_words_silence_millis": { "description": "Maximum threshold for silence between words.", "default": 50, "type": "integer", "example": 100, "format": "int32" }, "greeting_duration_millis": { "description": "Maximum threshold of a human greeting. If greeting longer than this value, considered machine.", "default": 3500, "type": "integer", "example": 1500, "format": "int32" }, "initial_silence_millis": { "description": "If initial silence duration is greater than this value, consider it a machine.", "default": 3500, "type": "integer", "example": 1800, "format": "int32" }, "maximum_number_of_words": { "description": "If number of detected words is greater than this value, consder it a machine.", "default": 5, "type": "integer", "example": 3, "format": "int32" }, "maximum_word_length_millis": { "description": "If a single word lasts longer than this threshold, consider it a machine.", "default": 3500, "type": "integer", "example": 2000, "format": "int32" }, "silence_threshold": { "description": "Minimum noise threshold for any analysis.", "default": 256, "type": "integer", "example": 512, "format": "int32" }, "greeting_total_analysis_time_millis": { "description": "If machine already detected, maximum timeout threshold to determine the end of the machine greeting.", "default": 5000, "type": "integer", "example": 7500, "format": "int32" }, "greeting_silence_duration_millis": { "description": "If machine already detected, maximum threshold for silence between words. If exceeded, the greeting is considered ended.", "default": 1500, "type": "integer", "example": 2000, "format": "int32" } } }, "custom_headers": { "description": "Custom headers to be added to the SIP INVITE.", "type": "array", "example": [ { "name": "head_1", "value": "val_1" }, { "name": "head_2", "value": "val_2" } ], "items": { "$ref": "#/components/schemas/CustomSipHeader" } }, "billing_group_id": { "description": "Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID.", "type": "string", "format": "uuid", "example": "f5586561-8ff0-4291-a0ac-84fe544797bd" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore others Dial commands with the same `command_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "link_to": { "description": "Use another call's control id for sharing the same call session id", "type": "string", "example": "ilditnZK_eVysupV21KzmzN_sM29ygfauQojpm4BgFtfX5hXAcjotg==" }, "media_encryption": { "description": "Defines whether media should be encrypted on the call.", "default": "disabled", "type": "string", "enum": [ "disabled", "SRTP" ] }, "sip_auth_username": { "description": "SIP Authentication username used for SIP challenges.", "type": "string" }, "sip_auth_password": { "description": "SIP Authentication password used for SIP challenges.", "type": "string" }, "sip_headers": { "description": "SIP headers to be added to the SIP INVITE request. Currently only User-to-User header is supported.", "type": "array", "example": [ { "name": "User-to-User", "value": "value" } ], "items": { "$ref": "#/components/schemas/SipHeader" } }, "sip_transport_protocol": { "description": "Defines SIP transport protocol to be used on the call.", "default": "UDP", "type": "string", "enum": [ "UDP", "TCP", "TLS" ] }, "sound_modifications": { "$ref": "#/components/schemas/SoundModifications" }, "stream_url": { "description": "The destination WebSocket address where the stream is going to be delivered.", "type": "string", "example": "wss://www.example.com/websocket" }, "stream_track": { "description": "Specifies which track should be streamed.", "type": "string", "enum": [ "inbound_track", "outbound_track", "both_tracks" ], "default": "inbound_track", "example": "both_tracks" }, "send_silence_when_idle": { "description": "Generate silence RTP packets when no transmission available.", "type": "boolean", "default": false, "example": true }, "webhook_url": { "description": "Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.", "type": "string", "example": "https://www.example.com/server-b/" }, "webhook_url_method": { "description": "HTTP request type used for `webhook_url`.", "default": "POST", "type": "string", "enum": [ "POST", "GET" ], "example": "GET" }, "record": { "description": "Start recording automatically after an event. Disabled by default.", "type": "string", "enum": [ "record-from-answer" ], "example": "record-from-answer" }, "record_channels": { "description": "Defines which channel should be recorded ('single' or 'dual') when `record` is specified.", "type": "string", "enum": [ "single", "dual" ], "default": "dual", "example": "single" }, "record_format": { "description": "Defines the format of the recording ('wav' or 'mp3') when `record` is specified.", "type": "string", "enum": [ "wav", "mp3" ], "default": "mp3", "example": "wav" }, "record_max_length": { "description": "Defines the maximum length for the recording in seconds when `record` is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite).", "type": "integer", "format": "int32", "default": 0, "example": 1000 }, "record_timeout_secs": { "description": "The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when `record` is specified. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite).", "type": "integer", "format": "int32", "default": 0, "example": 100 }, "record_trim": { "description": "When set to `trim-silence`, silence will be removed from the beginning and end of the recording.", "enum": [ "trim-silence" ], "type": "string", "example": "trim-silence" }, "record_custom_file_name": { "description": "The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix.", "type": "string", "min_length": 1, "max_length": 40, "example": "my_recording_file_name" }, "enable_dialogflow": { "description": "Enables Dialogflow for the current call. The default value is false.", "type": "boolean", "default": false, "example": true }, "dialogflow_config": { "$ref": "#/components/schemas/DialogflowConfig" } } }, "CallResource": { "type": "object", "title": "Call resource", "example": { "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b", "answered_by": null, "caller_name": "+13122010094", "date_created": "Thu, 15 Jun 2023 09:56:45 +0000", "date_updated": "Thu, 15 Jun 2023 09:56:56 +0000", "direction": "inbound", "duration": "11", "end_time": "Thu, 15 Jun 2023 09:56:56 +0000", "from": "+13123456789", "from_formatted": "(312) 345-6789", "price": null, "price_unit": null, "sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA", "start_time": "Thu, 15 Jun 2023 09:56:45 +0000", "status": "completed", "to": "+13987654321", "to_formatted": "(398) 765-4321", "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA.json" }, "properties": { "account_sid": { "type": "string", "description": "The id of the account the resource belongs to.", "example": "61bf923e-5e4d-4595-a110-56190ea18a1b" }, "answered_by": { "type": "string", "description": "The value of the answering machine detection result, if this feature was enabled for the call.", "enum": [ "human", "machine", "not_sure" ], "example": "human" }, "caller_name": { "type": "string", "description": "Caller ID, if present.", "example": "CALLER" }, "date_created": { "type": "string", "description": "The timestamp of when the resource was created.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "date_updated": { "type": "string", "description": "The timestamp of when the resource was last updated.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "direction": { "type": "string", "description": "The direction of this call.", "enum": [ "inbound", "outbound" ], "example": "inbound" }, "duration": { "type": "string", "description": "The duration of this call, given in seconds.", "example": "12" }, "end_time": { "type": "string", "description": "The end time of this call.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "from": { "type": "string", "description": "The phone number or SIP address that made this call.", "example": "+13123456789" }, "from_formatted": { "type": "string", "description": "The from number formatted for display.", "example": "(312) 345-6789" }, "price": { "type": "string", "description": "The price of this call, the currency is specified in the price_unit field. Only populated when the call cost feature is enabled for the account.", "example": "0.10" }, "price_unit": { "type": "string", "description": "The unit in which the price is given.", "example": "USD" }, "sid": { "type": "string", "description": "The identifier of this call.", "example": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA" }, "start_time": { "type": "string", "description": "The start time of this call.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "status": { "type": "string", "description": "The status of this call.", "enum": [ "ringing", "in-progress", "canceled", "completed", "failed", "busy", "no-answer" ], "example": "completed'" }, "to": { "type": "string", "description": "The phone number or SIP address that received this call.", "example": "+13987654321" }, "to_formatted": { "type": "string", "description": "The to number formatted for display.", "example": "(398) 765-4321" }, "uri": { "type": "string", "description": "The relative URI for this call.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA.json" } } }, "CallResourceIndex": { "type": "object", "title": "Multiple call resources", "example": { "calls": [], "end": 0, "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1", "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ", "page": 0, "page_size": 1, "start": 0, "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1" }, "properties": { "calls": { "type": "array", "items": { "$ref": "#/components/schemas/CallResource" } }, "end": { "type": "integer", "description": "The number of the last element on the page, zero-indexed.", "example": 19 }, "first_page_uri": { "type": "string", "description": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1", "example": "accepted" }, "next_page_uri": { "type": "string", "description": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ", "example": "accepted" }, "page": { "type": "integer", "description": "Current page number, zero-indexed.", "example": 0 }, "page_size": { "type": "integer", "description": "The number of items on the page", "example": 20 }, "start": { "type": "integer", "description": "The number of the first element on the page, zero-indexed.", "example": 0 }, "uri": { "type": "string", "description": "The URI of the current page.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1" } } }, "CallSpeakEnded": { "type": "object", "title": "Call Speak Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.speak.ended", "enum": [ "call.speak.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "status": { "type": "string", "example": "completed", "enum": [ "completed", "call_hangup", "cancelled_amd" ], "description": "Reflects how the command ended." } } } }, "example": { "record_type": "event", "event_type": "call.speak.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "status": "completed" } } }, "CallSpeakEndedEvent": { "type": "object", "title": "Call Speak Ended Event", "properties": { "data": { "$ref": "#/components/schemas/CallSpeakEnded" } } }, "CallSpeakStarted": { "type": "object", "title": "Call Speak Started", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.speak.started", "enum": [ "call.speak.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." } } } }, "example": { "record_type": "event", "event_type": "call.speak.started", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d" } } }, "CallSpeakStartedEvent": { "type": "object", "title": "Call Speak Started Event", "properties": { "data": { "$ref": "#/components/schemas/CallSpeakStarted" } } }, "CallStreamingFailed": { "type": "object", "title": "Streaming Failed", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the resource." }, "event_type": { "type": "string", "example": "streaming.failed", "enum": [ "streaming.failed" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "25dc3731-e51e-4927-a50d-a61cc25984b1", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2021-12-15T14:11:24.613295Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "failure_reason": { "type": "string", "example": "connection_failed", "description": "A short description explaning why the media streaming failed." }, "stream_id": { "type": "string", "format": "uuid", "example": "1edb94f9-7ef0-4150-b502-e0ebadfd9491", "description": "Identifies the streaming." }, "stream_params": { "type": "object", "description": "Streaming parameters as they were originally given to the Call Control API.", "properties": { "stream_url": { "type": "string", "example": "wss://www.example.com/websocket", "description": "The destination WebSocket address where the stream is going to be delivered." }, "track": { "description": "Specifies which track should be streamed.", "type": "string", "enum": [ "inbound_track", "outbound_track", "both_tracks" ], "default": "inbound_track", "example": "inbound_track" } } }, "stream_type": { "type": "string", "example": "websocket", "enum": [ "websocket", "dialogflow" ], "description": "The type of stream connection the stream is performing." } } } }, "example": { "record_type": "event", "event_type": "streaming.failed", "id": "25dc3731-e51e-4927-a50d-a61cc25984b1", "occurred_at": "2021-12-15T14:11:24.613295Z", "payload": { "call_control_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "call_session_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "failure_reason": "connection_failed", "stream_id": "1edb94f9-7ef0-4150-b502-e0ebadfd9491", "stream_params": { "stream_url": "wss://www.example.com/websocket", "stream_track": "inbound_track" }, "stream_type": "websocket" } } }, "CallStreamingFailedEvent": { "type": "object", "title": "Streaming Failed Event", "properties": { "data": { "$ref": "#/components/schemas/CallStreamingFailed" } } }, "CallStreamingStarted": { "type": "object", "title": "Streaming Started", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "streaming.started", "enum": [ "streaming.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2021-12-15T14:06:32.059436Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "stream_url": { "type": "string", "example": "wss://www.example.com/websocket", "description": "Destination WebSocket address where the stream is going to be delivered." } } } }, "example": { "record_type": "event", "event_type": "streaming.started", "id": "7d743d69-f7e8-4761-b7d4-8cacf9d3c031", "occurred_at": "2021-12-15T14:06:32.059436Z", "payload": { "call_control_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "call_session_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "stream_url": "wss://www.example.com/websocket" } } }, "CallStreamingStartedEvent": { "type": "object", "title": "Streaming Started Event", "properties": { "data": { "$ref": "#/components/schemas/CallStreamingStarted" } } }, "CallStreamingStopped": { "type": "object", "title": "Streaming Stopped", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "streaming.stopped", "enum": [ "streaming.stopped" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "25dc3731-e51e-4927-a50d-a61cc25984b1", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2021-12-15T14:11:24.613295Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "stream_url": { "type": "string", "example": "wss://www.example.com/websocket", "description": "Destination WebSocket address where the stream is going to be delivered." } } } }, "example": { "record_type": "event", "event_type": "streaming.stopped", "id": "25dc3731-e51e-4927-a50d-a61cc25984b1", "occurred_at": "2021-12-15T14:11:24.613295Z", "payload": { "call_control_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "call_session_id": "31f19208-5db0-11ec-9ea7-02420a0d3a69", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "stream_url": "wss://www.example.com/websocket" } } }, "CallStreamingStoppedEvent": { "type": "object", "title": "Streaming Stopped Event", "properties": { "data": { "$ref": "#/components/schemas/CallStreamingStopped" } } }, "CallbackWebhookMeta": { "type": "object", "properties": { "attempt": { "type": "integer", "description": "The number of times the callback webhook has been attempted.", "example": 1 }, "delivered_to": { "type": "string", "description": "The URL that the callback webhook was delivered to.", "example": "https://example.com/webhook" } } }, "CallerName": { "type": "object", "properties": { "caller_name": { "type": "string", "description": "The name of the requested phone number's owner as per the CNAM database", "example": "TELNYX LLC" }, "error_code": { "type": "string", "description": "A caller-name lookup specific error code, expressed as a stringified 5-digit integer", "example": "10001" } } }, "Campaign": { "title": "Campaign", "required": [ "brandId", "vertical", "usecase", "description" ], "type": "object", "properties": { "campaignId": { "title": "Campaignid", "type": "string", "description": "Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.", "example": "4b30017a-15eb-6a25-2e3f-59b6422cud79" }, "cspId": { "title": "Cspid", "type": "string", "description": "Alphanumeric identifier of the CSP associated with this campaign." }, "resellerId": { "title": "Resellerid", "maxLength": 8, "type": "string", "description": "Alphanumeric identifier of the reseller that you want to associate with this campaign.", "example": "RPQFAOY" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status" } ], "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status." }, "createDate": { "title": "Createdate", "type": "string", "description": "Unix timestamp when campaign was created.", "format": "date-time" }, "autoRenewal": { "title": "Autorenewal", "type": "boolean", "description": "Campaign subscription auto-renewal status." }, "billedDate": { "title": "Billeddate", "type": "string", "description": "Campaign recent billed date.", "format": "date-time" }, "brandId": { "title": "Brandid", "maxLength": 8, "type": "string", "description": "Alphanumeric identifier of the brand associated with this campaign.", "example": "4b206179-f731-8ab7-f19c-34e19d22ide9" }, "vertical": { "$ref": "#/components/schemas/Vertical" }, "usecase": { "$ref": "#/components/schemas/Usecase" }, "subUsecases": { "$ref": "#/components/schemas/Usecase" }, "description": { "title": "Description", "maxLength": 4096, "type": "string", "description": "Summary description of this campaign.", "example": "Campaign description goes here." }, "embeddedLink": { "title": "Embeddedlink", "type": "boolean", "description": "Does message generated by the campaign include URL link in SMS?", "default": false }, "embeddedPhone": { "title": "Embeddedphone", "type": "boolean", "description": "Does message generated by the campaign include phone number in SMS?", "default": false }, "affiliateMarketing": { "title": "Affiliatemarketing", "type": "boolean", "description": "Does message content controlled by affiliate marketing other than the brand?" }, "numberPool": { "title": "Numberpool", "type": "boolean", "description": "Does campaign utilize pool of phone nubers?", "default": false }, "ageGated": { "title": "Agegated", "type": "boolean", "description": "Age gated content in campaign." }, "directLending": { "title": "Directlending", "type": "boolean" }, "subscriberOptin": { "title": "Subscriberoptin", "type": "boolean", "description": "Does campaign require subscriber to opt-in before SMS is sent to subscriber?", "default": false }, "subscriberOptout": { "title": "Subscriberoptout", "type": "boolean", "description": "Does campaign support subscriber opt-out keyword(s)?", "default": false }, "subscriberHelp": { "title": "Subscriberhelp", "type": "boolean", "description": "Does campaign responds to help keyword(s)?", "default": false }, "sample1": { "title": "Sample1", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 1 or more message samples.", "example": "This is a an updated message!" }, "sample2": { "title": "Sample2", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 2 or more message samples.", "example": "This is a newly created message!" }, "sample3": { "title": "Sample3", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 3 or more message samples.", "example": "This is a newly created message!" }, "sample4": { "title": "Sample4", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 4 or more message samples." }, "sample5": { "title": "Sample5", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 5 or more message samples." }, "messageFlow": { "title": "Messageflow", "maxLength": 2048, "type": "string", "description": "Message flow description." }, "helpMessage": { "title": "Helpmessage", "maxLength": 255, "type": "string", "description": "Help message of the campaign." } } }, "CampaignCSP": { "title": "CampaignCSP", "required": [ "brandId", "vertical", "usecase", "description" ], "type": "object", "properties": { "campaignId": { "title": "Campaignid", "type": "string", "description": "Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC.", "example": "4b30017a-15eb-6a25-2e3f-59b6422cud79" }, "resellerId": { "title": "Resellerid", "maxLength": 8, "type": "string", "description": "Alphanumeric identifier of the reseller that you want to associate with this campaign.", "example": "RPQFAOY" }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status" } ], "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status." }, "createDate": { "title": "Createdate", "type": "string", "description": "Unix timestamp when campaign was created.", "format": "date-time" }, "autoRenewal": { "title": "Autorenewal", "type": "boolean", "description": "Campaign subscription auto-renewal status." }, "billedDate": { "title": "Billeddate", "type": "string", "description": "Campaign recent billed date.", "format": "date-time" }, "brandId": { "title": "Brandid", "maxLength": 8, "type": "string", "description": "Alphanumeric identifier of the brand associated with this campaign.", "example": "4b206179-f731-8ab7-f19c-34e19d22ide9" }, "vertical": { "$ref": "#/components/schemas/Vertical" }, "usecase": { "$ref": "#/components/schemas/Usecase" }, "subUsecases": { "$ref": "#/components/schemas/Usecase" }, "description": { "title": "Description", "maxLength": 4096, "type": "string", "description": "Summary description of this campaign.", "example": "Campaign description goes here." }, "embeddedLink": { "title": "Embeddedlink", "type": "boolean", "description": "Does message generated by the campaign include URL link in SMS?", "default": false }, "embeddedPhone": { "title": "Embeddedphone", "type": "boolean", "description": "Does message generated by the campaign include phone number in SMS?", "default": false }, "affiliateMarketing": { "title": "Affiliatemarketing", "type": "boolean", "description": "Does message content controlled by affiliate marketing other than the brand?" }, "numberPool": { "title": "Numberpool", "type": "boolean", "description": "Does campaign utilize pool of phone nubers?", "default": false }, "ageGated": { "title": "Agegated", "type": "boolean", "description": "Age gated content in campaign." }, "directLending": { "title": "Directlending", "type": "boolean" }, "subscriberOptin": { "title": "Subscriberoptin", "type": "boolean", "description": "Does campaign require subscriber to opt-in before SMS is sent to subscriber?", "default": false }, "subscriberOptout": { "title": "Subscriberoptout", "type": "boolean", "description": "Does campaign support subscriber opt-out keyword(s)?", "default": false }, "subscriberHelp": { "title": "Subscriberhelp", "type": "boolean", "description": "Does campaign responds to help keyword(s)?", "default": false }, "sample1": { "title": "Sample1", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 1 or more message samples.", "example": "This is a sample message associated with your campaign!" }, "sample2": { "title": "Sample2", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 2 or more message samples." }, "sample3": { "title": "Sample3", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 3 or more message samples." }, "sample4": { "title": "Sample4", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 4 or more message samples." }, "sample5": { "title": "Sample5", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 5 or more message samples." }, "messageFlow": { "title": "Messageflow", "maxLength": 2048, "type": "string", "description": "Message flow description." }, "helpMessage": { "title": "Helpmessage", "maxLength": 255, "type": "string", "description": "Help message of the campaign." } } }, "CampaignCost": { "title": "CampaignCost", "required": [ "campaignUsecase", "monthlyCost", "upFrontCost", "description" ], "type": "object", "properties": { "campaignUsecase": { "title": "Campaignusecase", "type": "string" }, "monthlyCost": { "title": "Monthlycost", "type": "string" }, "upFrontCost": { "title": "Upfrontcost", "type": "string" }, "description": { "title": "Description", "type": "string" } } }, "CampaignDeletionResponse": { "title": "CampaignDeletionResponse", "required": [ "time" ], "type": "object", "properties": { "time": { "title": "Time", "type": "number" }, "record_type": { "title": "Record Type", "type": "string" }, "message": { "title": "Message", "type": "string" } } }, "CampaignRecordSetCSP": { "title": "CampaignRecordSetCSP", "type": "object", "properties": { "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/CampaignCSP" } }, "page": { "title": "Page", "type": "integer", "example": 1 }, "totalRecords": { "title": "Totalrecords", "type": "integer", "example": 1 } } }, "CampaignRecordSet_CSP": { "title": "CampaignRecordSet_CSP", "type": "object", "properties": { "page": { "title": "Page", "type": "integer" }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Campaign_CSP" } }, "totalRecords": { "title": "Totalrecords", "type": "integer" } } }, "CampaignRequest": { "title": "CampaignRequest", "required": [ "brandId", "description", "usecase" ], "type": "object", "properties": { "affiliateMarketing": { "title": "Affiliatemarketing", "type": "boolean", "description": "Does message content controlled by affiliate marketing other than the brand?" }, "ageGated": { "title": "Agegated", "type": "boolean", "description": "Age gated message content in campaign." }, "autoRenewal": { "title": "Autorenewal", "type": "boolean", "description": "Campaign subscription auto-renewal option. If set to true, then campaign will automatically renewal at end of billing cycle." }, "brandId": { "title": "Brandid", "type": "string", "description": "Alphanumeric identifier of the brand associated with this campaign." }, "description": { "title": "Description", "type": "string", "description": "Summary description of this campaign." }, "directLending": { "title": "Directlending", "type": "boolean", "description": "Direct lending or loan arrangement" }, "embeddedLink": { "title": "Embeddedlink", "type": "boolean", "description": "Does message generated by the campaign include URL link in SMS?" }, "embeddedPhone": { "title": "Embeddedphone", "type": "boolean", "description": "Does message generated by the campaign include phone number in SMS?" }, "helpKeywords": { "title": "Helpkeywords", "type": "string", "description": "Subscriber help keywords. Multiple keywords are comma separated without space." }, "helpMessage": { "title": "Helpmessage", "type": "string", "description": "Help message of the campaign." }, "messageFlow": { "title": "Messageflow", "type": "string", "description": "Message flow description." }, "mnoIds": { "title": "Mnoids", "uniqueItems": true, "type": "array", "items": { "type": "integer" }, "description": "Submit campaign to given list of MNOs by MNO's network ID. Default is all MNOs if no value provided." }, "numberPool": { "title": "Numberpool", "type": "boolean", "description": "Does campaign utilize pool of phone numbers?" }, "optinKeywords": { "title": "Optinkeywords", "type": "string", "description": "Subscriber opt-in keywords. Multiple keywords are comma separated without space." }, "optinMessage": { "title": "Optinmessage", "type": "string", "description": "Subscriber opt-in message." }, "optoutKeywords": { "title": "Optoutkeywords", "type": "string", "description": "Subscriber opt-out keywords. Multiple keywords are comma separated without space." }, "optoutMessage": { "title": "Optoutmessage", "type": "string", "description": "Subscriber opt-out message." }, "referenceId": { "title": "Referenceid", "type": "string", "description": "Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations." }, "resellerId": { "title": "Resellerid", "type": "string", "description": "Alphanumeric identifier of the reseller that you want to associate with this campaign." }, "sample1": { "title": "Sample1", "type": "string", "description": "Message sample. Some campaign tiers require 1 or more message samples." }, "sample2": { "title": "Sample2", "type": "string", "description": "Message sample. Some campaign tiers require 2 or more message samples." }, "sample3": { "title": "Sample3", "type": "string", "description": "Message sample. Some campaign tiers require 3 or more message samples." }, "sample4": { "title": "Sample4", "type": "string", "description": "Message sample. Some campaign tiers require 4 or more message samples." }, "sample5": { "title": "Sample5", "type": "string", "description": "Message sample. Some campaign tiers require 5 or more message samples." }, "subUsecases": { "title": "Subusecases", "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases" }, "subscriberHelp": { "title": "Subscriberhelp", "type": "boolean", "description": "Does campaign responds to help keyword(s)?" }, "subscriberOptin": { "title": "Subscriberoptin", "type": "boolean", "description": "Does campaign require subscriber to opt-in before SMS is sent to subscriber?" }, "subscriberOptout": { "title": "Subscriberoptout", "type": "boolean", "description": "Does campaign support subscriber opt-out keyword(s)?" }, "tag": { "title": "Tag", "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Tags to be set on the Campaign." }, "termsAndConditions": { "title": "Termsandconditions", "type": "boolean", "description": "Is terms and conditions accepted?" }, "usecase": { "title": "Usecase", "type": "string", "description": "Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand." }, "webhookURL": { "title": "WebhookURL", "type": "string", "description": "Webhook to which campaign status updates are sent." }, "webhookFailoverURL": { "title": "WebhookFailoverURL", "type": "string", "description": "Failover webhook to which campaign status updates are sent." } }, "description": "CampaignRequest object describes the campaign to be submitted via '/campaignBuilder/brand/{brandId}/usecase/{usecase}' operation. It is also used in operations for retrieving status of campaign request and for updating a pending request." }, "CampaignSharingChain": { "title": "CampaignSharingChain", "type": "object", "properties": { "sharedByMe": { "$ref": "#/components/schemas/CampaignSharingStatus" }, "sharedWithMe": { "$ref": "#/components/schemas/CampaignSharingStatus" } } }, "CampaignSharingStatus": { "title": "CampaignSharingStatus", "type": "object", "properties": { "downstreamCnpId": { "title": "Downstreamcnpid", "type": "string" }, "sharedDate": { "title": "Shareddate", "type": "string" }, "sharingStatus": { "title": "Sharingstatus", "type": "string" }, "statusDate": { "title": "Statusdate", "type": "string" }, "upstreamCnpId": { "title": "Upstreamcnpid", "type": "string" } } }, "CampaignStatus": { "properties": { "description": { "description": "The campaign description.", "example": "This campaign belongs to John's Donuts and will be used for marketing.", "title": "Description", "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/CreationStatus" } ], "description": "The current status of the campaign.", "example": "pending" }, "campaignId": { "description": "The ID of the campaign created via bulk creation. This campaign will only have a campaignId after the campaign has been created.", "example": "4b30017a-2f50-4c90-c9e6-5f67304cbde7", "title": "Campaignid", "type": "string" }, "created_at": { "description": "The date and time that the campaign was created.", "example": "2021-06-30T10:49:04-07:00", "format": "date-time", "title": "Created At", "type": "string" }, "error": { "description": "Errors related to a campaign creation failure.", "example": "More sample messages required for some mobile network operators.", "title": "Error", "type": "string" } }, "required": [ "description", "status" ], "title": "CampaignStatus", "type": "object" }, "CampaignStatusUpdateEvent": { "title": "Campaign Status Update Event", "type": "object", "properties": { "brandId": { "title": "Brandid", "type": "string", "description": "Brand ID associated with the campaign.", "example": "d88dd2aa-1bb9-4ef0-9ec8-1752b80316a5" }, "campaignId": { "title": "Campaignid", "type": "string", "description": "The ID of the campaign.", "example": "4b300178-131c-d902-d54e-72d90ba1620j" }, "createDate": { "title": "CreateDate", "type": "string", "description": "Unix timestamp when campaign was created." }, "cspId": { "title": "Cspid", "type": "string", "description": "Alphanumeric identifier of the CSP associated with this campaign." }, "isTMobileRegistered": { "title": "IsTMobileRegistered", "type": "boolean", "description": "Indicates whether the campaign is registered with T-Mobile." }, "isTMobileSuspended": { "title": "isTMobileSuspended", "type": "boolean", "description": "Indicates whether the campaign is suspended with T-Mobile." } } }, "Campaign_CSP": { "title": "Campaign_CSP", "required": [ "brandId", "campaignId", "cspId", "description", "mock", "subUsecases", "termsAndConditions", "usecase" ], "type": "object", "properties": { "affiliateMarketing": { "title": "Affiliatemarketing", "type": "boolean", "description": "Does message content controlled by affiliate marketing other than the brand?\n\nThis field is deprecated.", "deprecated": true }, "ageGated": { "title": "Agegated", "type": "boolean", "description": "Age gated content in campaign." }, "autoRenewal": { "title": "Autorenewal", "type": "boolean", "description": "Campaign subscription auto-renewal status." }, "billedDate": { "title": "Billeddate", "type": "string", "description": "Campaign recent billed date." }, "brandId": { "title": "Brandid", "type": "string", "description": "Alphanumeric identifier of the brand associated with this campaign." }, "campaignId": { "title": "Campaignid", "type": "string", "description": "Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC." }, "createDate": { "title": "Createdate", "type": "string", "description": "Unix timestamp when campaign was created." }, "cspId": { "title": "Cspid", "type": "string", "description": "Alphanumeric identifier of the CSP associated with this campaign." }, "description": { "title": "Description", "type": "string", "description": "Summary description of this campaign." }, "directLending": { "title": "Directlending", "type": "boolean" }, "embeddedLink": { "title": "Embeddedlink", "type": "boolean", "description": "Does message generated by the campaign include URL link in SMS?" }, "embeddedPhone": { "title": "Embeddedphone", "type": "boolean", "description": "Does message generated by the campaign include phone number in SMS?" }, "helpKeywords": { "title": "Helpkeywords", "type": "string", "description": "Subscriber help keywords. Multiple keywords are comma separated without space." }, "helpMessage": { "title": "Helpmessage", "type": "string", "description": "Help message of the campaign." }, "messageFlow": { "title": "Messageflow", "type": "string", "description": "Message flow description." }, "mock": { "title": "Mock", "type": "boolean", "description": "Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP." }, "nextRenewalOrExpirationDate": { "title": "Nextrenewalorexpirationdate", "type": "string", "description": "When the campaign would be due for its next renew/bill date." }, "numberPool": { "title": "Numberpool", "type": "boolean", "description": "Does campaign utilize pool of phone numbers?" }, "optinKeywords": { "title": "Optinkeywords", "type": "string", "description": "Subscriber opt-in keywords. Multiple keywords are comma separated without space." }, "optinMessage": { "title": "Optinmessage", "type": "string", "description": "Subscriber opt-in message." }, "optoutKeywords": { "title": "Optoutkeywords", "type": "string", "description": "Subscriber opt-out keywords. Multiple keywords are comma separated without space." }, "optoutMessage": { "title": "Optoutmessage", "type": "string", "description": "Subscriber opt-out message." }, "referenceId": { "title": "Referenceid", "type": "string", "description": "Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations." }, "resellerId": { "title": "Resellerid", "type": "string", "description": "Alphanumeric identifier of the reseller that you want to associate with this campaign." }, "sample1": { "title": "Sample1", "type": "string", "description": "Message sample. Some campaign tiers require 1 or more message samples." }, "sample2": { "title": "Sample2", "type": "string", "description": "Message sample. Some campaign tiers require 2 or more message samples." }, "sample3": { "title": "Sample3", "type": "string", "description": "Message sample. Some campaign tiers require 3 or more message samples." }, "sample4": { "title": "Sample4", "type": "string", "description": "Message sample. Some campaign tiers require 4 or more message samples." }, "sample5": { "title": "Sample5", "type": "string", "description": "Message sample. Some campaign tiers require 5 or more message samples." }, "status": { "title": "Status", "type": "string", "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. " }, "subUsecases": { "title": "Subusecases", "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases" }, "subscriberHelp": { "title": "Subscriberhelp", "type": "boolean", "description": "Does campaign responds to help keyword(s)?" }, "subscriberOptin": { "title": "Subscriberoptin", "type": "boolean", "description": "Does campaign require subscriber to opt-in before SMS is sent to subscriber?" }, "subscriberOptout": { "title": "Subscriberoptout", "type": "boolean", "description": "Does campaign support subscriber opt-out keyword(s)?" }, "termsAndConditions": { "title": "Termsandconditions", "type": "boolean", "description": "Is terms & conditions accepted?" }, "usecase": { "title": "Usecase", "type": "string", "description": "Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand." }, "vertical": { "title": "Vertical", "type": "string", "description": "Business/industry segment of this campaign (Deprecated). Must be of defined valid types. Use `/registry/enum/vertical` operation to retrieve verticals available for given brand, vertical combination.\n\nThis field is deprecated.", "deprecated": true }, "webhookURL": { "title": "WebhookURL", "type": "string", "description": "Webhook to which campaign status updates are sent.", "example": "https://example.com/webhook" }, "webhookFailoverURL": { "title": "WebhookFailoverURL", "type": "string", "description": "Failover webhook to which campaign status updates are sent.", "example": "https://example.com/failover-webhook" }, "isTMobileRegistered": { "title": "IsTMobileRegistered", "type": "boolean", "description": "Indicates whether the campaign is registered with T-Mobile." }, "isTMobileSuspended": { "title": "isTMobileSuspended", "type": "boolean", "description": "Indicates whether the campaign is suspended with T-Mobile." } }, "description": "Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including **usecase**, **vertical**, **brandId** and **cspId**." }, "Carrier": { "type": "object", "properties": { "mobile_country_code": { "type": "string", "description": "Region code that matches the specific country calling code if the requested phone number type is mobile", "example": "US" }, "mobile_network_code": { "type": "string", "description": "National destination code (NDC), with a 0 prefix, if an NDC is found and the requested phone number type is mobile", "example": "0866" }, "name": { "type": "string", "description": "SPID (Service Provider ID) name, if the requested phone number has been ported; otherwise, the name of carrier who owns the phone number block", "example": "Telnyx/4" }, "type": { "type": "string", "description": "A phone number type that identifies the type of service associated with the requested phone number", "enum": [ "fixed line", "mobile", "voip", "fixed line or mobile", "toll free", "premium rate", "shared cost", "personal number", "pager", "uan", "voicemail", "unknown" ], "example": "voip" }, "error_code": { "type": "string", "description": "Unused", "example": null }, "normalized_carrier": { "type": "string", "description": "If known to Telnyx and applicable, the primary network carrier.", "example": "AT&T" } } }, "CdrGetSyncUsageReportResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CdrUsageReportResponse" } } }, "CdrUsageReportResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifies the resource", "format": "uuid" }, "start_time": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z" }, "end_time": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z" }, "connections": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "example": "[1234567890L, 9876543210L]", "items": { "type": "integer", "format": "int64" } }, "aggregation_type": { "type": "string", "enum": [ "NO_AGGREGATION", "CONNECTION", "TAG", "BILLING_GROUP" ] }, "status": { "type": "string", "enum": [ "PENDING", "COMPLETE", "FAILED", "EXPIRED" ] }, "report_url": { "type": "string", "example": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv" }, "result": { "type": "object" }, "created_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z" }, "record_type": { "type": "string", "example": "cdr_usage_report" }, "product_breakdown": { "type": "string", "enum": [ "NO_BREAKDOWN", "DID_VS_TOLL_FREE", "COUNTRY", "DID_VS_TOLL_FREE_PER_COUNTRY" ] } } }, "CivicAddress": { "type": "object", "title": "Civic Address", "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "civic_address" }, "city_or_town": { "type": "string", "example": "Chicago" }, "city_or_town_alias": { "type": "string" }, "company_name": { "type": "string", "example": "Telnyx" }, "country": { "type": "string", "example": "US" }, "country_or_district": { "type": "string", "example": "US" }, "default_location_id": { "type": "string", "format": "uuid", "description": "Identifies what is the default location in the list of locations." }, "description": { "type": "string", "example": "Chicago Office" }, "house_number": { "type": "string", "example": "311" }, "house_number_suffix": { "type": "string" }, "postal_or_zip_code": { "type": "string", "example": "60654" }, "state_or_province": { "type": "string", "example": "IL" }, "street_name": { "type": "string", "example": "West Superior Street" }, "street_suffix": { "type": "string" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Location" } } }, "example": { "id": "07a4dc5d-9b3b-4ba2-88a4-6ba172316c65", "record_type": "civic_address", "city_or_town": "Chicago", "city_or_town_alias": null, "company_name": "Telnyx", "country": "US", "county_or_district": "US", "default_location_id": "18ded4bb-b694-44c1-a89b-a35b7acd4c9e", "description": "Chicago Office", "house_number": "311", "house_number_suffix": null, "locations": [ { "id": "18ded4bb-b694-44c1-a89b-a35b7acd4c9e", "additional_info": null, "description": "Chicago Office", "is_default": true }, { "id": "d420a57f-c4ae-4697-87e1-fbefd9e86f72", "additional_info": "Main building, Suite 504", "description": null, "is_default": false } ], "postal_or_zip_code": "60654", "state_or_province": "IL", "street_name": "West Superior Street", "street_suffix": null } }, "ClientStateUpdateRequest": { "type": "object", "title": "Update client state Request", "required": [ "client_state" ], "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d" } }, "CloudflareSyncStatus": { "title": "CloudflareSyncStatus", "enum": [ "pending", "added" ], "type": "string", "description": "An enumeration." }, "CnamListing": { "description": "The CNAM listing settings for a phone number.", "type": "object", "properties": { "cnam_listing_enabled": { "type": "boolean", "default": false, "description": "Enables CNAM listings for this number. Requires cnam_listing_details to also be set." }, "cnam_listing_details": { "type": "string", "description": "The CNAM listing details for this number. Must be alphanumeric characters or spaces with a maximum length of 15. Requires cnam_listing_enabled to also be set to true." } }, "example": { "cnam_listing_enabled": true, "cnam_listing_details": "example" } }, "Comment": { "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "body": { "type": "string", "example": "Hi there, ...." }, "commenter": { "type": "string", "example": "user@company.com", "readOnly": true }, "commenter_type": { "type": "string", "example": "user", "enum": [ "admin", "user" ], "readOnly": true }, "comment_record_type": { "type": "string", "example": "sub_number_order", "enum": [ "number_order", "sub_number_order", "number_order_phone_number" ] }, "comment_record_id": { "type": "string", "format": "uuid", "example": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" }, "read_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the comment was read.", "example": null, "readOnly": true }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the comment was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the comment was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true } } }, "CompleteOTAUpdate": { "type": "object", "title": "OTAUpdate", "description": "This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card.

", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "example": "ota_update", "readOnly": true }, "sim_card_id": { "type": "string", "format": "uuid", "description": "The identification UUID of the related SIM card resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "type": { "type": "string", "description": "Represents the type of the operation requested. This will relate directly to the source of the request.", "enum": [ "sim_card_network_preferences" ], "example": "sim_card_network_preferences" }, "status": { "type": "string", "enum": [ "in-progress", "completed", "failed" ], "example": "in-progress" }, "settings": { "type": "object", "description": "A JSON object representation of the operation. The information present here will relate directly to the source of the OTA request.", "properties": { "mobile_network_operators_preferences": { "$ref": "#/components/schemas/MobileNetworkOperatorsPreferencesResponse" } } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } }, "example": { "created_at": "2018-02-02T22:25:27.521Z", "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "ota_update", "settings": { "mobile_network_operators_preferences": [ { "mobile_network_operator_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "mobile_network_operator_name": "AT&T Mobility (USACG)", "priority": 0 } ] }, "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "status": "in-progress", "type": "sim_card_network_preferences", "updated_at": "2018-02-02T22:25:27.521Z" } }, "CompositionCompleted": { "type": "object", "title": "Composition Completed", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "An identifier for the type of the resource." }, "event_type": { "type": "string", "example": "video.room.composition.completed", "enum": [ "video.room.composition.completed" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Uniquely identify the event." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "composition_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Composition ID that identifies the room composition." }, "download_url": { "description": "Url to download the room composition.", "type": "string", "example": "https://www.example.com" }, "duration_secs": { "description": "Room composition duration in seconds.", "type": "integer", "example": 67 }, "format": { "description": "Format of the room composition.", "type": "string", "example": "mp4" }, "resolution": { "description": "Format of the room composition.", "type": "string", "example": "1280x720" }, "room_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Room ID associated with the room composition." }, "session_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Session ID associated with the room composition." }, "size_mb": { "description": "Room composition size in MB.", "type": "number", "format": "float", "example": 10.5 } } } }, "example": { "record_type": "event", "event_type": "video.room.composition.completed", "id": "d51754fc-6888-4b0e-8f29-fc3ae41250cd", "occurred_at": "2022-03-02 04:47:29.980874Z", "payload": { "composition_id": "5970ce77-4aeb-4e18-ac8c-3effca0c145a", "download_url": "https://www.example.com", "duration_secs": 53, "format": "mp4", "resolution": "1280x720", "room_id": "2fbf2c0d-b6aa-463f-aeed-83ce298be978", "session_id": "7c4da191-2600-4df6-a35e-0ecae6caa5d3", "size_mb": 2.6 } } }, "CompositionCompletedEvent": { "type": "object", "title": "Composition Completed Event", "properties": { "data": { "$ref": "#/components/schemas/CompositionCompleted" } } }, "Conference": { "type": "object", "title": "Conference", "required": [ "record_type", "id", "name", "created_at", "expires_at" ], "properties": { "record_type": { "type": "string", "enum": [ "conference" ], "example": "conference" }, "id": { "type": "string", "description": "Uniquely identifies the conference", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "description": "Name of the conference", "example": "All hands meeting" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the conference was created", "example": "2019-01-23T18:10:02.574Z" }, "expires_at": { "type": "string", "description": "ISO 8601 formatted date of when the conference will expire", "example": "2019-01-23T18:10:02.574Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the conference was last updated", "example": "2019-01-23T18:10:02.574Z" }, "region": { "type": "string", "description": "Region where the conference is hosted", "example": "sv1" }, "status": { "type": "string", "enum": [ "init", "in_progress", "completed" ], "description": "Status of the conference", "example": "completed" }, "end_reason": { "type": "string", "enum": [ "all_left", "ended_via_api", "host_left", "time_exceeded" ], "description": "Reason why the conference ended", "example": "all_left" }, "ended_by": { "type": "object", "description": "IDs related to who ended the conference. It is expected for them to all be there or all be null", "properties": { "call_control_id": { "type": "string", "description": "Call Control ID which ended the conference", "example": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==" }, "call_session_id": { "type": "string", "description": "Call Session ID which ended the conference", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1" } } }, "connection_id": { "type": "string", "description": "Identifies the connection associated with the conference", "example": "3fa85f64-9191-4567-b3fc-2c963f66afa6" } }, "example": { "record_type": "conference", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "All hands meeting", "created_at": "2019-01-23T18:10:02.574Z", "expires_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z", "region": "sv1", "status": "completed", "end_reason": "all_left", "ended_by": { "call_control_id": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==", "call_session_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1" }, "connection_id": "3fa85f64-9191-4567-b3fc-2c963f66afa6" } }, "ConferenceCommandResult": { "type": "object", "title": "Conference Command Result", "required": [ "result" ], "properties": { "result": { "type": "string", "example": "ok" } }, "example": { "result": "ok" } }, "ConferenceCreated": { "type": "object", "title": "Conference Created", "example": { "record_type": "event", "event_type": "conference.created", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.created", "enum": [ "conference.created" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "Conference ID that the participant joined." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferenceCreatedEvent": { "type": "object", "title": "Conference Created Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceCreated" } } }, "ConferenceDetailRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "Conference id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "name": { "type": "string", "description": "Conference name", "example": "My Conference" }, "user_id": { "type": "string", "description": "User id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "started_at": { "type": "string", "description": "Conference start time", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "ended_at": { "type": "string", "description": "Conference end time", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "expires_at": { "type": "string", "description": "Conference expiry time", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "region": { "type": "string", "description": "Region where the conference is hosted", "example": "ch1" }, "call_leg_id": { "type": "string", "description": "Telnyx UUID that identifies the conference call leg", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "call_session_id": { "type": "string", "description": "Telnyx UUID that identifies with conference call session", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "connection_id": { "type": "string", "description": "Connection id", "example": "1583941447772537867" }, "call_sec": { "type": "integer", "description": "Duration of the conference call in seconds", "example": 100 }, "participant_count": { "type": "integer", "description": "Number of participants that joined the conference call", "example": 5 }, "participant_call_sec": { "type": "integer", "description": "Sum of the conference call duration for all participants in seconds", "example": 100 }, "is_telnyx_billable": { "type": "boolean", "description": "Indicates whether Telnyx billing charges might be applicable", "example": false }, "record_type": { "type": "string", "example": "conference_detail_record", "default": "conference_detail_record" } }, "required": [ "record_type" ] }, "ConferenceEnded": { "type": "object", "title": "Conference Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.ended", "enum": [ "conference.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "Conference ID that the participant joined." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." }, "reason": { "type": "string", "enum": [ "all_left", "host_left", "time_exceeded" ], "description": "Reason the conference ended." } } } }, "example": { "record_type": "event", "event_type": "conference.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "occured_at": "2018-02-02T22:25:27.521Z", "reason": "host_left" } } }, "ConferenceEndedEvent": { "type": "object", "title": "Conference Ended Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceEnded" } } }, "ConferenceFloorChangedEvent": { "type": "object", "title": "Conference Floor Changed", "example": { "record_type": "event", "event_type": "conference.floor.changed", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.floor.changed", "enum": [ "conference.floor.changed" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call Control ID of the new speaker." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "Call Leg ID of the new speaker." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "Call Session ID of the new speaker." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "Conference ID that had a speaker change event." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferenceHoldRequest": { "type": "object", "title": "Conference Hold Request", "properties": { "call_control_ids": { "description": "List of unique identifiers and tokens for controlling the call. When empty all participants will be placed on hold.", "type": "array", "items": { "type": "string" } }, "audio_url": { "type": "string", "example": "http://example.com/message.wav", "description": "The URL of a file to be played to the participants when they are put on hold. media_name and audio_url cannot be used together in one request." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played to the participants when they are put on hold. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file." } }, "example": { "call_control_ids": [ "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" ], "audio_url": "http://example.com/message.wav" } }, "ConferenceMuteRequest": { "type": "object", "title": "Conference Mute Request", "properties": { "call_control_ids": { "description": "Array of unique identifiers and tokens for controlling the call. When empty all participants will be muted.", "type": "array", "items": { "type": "string" } } }, "example": { "call_control_ids": [ "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" ] } }, "ConferenceParticipantDetailRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "Participant id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "user_id": { "type": "string", "description": "User id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "conference_id": { "type": "string", "description": "Conference id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "joined_at": { "type": "string", "description": "Participant join time", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "left_at": { "type": "string", "description": "Participant leave time", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "destination_number": { "type": "string", "description": "Number called by the participant to join the conference", "example": "+18005550199" }, "originating_number": { "type": "string", "description": "Participant origin number used in the conference call", "example": "+18005550199" }, "call_leg_id": { "type": "string", "description": "Telnyx UUID that identifies the conference call leg", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "call_session_id": { "type": "string", "description": "Telnyx UUID that identifies with conference call session", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "call_sec": { "type": "integer", "description": "Duration of the conference call in seconds", "example": 100 }, "billed_sec": { "type": "integer", "description": "Duration of the conference call for billing purposes", "example": 120 }, "is_telnyx_billable": { "type": "boolean", "description": "Indicates whether Telnyx billing charges might be applicable", "example": true }, "rate": { "type": "string", "description": "Currency amount per billing unit used to calculate the Telnyx billing cost", "example": "0.002" }, "rate_measured_in": { "type": "string", "description": "Billing unit used to calculate the Telnyx billing cost", "example": "minutes" }, "cost": { "type": "string", "description": "Currency amount for Telnyx billing cost", "example": "0.004" }, "currency": { "type": "string", "description": "Telnyx account currency used to describe monetary values, including billing cost", "example": "USD" }, "record_type": { "type": "string", "example": "conference_participant_detail_record", "default": "conference_participant_detail_record" } }, "required": [ "record_type" ] }, "ConferenceParticipantJoined": { "type": "object", "title": "Conference Participant Joined", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.participant.joined", "enum": [ "conference.participant.joined" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "Conference ID that the participant joined." } } } }, "example": { "record_type": "event", "event_type": "conference.participant.joined", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1" } } }, "ConferenceParticipantJoinedEvent": { "type": "object", "title": "Conference Participant Joined Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceParticipantJoined" } } }, "ConferenceParticipantLeft": { "type": "object", "title": "Conference Participant Left", "example": { "record_type": "event", "event_type": "conference.participant.left", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.participant.left", "enum": [ "conference.participant.left" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "Conference ID that the participant joined." } } } } }, "ConferenceParticipantLeftEvent": { "type": "object", "title": "Conference Participant Left Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceParticipantLeft" } } }, "ConferenceParticipantPlaybackEnded": { "type": "object", "title": "Conference Participant Playback Ended", "example": { "record_type": "event", "event_type": "conference.participant.playback.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "creator_call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "media_url": "https://www.example.com/audio.mp3", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.participant.playback.ended", "enum": [ "conference.participant.playback.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Participant's call ID used to issue commands via Call Control API." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "creator_call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session that started the conference." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference the text was spoken in." }, "media_url": { "type": "string", "example": "http://example.com/audio.wav", "description": "The audio URL being played back, if audio_url has been used to start." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The name of the audio media file being played back, if media_name has been used to start." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferenceParticipantPlaybackEndedEvent": { "type": "object", "title": "Conference Participant Playback Ended Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceParticipantPlaybackEnded" } } }, "ConferenceParticipantPlaybackStarted": { "type": "object", "title": "Conference Participant Playback Started", "example": { "record_type": "event", "event_type": "conference.participant.playback.started", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "creator_call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "media_url": "https://www.example.com/audio.mp3", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.participant.playback.started", "enum": [ "conference.participant.playback.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Participant's call ID used to issue commands via Call Control API." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "creator_call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session that started the conference." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference the text was spoken in." }, "media_url": { "type": "string", "example": "http://example.com/audio.wav", "description": "The audio URL being played back, if audio_url has been used to start." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The name of the audio media file being played back, if media_name has been used to start." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferenceParticipantPlaybackStartedEvent": { "type": "object", "title": "Conference Participant Playback Started Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceParticipantPlaybackStarted" } } }, "ConferenceParticipantSpeakEnded": { "type": "object", "title": "Conference Participant Speak Ended", "example": { "record_type": "event", "event_type": "conference.participant.speak.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "creator_call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.participant.speak.ended", "enum": [ "conference.participant.speak.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Participant's call ID used to issue commands via Call Control API." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "creator_call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session that started the conference." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference the text was spoken in." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferenceParticipantSpeakEndedEvent": { "type": "object", "title": "Conference Participant Speak Ended Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceParticipantSpeakEnded" } } }, "ConferenceParticipantSpeakStarted": { "type": "object", "title": "Conference Participant Speak Started", "example": { "record_type": "event", "event_type": "conference.participant.speak.started", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "creator_call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.participant.speak.started", "enum": [ "conference.participant.speak.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Participant's call ID used to issue commands via Call Control API." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "creator_call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session that started the conference." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference the text was spoken in." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferenceParticipantSpeakStartedEvent": { "type": "object", "title": "Conference Participant Speak Started Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceParticipantSpeakStarted" } } }, "ConferencePlayRequest": { "type": "object", "title": "Conference Play Request", "properties": { "audio_url": { "type": "string", "example": "http://example.com/message.wav", "description": "The URL of a file to be played back in the conference. media_name and audio_url cannot be used together in one request." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played back in the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file." }, "loop": { "description": "The number of times the audio file should be played. If supplied, the value must be an integer between 1 and 100, or the special string `infinity` for an endless loop.", "example": "infinity", "default": 1, "$ref": "#/components/schemas/Loopcount" }, "call_control_ids": { "description": "List of call control ids identifying participants the audio file should be played to. If not given, the audio file will be played to the entire conference.", "type": "array", "items": { "type": "string" } } }, "example": { "audio_url": "http://www.example.com/sounds/greeting.wav" } }, "ConferencePlaybackEnded": { "type": "object", "title": "Conference Playback Ended", "example": { "record_type": "event", "event_type": "conference.playback.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "creator_call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "media_url": "https://www.example.com/audio.mp3", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.playback.ended", "enum": [ "conference.playback.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "creator_call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session that started the conference." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference the text was spoken in." }, "media_url": { "type": "string", "example": "http://example.com/audio.wav", "description": "The audio URL being played back, if audio_url has been used to start." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The name of the audio media file being played back, if media_name has been used to start." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferencePlaybackEndedEvent": { "type": "object", "title": "Conference Playback Ended Event", "properties": { "data": { "$ref": "#/components/schemas/ConferencePlaybackEnded" } } }, "ConferencePlaybackStarted": { "type": "object", "title": "Conference Playback Started", "example": { "record_type": "event", "event_type": "conference.playback.started", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "creator_call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "media_url": "https://www.example.com/audio.mp3", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.playback.started", "enum": [ "conference.playback.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "creator_call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session that started the conference." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference the text was spoken in." }, "media_url": { "type": "string", "example": "http://example.com/audio.wav", "description": "The audio URL being played back, if audio_url has been used to start." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The name of the audio media file being played back, if media_name has been used to start." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferencePlaybackStartedEvent": { "type": "object", "title": "Conference Playback Started Event", "properties": { "data": { "$ref": "#/components/schemas/ConferencePlaybackStarted" } } }, "ConferenceRecordingResource": { "type": "object", "title": "Conference recording resource", "example": { "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6", "call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ", "channels": 1, "conference_sid": "6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f", "date_created": "Fri, 27 Oct 2023 07:41:58 +0000", "date_updated": "Fri, 27 Oct 2023 07:41:58 +0000", "duration": 5, "error_code": null, "media_url": "https://www.example.com/download.mp3", "sid": "136285da-4b74-46f1-a016-fe2982fa77c3", "source": "StartConferenceRecordingAPI", "start_time": "Fri, 27 Oct 2023 07:41:58 +0000", "status": "completed", "subresource_uris": { "transcriptions": null }, "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/136285da-4b74-46f1-a016-fe2982fa77c3.json" }, "properties": { "account_sid": { "type": "string", "description": "The id of the account the resource belongs to.", "example": "61bf923e-5e4d-4595-a110-56190ea18a1b" }, "call_sid": { "type": "string", "description": "The identifier of the related participant's call.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ" }, "channels": { "type": "integer", "description": "The number of channels in the recording.", "example": 1 }, "conference_sid": { "type": "string", "description": "The identifier of the related conference.", "example": "6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f" }, "date_created": { "type": "string", "description": "The timestamp of when the resource was created.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "date_updated": { "type": "string", "description": "The timestamp of when the resource was last updated.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "duration": { "type": "integer", "description": "Duratin of the recording in seconds.", "example": 10 }, "error_code": { "type": "string", "description": "The recording error, if any.", "example": null }, "media_url": { "type": "string", "description": "The URL to use to download the recording.", "example": "https://www.example.com/download.mp3" }, "sid": { "type": "string", "description": "The unique identifier of the recording.", "example": "136285da-4b74-46f1-a016-fe2982fa77c3" }, "source": { "type": "string", "description": "How the recording was started.", "example": "StartConferenceRecordingAPI", "enum": [ "DialVerb", "Conference", "OutboundAPI", "Trunking", "RecordVerb", "StartCallRecordingAPI", "StartConferenceRecordingAPI" ] }, "start_time": { "type": "string", "description": "The timestamp of when the recording was started.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "status": { "type": "string", "description": "The status of the recording.", "enum": [ "processing", "absent", "completed", "deleted" ], "example": "completed" }, "subresource_uris": { "type": "object", "description": "A list of related resources identified by their relative URIs.", "example": { "transcriptions": null } }, "uri": { "type": "string", "description": "The relative URI for this recording.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/136285da-4b74-46f1-a016-fe2982fa77c3.json" } } }, "ConferenceRecordingResourceIndex": { "type": "object", "title": "Multiple conference recording resources", "example": { "participants": [], "end": 0, "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?page=0&pagesize=20", "next_page_uri": null, "page": 0, "page_size": 20, "start": 0, "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?page=0&pagesize=20" }, "properties": { "recordings": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceRecordingResource" } }, "end": { "type": "integer", "description": "The number of the last element on the page, zero-indexed.", "example": 19 }, "first_page_uri": { "type": "string", "description": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?page=0&pagesize=20", "example": "accepted" }, "next_page_uri": { "type": "string", "description": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ", "example": "accepted" }, "page": { "type": "integer", "description": "Current page number, zero-indexed.", "example": 0 }, "page_size": { "type": "integer", "description": "The number of items on the page", "example": 20 }, "start": { "type": "integer", "description": "The number of the first element on the page, zero-indexed.", "example": 0 }, "uri": { "type": "string", "description": "The URI of the current page.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Recordings.json?Page=0&PageSize=1" } } }, "ConferenceRecordingSaved": { "type": "object", "title": "Conference Recording Saved", "example": { "record_type": "event", "event_type": "conference.recording.saved", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "channels": "single", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "connection_id": "7267xxxxxxxxxxxxxx", "format": "mp3", "public_recording_urls": { "mp3": "http://example.com/recording.mp3", "wav": "http://example.com/recording.wav" }, "recording_ended_at": "2018-02-02T22:20:27.521992Z", "recording_id": "4577f9a2-cf0e-44f3-ac57-9f95fb03fa47", "recording_started_at": "2021-05-11T10:17:03.692107Z", "recording_urls": { "mp3": "http://example.com/recording.mp3", "wav": "http://example.com/recording.wav" } } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.recording.saved", "enum": [ "conference.recording.saved" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Participant's call ID used to issue commands via Call Control API." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "channels": { "type": "string", "example": "single", "enum": [ "single", "dual" ], "description": "Whether recording was recorded in `single` or `dual` channel." }, "conference_id": { "type": "string", "format": "uuid", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference that is being recorded." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "format": { "description": "The audio file format used when storing the call recording. Can be either `mp3` or `wav`.", "type": "string", "enum": [ "wav", "mp3" ], "example": "mp3" }, "public_recording_urls": { "type": "object", "description": "Recording URLs in requested format. The URL is valid for as long as the file exists. For security purposes, this feature is activated on a per request basis. Please contact customer support with your Account ID to request activation.", "properties": { "mp3": { "type": "string", "nullable": true, "example": "http://example.com/recording.mp3", "description": "Recording URL in requested `mp3` format." }, "wav": { "type": "string", "nullable": true, "example": "http://example.com/recording.wav", "description": "Recording URL in requested `wav` format." } } }, "recording_ended_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when recording ended." }, "recording_id": { "type": "string", "format": "uuid", "example": "4577f9a2-cf0e-44f3-ac57-9f95fb03fa47", "description": "ID of the conference recording." }, "recording_started_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:20:27.521992Z", "description": "ISO 8601 datetime of when recording started." }, "recording_urls": { "type": "object", "description": "Recording URLs in requested format. These URLs are valid for 10 minutes. After 10 minutes, you may retrieve recordings via API using Reports -> Call Recordings documentation, or via Mission Control under Reporting -> Recordings.", "properties": { "mp3": { "type": "string", "nullable": true, "example": "http://example.com/recording.mp3", "description": "Recording URL in requested `mp3` format." }, "wav": { "type": "string", "nullable": true, "example": "http://example.com/recording.wav", "description": "Recording URL in requested `wav` format." } } } } } } }, "ConferenceRecordingSavedEvent": { "type": "object", "title": "Conference Recording Saved Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceRecordingSaved" } } }, "ConferenceResource": { "type": "object", "title": "Conference resource", "example": { "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6", "api_version": "v2/texml", "call_sid_ending_conference": null, "date_created": "Fri, 27 Oct 2023 07:41:58 +0000", "date_updated": "Fri, 27 Oct 2023 07:41:58 +0000", "friendly_name": "weekly_review_call", "reason_conference_ended": null, "region": "dc2", "sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1", "status": "in-progress", "subresource_uris": { "participants": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants.json", "recordings": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Recordings.json" }, "uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1.json" }, "properties": { "account_sid": { "type": "string", "description": "The id of the account the resource belongs to.", "example": "61bf923e-5e4d-4595-a110-56190ea18a1b" }, "api_version": { "type": "string", "description": "The version of the API that was used to make the request.", "example": "v2/texml" }, "call_sid_ending_conference": { "type": "string", "description": "Caller ID, if present.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ" }, "date_created": { "type": "string", "description": "The timestamp of when the resource was created.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "date_updated": { "type": "string", "description": "The timestamp of when the resource was last updated.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "friendly_name": { "type": "string", "description": "A string that you assigned to describe this conference room.", "example": "weekly_review_call" }, "reason_conference_ended": { "type": "string", "description": "The reason why a conference ended. When a conference is in progress, will be null.", "enum": [ "participant-with-end-conference-on-exit-left", "last-participant-left", "conference-ended-via-api", "time-exceeded" ], "example": "time-exceeded" }, "region": { "type": "string", "description": "A string representing the region where the conference is hosted.", "example": "dc2" }, "sid": { "type": "string", "description": "The unique identifier of the conference.", "example": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1" }, "status": { "type": "string", "description": "The status of this conference.", "enum": [ "init", "in-progress", "completed" ], "example": "in-progress" }, "subresource_uris": { "type": "object", "description": "A list of related resources identified by their relative URIs.", "example": { "participants": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants.json", "recordings": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Recordings.json" } }, "uri": { "type": "string", "description": "The relative URI for this conference.", "example": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1.json" } } }, "ConferenceResourceIndex": { "type": "object", "title": "Multiple conference resources", "example": { "conferences": [], "end": 0, "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1", "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ", "page": 0, "page_size": 1, "start": 0, "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1" }, "properties": { "conferences": { "type": "array", "items": { "$ref": "#/components/schemas/ConferenceResource" } }, "end": { "type": "integer", "description": "The number of the last element on the page, zero-indexed.", "example": 19 }, "first_page_uri": { "type": "string", "description": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1", "example": "accepted" }, "next_page_uri": { "type": "string", "description": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ", "example": "accepted" }, "page": { "type": "integer", "description": "Current page number, zero-indexed.", "example": 0 }, "page_size": { "type": "integer", "description": "The number of items on the page", "example": 20 }, "start": { "type": "integer", "description": "The number of the first element on the page, zero-indexed.", "example": 0 }, "uri": { "type": "string", "description": "The URI of the current page.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences.json?Page=0&PageSize=1" } } }, "ConferenceSid": { "type": "string", "format": "uuid", "example": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1", "nullable": true }, "ConferenceSpeakEnded": { "type": "object", "title": "Conference Speak Ended", "example": { "record_type": "event", "event_type": "conference.speak.ended", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "creator_call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.speak.ended", "enum": [ "conference.speak.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "creator_call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session that started the conference." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference the text was spoken in." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferenceSpeakEndedEvent": { "type": "object", "title": "Conference Speak Ended Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceSpeakEnded" } } }, "ConferenceSpeakRequest": { "type": "object", "title": "Conference Speak Request", "required": [ "payload", "voice" ], "properties": { "call_control_ids": { "description": "Call Control IDs of participants who will hear the spoken text. When empty all participants will hear the spoken text.", "type": "array", "items": { "type": "string" } }, "payload": { "description": "The text or SSML to be converted into speech. There is a 3,000 character limit.", "type": "string", "example": "Say this to participants" }, "payload_type": { "description": "The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).", "default": "text", "type": "string", "enum": [ "text", "ssml" ], "example": "ssml" }, "voice": { "description": "The gender of the voice used to speak back the text or the specific Amazon Polly voice to be used in the form of `Polly.`, e.g. `Polly.Brian`. All standard Amazon Polly voices are supported.", "type": "string", "enum": [ "male", "female" ], "example": "female" }, "language": { "description": "The language you want spoken. This parameter is ignored when a `Polly.*` voice is specified.", "type": "string", "enum": [ "arb", "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "is-IS", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR" ], "example": "en-US" }, "command_id": { "description": "Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "call_control_ids": [ "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" ], "payload": "Say this to participants", "payload_type": "text", "voice": "female", "language": "en-US", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "ConferenceSpeakStarted": { "type": "object", "title": "Conference Speak Started", "example": { "record_type": "event", "event_type": "conference.speak.started", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "creator_call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "conference_id": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "occured_at": "2018-02-02T22:25:27.521Z" } }, "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "conference.speak.started", "enum": [ "conference.speak.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "payload": { "type": "object", "properties": { "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "creator_call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session that started the conference." }, "conference_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID of the conference the text was spoken in." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521Z", "description": "ISO 8601 datetime of when the event occurred." } } } } }, "ConferenceSpeakStartedEvent": { "type": "object", "title": "Conference Speak Started Event", "properties": { "data": { "$ref": "#/components/schemas/ConferenceSpeakStarted" } } }, "ConferenceStopRequest": { "type": "object", "title": "Conference Stop Request", "properties": { "call_control_ids": { "description": "List of call control ids identifying participants the audio file should stop be played to. If not given, the audio will be stoped to the entire conference.", "type": "array", "items": { "type": "string" } } } }, "ConferenceUnholdRequest": { "required": [ "call_control_ids" ], "type": "object", "title": "Conference Unhold Request", "properties": { "call_control_ids": { "description": "List of unique identifiers and tokens for controlling the call. Enter each call control ID to be unheld.", "type": "array", "items": { "type": "string" } } }, "example": { "call_control_ids": [ "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" ] } }, "ConferenceUnmuteRequest": { "type": "object", "title": "Conference Unmute Request", "properties": { "call_control_ids": { "description": "List of unique identifiers and tokens for controlling the call. Enter each call control ID to be unmuted. When empty all participants will be unmuted.", "type": "array", "items": { "type": "string" } } }, "example": { "call_control_ids": [ "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" ] } }, "Connection": { "type": "object", "title": "Connection", "properties": { "id": { "type": "string", "format": "int64", "description": "Identifies the specific resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "ip_connection" }, "active": { "type": "boolean", "description": "Defaults to true", "example": true }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "type": "string", "example": "string" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" }, "webhook_event_url": { "description": "The URL where webhooks related to this connection will be sent.", "type": "string", "format": "url", "default": null, "nullable": true, "example": "https://example.com" }, "webhook_event_failover_url": { "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails.", "type": "string", "format": "url", "default": "", "nullable": true, "example": "https://failover.example.com" }, "webhook_api_version": { "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "type": "string", "enum": [ "1", "2" ], "default": "1", "example": "1" }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } }, "example": { "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "ip_connection", "active": true, "anchorsite_override": "Latency", "connection_name": "string", "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "outbound_voice_profile_id": "1293384261075731499" } }, "ConnectionActive": { "title": "Connection Active", "type": "boolean", "description": "Specifies whether the connection can be used.", "default": true, "example": false }, "ConnectionAndroidPushCredentialId": { "title": "Android Push Credential Id", "type": "string", "description": "The uuid of the push credential for Android", "example": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "default": null, "nullable": true }, "ConnectionId": { "description": "The ID of the connection used to send the fax.", "type": "string", "example": "234423" }, "ConnectionIosPushCredentialId": { "title": "Ios Push Credential Id", "type": "string", "description": "The uuid of the push credential for Ios", "example": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "default": null, "nullable": true }, "ConnectionName": { "title": "Connection Name", "type": "string", "description": "A user-assigned name to help manage the connection.", "example": "office-connection" }, "ConnectionRtcpSettings": { "type": "object", "title": "Connection RTCP Settings", "properties": { "port": { "enum": [ "rtcp-mux", "rtp+1" ], "default": "rtp+1", "description": "RTCP port by default is rtp+1, it can also be set to rtcp-mux" }, "capture_enabled": { "type": "boolean", "default": false, "description": "BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal.", "example": true }, "report_frequency_secs": { "type": "integer", "default": 5, "description": "RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds.", "example": 10 } }, "example": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_secs": 10 } }, "ConsumedData": { "type": "object", "title": "ConsumedData", "description": "Represents the amount of data consumed.", "properties": { "unit": { "type": "string", "example": "MB", "default": "MB" }, "amount": { "type": "string", "format": "decimal", "example": "2048.1" } } }, "Contents": { "description": "The file you want to upload. The maximum allowed size is 20 MB. contents and media_name/media_url can't be submitted together.", "type": "string", "format": "binary" }, "CostInformation": { "type": "object", "properties": { "upfront_cost": { "type": "string", "example": "3.21" }, "monthly_cost": { "type": "string", "example": "6.54" }, "currency": { "type": "string", "description": "The ISO 4217 code for the currency.", "example": "USD" } }, "example": { "upfront_cost": "3.21", "monthly_cost": "6.54", "currency": "USD" } }, "CreateAndroidPushCredentialRequest": { "type": "object", "title": "Create Android Push Credential Request", "required": [ "type", "server_key", "alias" ], "properties": { "type": { "description": "Type of mobile push credential. Should be android here", "type": "string", "enum": [ "android" ] }, "server_key": { "description": "Server key as received from Google firebase", "type": "string", "example": "BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja..." }, "alias": { "description": "Alias to uniquely identify the credential", "type": "string", "example": "LucyAndroidCredential" } } }, "CreateBrand": { "title": "CreateBrand", "required": [ "entityType", "displayName", "country", "email", "vertical" ], "type": "object", "properties": { "entityType": { "allOf": [ { "$ref": "#/components/schemas/EntityType" } ], "description": "Entity type behind the brand. This is the form of business establishment." }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display name, marketing name, or DBA name of the brand.", "example": "ABC Mobile" }, "companyName": { "title": "Companyname", "maxLength": 100, "type": "string", "description": "(Required for Non-profit/private/public) Legal company name.", "example": "ABC Inc." }, "firstName": { "title": "Firstname", "maxLength": 100, "type": "string", "description": "First name of business contact.", "example": "John" }, "lastName": { "title": "Lastname", "maxLength": 100, "type": "string", "description": "Last name of business contact.", "example": "Smith" }, "ein": { "title": "Ein", "maxLength": 20, "type": "string", "description": "(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.", "example": "111111111" }, "phone": { "title": "Phone", "maxLength": 20, "type": "string", "description": "Valid phone number in e.164 international format.", "example": "+12024567890" }, "street": { "title": "Street", "maxLength": 100, "type": "string", "description": "Street number and name.", "example": "123" }, "city": { "title": "City", "maxLength": 100, "type": "string", "description": "City name", "example": "New York" }, "state": { "title": "State", "maxLength": 20, "type": "string", "description": "State. Must be 2 letters code for United States.", "example": "NY" }, "postalCode": { "title": "Postalcode", "maxLength": 10, "type": "string", "description": "Postal codes. Use 5 digit zipcode for United States", "example": "10001" }, "country": { "title": "Country", "maxLength": 2, "type": "string", "description": "ISO2 2 characters country code. Example: US - United States", "example": "US" }, "email": { "title": "Email", "maxLength": 100, "type": "string", "description": "Valid email address of brand support contact." }, "stockSymbol": { "title": "Stocksymbol", "maxLength": 10, "type": "string", "description": "(Required for public company) stock symbol.", "example": "ABC" }, "stockExchange": { "allOf": [ { "$ref": "#/components/schemas/StockExchange" } ], "description": "(Required for public company) stock exchange.", "example": "NASDAQ" }, "ipAddress": { "title": "Ipaddress", "maxLength": 50, "type": "string", "description": "IP address of the browser requesting to create brand identity." }, "website": { "title": "Website", "maxLength": 100, "type": "string", "description": "Brand website URL.", "example": "http://www.abcmobile.com" }, "vertical": { "allOf": [ { "$ref": "#/components/schemas/Vertical" } ], "description": "Vertical or industry segment of the brand." }, "isReseller": { "title": "Isreseller", "type": "boolean", "default": false }, "mock": { "title": "Mock", "type": "boolean", "description": "Mock brand for testing purposes", "default": false }, "mobilePhone": { "title": "Mobilephone", "maxLength": 20, "type": "string", "description": "Valid mobile phone number in e.164 international format.", "example": "+12024567890" } } }, "CreateBucketRequest": { "type": "object", "xml": { "wrapped": true, "name": "CreateBucketConfiguration" }, "properties": { "LocationConstraint": { "type": "string" } } }, "CreateCallControlApplicationRequest": { "type": "object", "title": "Create Call Control Application Request", "required": [ "application_name", "webhook_event_url" ], "properties": { "application_name": { "type": "string", "description": "A user-assigned name to help manage the application.", "example": "call-router" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "active": { "type": "boolean", "description": "Specifies whether the connection can be used.", "default": true }, "anchorsite_override": { "type": "string", "description": "Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.\n", "enum": [ "\"Latency\"", "\"Chicago, IL\"", "\"Ashburn, VA\"", "\"San Jose, CA\"" ], "example": "\"Amsterdam, Netherlands\"", "default": "\"Latency\"" }, "dtmf_type": { "type": "string", "description": "Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.", "enum": [ "RFC 2833", "Inband", "SIP INFO" ], "example": "Inband", "default": "RFC 2833" }, "first_command_timeout": { "type": "boolean", "description": "Specifies whether calls to phone numbers associated with this connection should hangup after timing out.", "example": true, "default": false }, "first_command_timeout_secs": { "type": "integer", "description": "Specifies how many seconds to wait before timing out a dial command.", "example": 10, "default": 30 }, "inbound": { "$ref": "#/components/schemas/CallControlApplicationInbound" }, "outbound": { "$ref": "#/components/schemas/CallControlApplicationOutbound" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true } }, "example": { "application_name": "call-router", "webhook_event_url": "https://example.com", "active": false, "anchorsite_override": "\"Latency\"", "dtmf_type": "Inband", "first_command_timeout": true, "first_command_timeout_secs": 10, "inbound": { "channel_limit": 10, "shaken_stir_enabled": true, "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" }, "webhook_api_version": "1", "webhook_event_failover_url": "https://failover.example.com", "webhook_timeout_secs": 25 } }, "CreateConferenceRequest": { "required": [ "call_control_id", "name" ], "type": "object", "title": "Create Conference Request", "properties": { "call_control_id": { "description": "Unique identifier and token for controlling the call", "example": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==", "type": "string" }, "name": { "description": "Name of the conference", "example": "Business", "type": "string" }, "beep_enabled": { "description": "Whether a beep sound should be played when participants join and/or leave the conference.", "enum": [ "always", "never", "on_enter", "on_exit" ], "default": "never", "example": "on_exit", "type": "string" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. The client_state will be updated for the creator call leg and will be used for all webhooks related to the created conference.", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "type": "string" }, "comfort_noise": { "description": "Toggle background comfort noise.", "example": false, "type": "boolean", "default": true }, "command_id": { "description": "Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.", "example": "891510ac-f3e4-11e8-af5b-de00688a4901", "type": "string" }, "duration_minutes": { "description": "Time length (minutes) after which the conference will end.", "example": 5, "type": "integer" }, "hold_audio_url": { "type": "string", "example": "http://example.com/message.wav", "description": "The URL of a file to be played to participants joining the conference. The URL can point to either a WAV or MP3 file. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when \"start_conference_on_create\" is set to \"false\"." }, "hold_media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played to participants joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when \"start_conference_on_create\" is set to \"false\"." }, "max_participants": { "description": "The maximum number of active conference participants to allow. Must be between 2 and 800. Defaults to 250", "example": 3, "type": "integer" }, "start_conference_on_create": { "description": "Whether the conference should be started on creation. If the conference isn't started all participants that join are automatically put on hold. Defaults to \"true\".", "example": false, "type": "boolean" } }, "example": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "name": "Business", "beep_enabled": "always", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "duration_minutes": 5, "hold_audio_url": "http://www.example.com/audio.wav", "start_conference_on_create": false, "max_participants": 250 } }, "CreateCredentialConnectionRequest": { "type": "object", "title": "Create Credential Connection Request", "required": [ "user_name", "password", "connection_name" ], "properties": { "active": { "type": "boolean", "description": "Defaults to true" }, "user_name": { "type": "string", "description": "The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).", "example": "myusername123" }, "password": { "type": "string", "description": "The password to be used as part of the credentials. Must be 8 to 128 characters long.", "example": "my123secure456password789" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "$ref": "#/components/schemas/ConnectionName" }, "sip_uri_calling_preference": { "type": "string", "description": "This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).", "enum": [ "disabled", "unrestricted", "internal" ] }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": false, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout." }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios." }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings." }, "ios_push_credential_id": { "$ref": "#/components/schemas/ConnectionIosPushCredentialId" }, "android_push_credential_id": { "$ref": "#/components/schemas/ConnectionAndroidPushCredentialId" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1, v2 or texml. Note - texml can only be set when the outbound object parameter call_parking_enabled is included and set to true.", "enum": [ "1", "2", "texml" ], "example": "1", "default": "1" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "inbound": { "$ref": "#/components/schemas/CredentialInbound" }, "outbound": { "$ref": "#/components/schemas/CredentialOutbound" } }, "example": { "active": true, "password": "my123secure456password789", "user_name": "myusername123", "anchorsite_override": "Latency", "connection_name": "my name", "sip_uri_calling_preference": " disabled", "default_on_hold_comfort_noise_enabled": false, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": true, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_seconds": 10 }, "inbound": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": "G722", "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "timeout_1xx_secs": 10, "timeout_2xx_secs": 20, "shaken_stir_enabled": true }, "outbound": { "call_parking_enabled": true, "ani_override": "always", "channel_limit": 10, "instant_ringback_enabled": true, "generate_ringback_tone": true, "localization": "US", "t38_reinvite_source": "telnyx", "outbound_voice_profile_id": "1293384261075731499" } } }, "CreateDocServiceDocumentRequest": { "oneOf": [ { "$ref": "#/components/schemas/DocServiceDocumentUploadURL" }, { "$ref": "#/components/schemas/DocServiceDocumentUploadInline" } ] }, "CreateExternalConnectionRequest": { "type": "object", "title": "Create External Connection Request", "required": [ "external_sip_connection", "outbound/outbound_voice_profile_id" ], "properties": { "active": { "$ref": "#/components/schemas/ConnectionActive" }, "external_sip_connection": { "$ref": "#/components/schemas/ExternalSipConnectionZoomOnly" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } } }, "example": { "external_sip_connection": "zoom", "active": false, "outbound": { "outbound_voice_profile_id": "1911630617284445511" } } }, "CreateExternalConnectionUploadRequest": { "type": "object", "title": "Create Upload Request", "required": [ "external_sip_connection", "outbound/outbound_voice_profile_id" ], "properties": { "number_ids": { "type": "array", "items": { "type": "string", "description": "Phone number ID from the Telnyx API." } }, "usage": { "type": "string", "enum": [ "calling_user_assignment", "first_party_app_assignment" ], "description": "The use case of the upload request. NOTE: `calling_user_assignment` is not supported for toll free numbers." }, "additional_usages": { "type": "array", "items": { "type": "string", "enum": [ "calling_user_assignment", "first_party_app_assignment" ], "description": "Additional use cases of the upload request. If not provided, all supported usages will be used." } }, "location_id": { "type": "string", "format": "uuid", "description": "Identifies the location to assign all phone numbers to." }, "civic_address_id": { "type": "string", "format": "uuid", "description": "Identifies the civic address to assign all phone numbers to." } }, "example": { "number_ids": [ "3920457616934164700", "3920457616934164701", "3920457616934164702", "3920457616934164703" ], "usage": "first_party_app_assignment", "location_id": "67ea7693-9cd5-4a68-8c76-abb3aa5bf5d2" } }, "CreateFaxApplicationRequest": { "type": "object", "title": "Create Fax Application Request", "required": [ "application_name", "webhook_event_url" ], "properties": { "application_name": { "$ref": "#/components/schemas/ApplicationName" }, "active": { "$ref": "#/components/schemas/ConnectionActive" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "webhook_event_url": { "$ref": "#/components/schemas/WebhookEventUrl" }, "webhook_event_failover_url": { "$ref": "#/components/schemas/WebhookEventFailoverUrl" }, "webhook_timeout_secs": { "$ref": "#/components/schemas/WebhookTimeoutSecs" }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "inbound_fax_file_type": { "type": "string", "description": "The file type used for inbound faxes.", "enum": [ "pdf", "tiff" ], "default": "pdf", "example": "pdf" }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.", "default": null, "example": "example" }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ], "default": "from_anyone", "example": "only_my_connections" } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } } }, "example": { "application_name": "fax-router", "active": false, "anchorsite_override": "Amsterdam, Netherlands", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_timeout_secs": 25, "inbound": { "channel_limit": 10, "inbound_fax_file_type": "pdf", "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" } } }, "CreateFqdnConnectionRequest": { "title": "Create FQDN Connection Request", "required": [ "connection_name" ], "properties": { "active": { "type": "boolean", "description": "Defaults to true", "default": true }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "$ref": "#/components/schemas/ConnectionName" }, "transport_protocol": { "$ref": "#/components/schemas/FqdnConnectionTransportProtocol" }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": true, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout." }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios." }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "microsoft_teams_sbc": { "type": "boolean", "description": "When enabled, the connection will be created for Microsoft Teams Direct Routing. A *.mstsbc.telnyx.tech FQDN will be created for the connection automatically.", "default": false }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings." }, "ios_push_credential_id": { "$ref": "#/components/schemas/ConnectionIosPushCredentialId" }, "android_push_credential_id": { "$ref": "#/components/schemas/ConnectionAndroidPushCredentialId" }, "webhook_event_url": { "$ref": "#/components/schemas/WebhookEventUrl" }, "webhook_event_failover_url": { "$ref": "#/components/schemas/WebhookEventFailoverUrl" }, "webhook_api_version": { "$ref": "#/components/schemas/WebhookApiVersion" }, "webhook_timeout_secs": { "$ref": "#/components/schemas/WebhookTimeoutSecs" }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "inbound": { "$ref": "#/components/schemas/InboundFqdn" }, "outbound": { "$ref": "#/components/schemas/OutboundFqdn" } }, "example": { "active": true, "anchorsite_override": "Latency", "connection_name": "string", "transport_protocol": "UDP", "default_on_hold_comfort_noise_enabled": true, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": true, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_secs": 10 }, "inbound": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": [ "G722" ], "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "string", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 10, "shaken_stir_enabled": true }, "outbound": { "ani_override": "+1234567890", "ani_override_type": "always", "call_parking_enabled": true, "channel_limit": 10, "generate_ringback_tone": true, "instant_ringback_enabled": true, "ip_authentication_method": "token", "ip_authentication_token": "aBcD1234", "localization": "string", "outbound_voice_profile_id": "1293384261075731499", "t38_reinvite_source": "telnyx", "tech_prefix": "0123", "encrypted_media": "string", "timeout_1xx_secs": 10, "timeout_2xx_secs": 10 } } }, "CreateFqdnRequest": { "title": "Create Fqdn Request", "type": "object", "required": [ "fqdn", "dns_record_type", "connection_id" ], "properties": { "connection_id": { "type": "string", "description": "ID of the FQDN connection to which this IP should be attached." }, "fqdn": { "type": "string", "description": "FQDN represented by this resource.", "example": "example.com" }, "port": { "type": "integer", "description": "Port to use when connecting to this FQDN.", "default": 5060, "example": 5060, "nullable": true }, "dns_record_type": { "type": "string", "description": "The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.", "example": "a" } }, "example": { "connection_id": "1516447646313612565", "fqdn": "example.com", "port": 8080, "dns_record_type": "a" } }, "CreateGroupMMSMessageRequest": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "format": "address", "description": "Phone number, in +E.164 format, used to send the message." }, "to": { "description": "A list of destinations. No more than 8 destinations are allowed.", "type": "array", "items": { "$ref": "#/components/schemas/ToNumber" } }, "text": { "type": "string", "description": "Message body (i.e., content) as a non-empty string." }, "subject": { "type": "string", "description": "Subject of multimedia message" }, "media_urls": { "description": "A list of media URLs. The total media size must be less than 1 MB.", "type": "array", "items": { "type": "string", "format": "url" } }, "webhook_url": { "description": "The URL where webhooks related to this message will be sent.", "type": "string", "format": "url" }, "webhook_failover_url": { "description": "The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.", "type": "string", "format": "url" }, "use_profile_webhooks": { "type": "boolean", "description": "If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.", "default": true } }, "example": { "from": "+13125551234", "to": [ "+18655551234", "+14155551234" ], "text": "Hello, World!", "subject": "From Telnyx!", "media_urls": [ "http://example.com" ], "webhook_url": "http://example.com/webhooks", "webhook_failover_url": "https://backup.example.com/hooks", "use_profile_webhooks": true } }, "CreateInboundIpRequest": { "type": "object", "title": "Create Inbound Ip Request", "properties": { "ani_number_format": { "type": "string", "enum": [ "+E.164", "E.164", "+E.164-national", "E.164-national" ], "default": "E.164-national", "description": "This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls." }, "dnis_number_format": { "type": "string", "enum": [ "+e164", "e164", "national", "sip_username" ], "default": "e164" }, "codecs": { "type": "array", "items": { "type": "string" }, "description": "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.", "default": [ "G722", "G711U", "G711A", "G729", "OPUS", "H.264" ] }, "default_routing_method": { "type": "string", "enum": [ "sequential", "round-robin" ], "description": "Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed." }, "channel_limit": { "type": "integer", "default": null, "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection." }, "generate_ringback_tone": { "type": "boolean", "default": false, "description": "Generate ringback tone through 183 session progress message with early media." }, "isup_headers_enabled": { "type": "boolean", "default": false, "description": "When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)" }, "prack_enabled": { "type": "boolean", "description": "Enable PRACK messages as defined in RFC3262.", "default": false }, "privacy_zone_enabled": { "type": "boolean", "description": "By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.", "default": false }, "sip_compact_headers_enabled": { "type": "boolean", "description": "Defaults to true.", "default": true }, "sip_region": { "type": "string", "default": "US", "description": "Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used.", "enum": [ "US", "Europe", "Australia" ] }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls." }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ] }, "timeout_1xx_secs": { "type": "integer", "description": "Time(sec) before aborting if connection is not made.", "minimum": 1, "maximum": 120, "default": 3 }, "timeout_2xx_secs": { "type": "integer", "description": "Time(sec) before aborting if call is unanswered (min: 1, max: 600).", "default": 90 }, "shaken_stir_enabled": { "type": "boolean", "description": "When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.", "default": false } }, "example": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": "G722", "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "test", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 20, "shaken_stir_enabled": true } }, "CreateIosPushCredentialRequest": { "type": "object", "title": "Create iOS push credential request", "required": [ "type", "certificate", "private_key", "alias" ], "properties": { "type": { "description": "Type of mobile push credential. Should be ios here", "type": "string", "enum": [ "ios" ] }, "certificate": { "description": "Certificate as received from APNs", "type": "string", "example": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----" }, "private_key": { "description": "Corresponding private key to the certificate as received from APNs", "type": "string", "example": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----" }, "alias": { "description": "Alias to uniquely identify the credential", "type": "string", "example": "LucyIosCredential" } } }, "CreateIpConnectionRequest": { "title": "Create IP Connection Request", "properties": { "active": { "type": "boolean", "description": "Defaults to true", "example": true }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "type": "string", "example": "string" }, "transport_protocol": { "type": "string", "description": "One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.", "default": "UDP", "enum": [ "UDP", "TCP", "TLS" ], "example": "UDP" }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": true, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.", "example": true }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.", "example": true }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.", "example": false }, "ios_push_credential_id": { "$ref": "#/components/schemas/ConnectionIosPushCredentialId" }, "android_push_credential_id": { "$ref": "#/components/schemas/ConnectionAndroidPushCredentialId" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "inbound": { "$ref": "#/components/schemas/CreateInboundIpRequest" }, "outbound": { "$ref": "#/components/schemas/OutboundIp" } }, "example": { "active": true, "anchorsite_override": "Latency", "connection_name": "string", "transport_protocol": "UDP", "default_on_hold_comfort_noise_enabled": true, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": false, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_secs": 10 }, "inbound:": { "ani_number_format": "+E.164", "dns_number_format": "+e164", "codecs": "G722", "default_primary_ip_id": "192.168.0.0", "default_tertiary_ip_id": "192.168.0.0", "default_secondary_ip_id": "192.168.0.0", "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "test", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 20, "shaken_stir_enabled": true }, "outbound": { "call_parking_enabled": true, "ani_override": "string", "ani_override_type": "always", "channel_limit": 10, "instant_ringback_enabled": true, "generate_ringback_tone": true, "localization": "string", "t38_reinvite_source": "telnyx", "tech_prefix": "string", "ip_authentication_method": "token", "ip_authentication_token": "string", "outbound_voice_profile_id": "1293384261075731499" } } }, "CreateIpRequest": { "title": "Create Ip Request", "type": "object", "required": [ "ip_address" ], "properties": { "connection_id": { "type": "string", "description": "ID of the IP Connection to which this IP should be attached." }, "ip_address": { "type": "string", "description": "IP adddress represented by this resource.", "example": "192.168.0.0" }, "port": { "type": "integer", "description": "Port to use when connecting to this IP.", "default": 5060, "example": 5060 } }, "example": { "connection_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "ip_address": "192.168.0.0", "port": 5060 } }, "CreateLongCodeMessageRequest": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "format": "address", "description": "Phone number, in +E.164 format, used to send the message." }, "to": { "$ref": "#/components/schemas/ToNumber" }, "text": { "type": "string", "description": "Message body (i.e., content) as a non-empty string.\n\n**Required for SMS**" }, "subject": { "type": "string", "description": "Subject of multimedia message" }, "media_urls": { "description": "A list of media URLs. The total media size must be less than 1 MB.\n\n**Required for MMS**", "type": "array", "items": { "type": "string", "format": "url" } }, "webhook_url": { "description": "The URL where webhooks related to this message will be sent.", "type": "string", "format": "url" }, "webhook_failover_url": { "description": "The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.", "type": "string", "format": "url" }, "use_profile_webhooks": { "type": "boolean", "description": "If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.", "default": true }, "type": { "description": "The protocol for sending the message, either SMS or MMS.", "type": "string", "enum": [ "SMS", "MMS" ] }, "auto_detect": { "description": "Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.", "type": "boolean", "default": false } }, "example": { "from": "+18445550001", "to": "+13125550002", "text": "Hello, World!", "subject": "From Telnyx!", "media_urls": [ "http://example.com" ], "webhook_url": "http://example.com/webhooks", "webhook_failover_url": "https://backup.example.com/hooks", "use_profile_webhooks": true, "type": "MMS" } }, "CreateManagedAccountRequest": { "title": "Create Managed Account Request", "required": [ "business_name" ], "properties": { "email": { "type": "string", "description": "The email address for the managed account. If not provided, the email address will be generated based on the email address of the manager account.", "example": "new_managed_account@customer.org" }, "password": { "type": "string", "description": "Password for the managed account. If a password is not supplied, the account will not be able to be signed into directly. (A password reset may still be performed later to enable sign-in via password.)", "example": "3jVjLq!tMuWKyWx4NN*CvhnB" }, "business_name": { "type": "string", "description": "The name of the business for which the new managed account is being created, that will be used as the managed accounts's organization's name.", "example": "Larry's Cat Food Inc" }, "managed_account_allow_custom_pricing": { "type": "boolean", "description": "Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed after creation, but there may be time lag between when the value is changed and pricing changes take effect.", "example": false }, "rollup_billing": { "type": "boolean", "description": "Boolean value that indicates if the billing information and charges to the managed account \"roll up\" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false.", "example": false } }, "example": { "email": "larry_cat_food@customer.org", "password": "3jVjLq!tMuWKyWx4NN*CvhnB", "business_name": "Larry's Cat Food Inc", "managed_account_allow_custom_pricing": false, "rollup_billing": false } }, "CreateMessageRequest": { "type": "object", "required": [ "to" ], "properties": { "from": { "type": "string", "format": "address", "description": "Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code).\n\n**Required if sending with a phone number, short code, or alphanumeric sender ID.**\n" }, "messaging_profile_id": { "type": "string", "description": "Unique identifier for a messaging profile.\n\n**Required if sending via number pool or with an alphanumeric sender ID.**\n" }, "to": { "$ref": "#/components/schemas/ToNumber" }, "text": { "type": "string", "description": "Message body (i.e., content) as a non-empty string.\n\n**Required for SMS**" }, "subject": { "type": "string", "description": "Subject of multimedia message" }, "media_urls": { "description": "A list of media URLs. The total media size must be less than 1 MB.\n\n**Required for MMS**", "type": "array", "items": { "type": "string", "format": "url" } }, "webhook_url": { "description": "The URL where webhooks related to this message will be sent.", "type": "string", "format": "url" }, "webhook_failover_url": { "description": "The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.", "type": "string", "format": "url" }, "use_profile_webhooks": { "type": "boolean", "description": "If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.", "default": true }, "type": { "description": "The protocol for sending the message, either SMS or MMS.", "type": "string", "enum": [ "SMS", "MMS" ] }, "auto_detect": { "description": "Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.", "type": "boolean", "default": false } }, "example": { "from": "+18445550001", "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000", "to": "+18445550001", "text": "Hello, World!", "subject": "From Telnyx!", "media_urls": [ "http://example.com" ], "webhook_url": "http://example.com/webhooks", "webhook_failover_url": "https://backup.example.com/hooks", "use_profile_webhooks": true, "type": "MMS" } }, "CreateMessagingHostedNumberOrderRequest": { "type": "object", "example": { "messaging_profile_id": "dc8f39ac-953d-4520-b93b-786ae87db0da", "phone_numbers": [ "+18665550001", "+18665550002" ] }, "properties": { "phone_numbers": { "type": "array", "items": { "type": "string", "format": "+E.164" }, "description": "Phone numbers to be used for hosted messaging." }, "messaging_profile_id": { "type": "string", "description": "Automatically associate the number with this messaging profile ID when the order is complete." } } }, "CreateMessagingProfileRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "description": "A user friendly name for the messaging profile.", "type": "string" }, "enabled": { "description": "Specifies whether the messaging profile is enabled or not.", "type": "boolean", "default": true }, "webhook_url": { "description": "The URL where webhooks related to this messaging profile will be sent.", "type": "string", "format": "url", "default": "", "nullable": true }, "webhook_failover_url": { "description": "The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.", "type": "string", "format": "url", "default": "", "nullable": true }, "webhook_api_version": { "description": "Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.", "type": "string", "enum": [ "1", "2", "2010-04-01" ], "default": "2" }, "number_pool_settings": { "$ref": "#/components/schemas/NumberPoolSettings" }, "url_shortener_settings": { "$ref": "#/components/schemas/UrlShortenerSettings" }, "alpha_sender": { "description": "The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.", "type": "string", "pattern": "^[A-Za-z0-9 ]{1,11}$", "nullable": true }, "whitelisted_destinations": { "description": "Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `[\"*\"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes.", "type": "array", "nullable": true, "items": { "description": "ISO 3166-1 alpha-2 country code.", "type": "string", "pattern": "^[A-Z]{2}$" } } }, "example": { "name": "My name", "enabled": true, "webhook_url": "https://www.example.com/hooks", "webhook_failover_url": "https://backup.example.com/hooks", "webhook_api_version": "2", "number_pool_settings": { "toll_free_weight": 10, "long_code_weight": 1, "skip_unhealthy": true, "sticky_sender": false, "geomatch": false }, "url_shortener_settings": { "domain": "example.ex", "prefix": "", "replace_blacklist_only": true, "send_webhooks": false } } }, "CreateMultiPartDocServiceDocumentRequest": { "type": "object", "properties": { "file": { "description": "The file you are uploading.", "type": "string", "format": "binary" }, "customer_reference": { "type": "string", "description": "Optional reference string for customer tracking.", "example": "MY REF 001" } } }, "CreateNumberBlockOrderRequest": { "required": [ "starting_number", "range" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "number_block_order", "readOnly": true }, "starting_number": { "type": "string", "description": "Starting phone number block", "format": "e164_phone_number", "example": "+19705555000", "writeOnly": true }, "range": { "type": "integer", "description": "The phone number range included in the block.", "example": 10, "writeOnly": true }, "phone_numbers_count": { "type": "integer", "description": "The count of phone numbers in the number order.", "example": 10, "readOnly": true }, "connection_id": { "type": "string", "example": "346789098765567", "description": "Identifies the connection associated with this phone number." }, "messaging_profile_id": { "type": "string", "example": "abc85f64-5717-4562-b3fc-2c9600", "description": "Identifies the messaging profile associated with the phone number." }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the order.", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number order was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for every phone number, false otherwise.", "example": true, "readOnly": true }, "errors": { "type": "string", "description": "Errors the reservation could happen upon", "example": "Number is already on hold", "readOnly": true } }, "example": { "starting_number": "+19705555000", "range": 10 } }, "CreateNumberOrderDocumentRequest": { "properties": { "id": { "type": "string", "format": "uuid", "example": "387d1e31-a218-4375-8151-103f2d5e2d2c", "readOnly": true }, "record_type": { "type": "string", "example": "number_order_document", "readOnly": true }, "file_id": { "type": "string", "description": "The id of the file to associate as a number order document.", "example": "1e3c5822-0362-4702-8e46-5a129f0d3976" }, "requirements_id": { "type": "string", "description": "Unique id for a requirement.", "example": "36aaf27d-986b-493c-bd1b-de16af2e4292" }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "requirement_type": { "type": "string", "enum": [ "address_proof", "identification", "reg_form" ], "readOnly": true }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order document was uploaded.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true } }, "example": { "id": "387d1e31-a218-4375-8151-103f2d5e2d2c", "record_type": "number_order_document", "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976", "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292", "customer_reference": "MY REF 001", "requirement_type": "address_proof", "created_at": "2018-01-01T00:00:00.000000Z" } }, "CreateNumberOrderRequest": { "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "number_order", "readOnly": true }, "phone_numbers": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" }, "writeOnly": true }, "phone_numbers_count": { "type": "integer", "description": "The count of phone numbers in the number order.", "example": 1, "readOnly": true }, "sub_number_order_ids": { "type": "array", "items": { "type": "string", "description": "Sub Number Order ID" } }, "connection_id": { "type": "string", "example": "346789098765567", "description": "Identifies the connection associated with this phone number." }, "messaging_profile_id": { "type": "string", "example": "abc85f64-5717-4562-b3fc-2c9600", "description": "Identifies the messaging profile associated with the phone number." }, "billing_group_id": { "type": "string", "example": "abc85f64-5717-4562-b3fc-2c9600", "description": "Identifies the billing group associated with the phone number." }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "example": "success", "description": "The status of the order.", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number order was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for every phone number, false otherwise.", "example": true, "readOnly": true } }, "example": { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "phone_numbers": [ { "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "record_type": "number_order_phone_number", "phone_number": "+19705555098", "bundle_id": "bc8e4d67-33a0-4cbb-af74-7b58f05bd494", "phone_number_type": "local", "regulatory_requirements": [ { "record_type": "phone_number_regulatory_requirement", "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576", "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21", "field_type": "address" } ], "country_code": "US", "requirements_met": true, "status": "success" } ], "record_type": "number_order", "phone_numbers_count": 1, "connection_id": "346789098765567", "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600", "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600", "status": "pending", "customer_reference": "MY REF 001", "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z", "requirements_met": true } }, "CreateNumberPoolMessageRequest": { "type": "object", "required": [ "to", "messaging_profile_id" ], "properties": { "messaging_profile_id": { "type": "string", "description": "Unique identifier for a messaging profile." }, "to": { "$ref": "#/components/schemas/ToNumber" }, "text": { "type": "string", "description": "Message body (i.e., content) as a non-empty string.\n\n**Required for SMS**" }, "subject": { "type": "string", "description": "Subject of multimedia message" }, "media_urls": { "description": "A list of media URLs. The total media size must be less than 1 MB.\n\n**Required for MMS**", "type": "array", "items": { "type": "string", "format": "url" } }, "webhook_url": { "description": "The URL where webhooks related to this message will be sent.", "type": "string", "format": "url" }, "webhook_failover_url": { "description": "The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.", "type": "string", "format": "url" }, "use_profile_webhooks": { "type": "boolean", "description": "If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.", "default": true }, "type": { "description": "The protocol for sending the message, either SMS or MMS.", "type": "string", "enum": [ "SMS", "MMS" ] }, "auto_detect": { "description": "Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.", "type": "boolean", "default": false } }, "example": { "from": "+18445550001", "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000", "to": [ "+13125550002" ], "text": "Hello, World!", "subject": "From Telnyx!", "media_urls": [ "http://example.com" ], "webhook_url": "http://example.com/webhooks", "webhook_failover_url": "https://backup.example.com/hooks", "use_profile_webhooks": true, "type": "MMS" } }, "CreateNumberReservationRequest": { "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "number_reservation", "readOnly": true }, "phone_numbers": { "type": "array", "items": { "$ref": "#/components/schemas/ReservedPhoneNumber" } }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the entire reservation.", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the numbers reservation was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number reservation was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true } }, "example": { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "record_type": "number_reservation", "phone_numbers": [ { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "record_type": "reserved_phone_number", "phone_number": "+19705555098", "status": "pending", "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z", "expired_at": "2018-01-01T00:00:00.000000Z" } ], "status": "pending", "customer_reference": "MY REF 001", "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z" } }, "CreateOrUpdateBusinessIdentityRequest": { "type": "object", "required": [ "name" ], "properties": { "name": { "$ref": "#/components/schemas/BusinessIdentity/properties/name" }, "business_email": { "$ref": "#/components/schemas/BusinessIdentity/properties/business_email" }, "business_name": { "$ref": "#/components/schemas/BusinessIdentity/properties/business_name" }, "business_phone_number": { "$ref": "#/components/schemas/BusinessIdentity/properties/business_phone_number" }, "business_description": { "$ref": "#/components/schemas/BusinessIdentity/properties/business_description" }, "submission_acknowledgement": { "$ref": "#/components/schemas/BusinessIdentity/properties/submission_acknowledgement" }, "website_url": { "$ref": "#/components/schemas/BusinessIdentity/properties/website_url" }, "address": { "$ref": "#/components/schemas/BusinessIdentity/properties/address" }, "contacts": { "$ref": "#/components/schemas/BusinessIdentity/properties/contacts" } }, "example": { "name": "Telnyx", "submission_acknowledgement": false, "business_name": "Telnyx LLC", "business_description": "Telnyx global presence profile", "business_email": "contact@telnyx.com", "business_phone_number": "+12345678900", "website_url": [ "https://www.telnyx.com", "https://portal.telnyx.com" ], "address": { "street": "311 W. Superior St.", "postal_code": "60654", "city": "Chicago", "state": "IL", "country": "USA", "extended_address": "Suite 504" }, "contacts": [ { "email": "johnsmith@telnyx.com", "first_name": "John", "job_title": "CEO", "last_name": "Smith", "phone_number": "+12345678900" } ] } }, "CreateOutboundVoiceProfileRequest": { "type": "object", "title": "Outbound Voice Profile", "required": [ "name" ], "example": { "name": "office", "traffic_type": "conversational", "service_plan": "global", "concurrent_call_limit": 10, "enabled": true, "tags": [ "office-profile" ], "usage_payment_method": "rate-deck", "whitelisted_destinations": [ "US", "BR", "AU" ], "max_destination_rate": 10, "daily_spend_limit": "100.00", "daily_spend_limit_enabled": true, "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "properties": { "name": { "type": "string", "description": "A user-supplied name to help with organization.", "example": "office", "minLength": 3 }, "traffic_type": { "$ref": "#/components/schemas/TrafficType" }, "service_plan": { "$ref": "#/components/schemas/ServicePlan" }, "concurrent_call_limit": { "type": "integer", "description": "Must be no more than your global concurrent call limit. Null means no limit.", "example": 10, "nullable": true }, "enabled": { "type": "boolean", "description": "Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.", "example": true, "default": true }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "office-profile" ] }, "usage_payment_method": { "$ref": "#/components/schemas/UsagePaymentMethod" }, "whitelisted_destinations": { "type": "array", "items": { "type": "string" }, "description": "The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.", "example": [ "US", "BR", "AU" ], "default": [ "US", "CA" ] }, "max_destination_rate": { "type": "number", "description": "Maximum rate (price per minute) for a Destination to be allowed when making outbound calls." }, "daily_spend_limit": { "type": "string", "description": "The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.", "example": "100.00" }, "daily_spend_limit_enabled": { "type": "boolean", "description": "Specifies whether to enforce the daily_spend_limit on this outbound voice profile.", "example": true, "default": false }, "call_recording": { "$ref": "#/components/schemas/OutboundCallRecording" }, "billing_group_id": { "type": "string", "format": "uuid", "description": "The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "default": null, "nullable": true } } }, "CreatePortingOrder": { "type": "object", "title": "CreatePortingOrder", "required": [ "phone_numbers" ], "properties": { "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "The list of +E.164 formatted phone numbers", "example": [ "+13035550000", "+13035550001", "+13035550002" ] }, "customer_reference": { "type": "string", "description": "A customer-specified reference number for customer bookkeeping purposes", "example": "Acct 123abc" } } }, "CreatePortingOrderComment": { "type": "object", "properties": { "body": { "type": "string", "example": "Please, let me know when the port completes" } } }, "CreateRoomClientTokenRequest": { "type": "object", "properties": { "token_ttl_secs": { "description": "The time to live in seconds of the Client Token, after that time the Client Token is invalid and can't be used to join a Room.", "type": "integer", "example": 600, "default": 600, "minimum": 10, "maximum": 3600 }, "refresh_token_ttl_secs": { "description": "The time to live in seconds of the Refresh Token, after that time the Refresh Token is invalid and can't be used to refresh Client Token.", "type": "integer", "example": 3600, "default": 3600, "minimum": 60, "maximum": 86400 } } }, "CreateRoomCompositionRequest": { "type": "object", "properties": { "format": { "description": "The desired format of the room composition.", "type": "string", "example": "mp4", "nullable": true, "default": "mp4" }, "resolution": { "description": "The desired resolution (width/height in pixels) of the resulting video of the room composition. Both width and height are required to be between 16 and 1280; and width * height should not exceed 1280 * 720", "type": "string", "example": "800x600", "nullable": true, "default": "1280x720" }, "session_id": { "description": "id of the room session associated with the room composition.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0", "nullable": true }, "video_layout": { "description": "Describes the video layout of the room composition in terms of regions.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/VideoRegion" } }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this room composition will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true } } }, "CreateRoomRequest": { "type": "object", "properties": { "unique_name": { "description": "The unique (within the Telnyx account scope) name of the room.", "type": "string", "example": "My room" }, "max_participants": { "description": "The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected.", "type": "integer", "example": 10, "default": 10, "minimum": 2, "maximum": 50 }, "enable_recording": { "description": "Enable or disable recording for that room.", "type": "boolean", "example": true, "default": false }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true } } }, "CreateShortCodeMessageRequest": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "format": "address", "description": "Phone number, in +E.164 format, used to send the message." }, "to": { "$ref": "#/components/schemas/ToNumber" }, "text": { "type": "string", "description": "Message body (i.e., content) as a non-empty string.\n\n**Required for SMS**" }, "subject": { "type": "string", "description": "Subject of multimedia message" }, "media_urls": { "description": "A list of media URLs. The total media size must be less than 1 MB.\n\n**Required for MMS**", "type": "array", "items": { "type": "string", "format": "url" } }, "webhook_url": { "description": "The URL where webhooks related to this message will be sent.", "type": "string", "format": "url" }, "webhook_failover_url": { "description": "The failover URL where webhooks related to this message will be sent if sending to the primary URL fails.", "type": "string", "format": "url" }, "use_profile_webhooks": { "type": "boolean", "description": "If the profile this number is associated with has webhooks, use them for delivery notifications. If webhooks are also specified on the message itself, they will be attempted first, then those on the profile.", "default": true }, "type": { "description": "The protocol for sending the message, either SMS or MMS.", "type": "string", "enum": [ "SMS", "MMS" ] }, "auto_detect": { "description": "Automatically detect if an SMS message is unusually long and exceeds a recommended limit of message parts.", "type": "boolean", "default": false } }, "example": { "from": "+18445550001", "to": "+18445550001", "text": "Hello, World!", "subject": "From Telnyx!", "media_urls": [ "http://example.com" ], "webhook_url": "http://example.com/webhooks", "webhook_failover_url": "https://backup.example.com/hooks", "use_profile_webhooks": true, "type": "MMS" } }, "CreateTeXMLSecretRequest": { "type": "object", "title": "Create TeXML Secret request", "required": [ "name", "value" ], "example": { "name": "My Secret Name", "value": "My Secret Value" }, "properties": { "name": { "type": "string", "description": "Name used as a reference for the secret, if the name already exists within the account its value will be replaced", "example": "My Secret Name" }, "value": { "type": "string", "descending": "Secret value which will be used when rendering the TeXML template", "example": "My Secret Value" } } }, "CreateTeXMLSecretResult": { "type": "object", "title": "Create TeXML Secret result", "example": { "name": "My Secret Name", "value": "*****" }, "properties": { "name": { "type": "string", "example": "My Secret Name" }, "value": { "type": "string", "enum": [ "*****" ], "example": "*****" } } }, "CreateTexmlApplicationRequest": { "type": "object", "title": "Create Texml Application Request", "required": [ "friendly_name", "voice_url" ], "properties": { "friendly_name": { "$ref": "#/components/schemas/ApplicationName" }, "active": { "$ref": "#/components/schemas/ConnectionActive" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "first_command_timeout": { "$ref": "#/components/schemas/FirstCommandTimeout" }, "first_command_timeout_secs": { "$ref": "#/components/schemas/FirstCommandTimeoutSecs" }, "voice_url": { "type": "string", "description": "URL to which Telnyx will deliver your XML Translator webhooks.", "format": "url", "example": "https://example.com" }, "voice_fallback_url": { "type": "string", "description": "URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.", "default": null, "format": "url", "example": "https://fallback.example.com" }, "voice_method": { "type": "string", "description": "HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.", "enum": [ "get", "post" ], "default": "post", "example": "get" }, "status_callback": { "type": "string", "description": "URL for Telnyx to send requests to containing information about call progress events.", "default": null, "format": "url", "example": "https://example.com" }, "status_callback_method": { "type": "string", "description": "HTTP request method Telnyx should use when requesting the status_callback URL.", "enum": [ "get", "post" ], "default": "post", "example": "get" }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "shaken_stir_enabled": { "type": "boolean", "description": "When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.", "default": false, "example": false }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.", "default": null, "example": "example" }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ], "default": "from_anyone", "example": "only_my_connections" } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } } }, "example": { "friendly_name": "call-router", "active": false, "anchorsite_override": "Amsterdam, Netherlands", "dtmf_type": "Inband", "first_command_timeout": true, "first_command_timeout_secs": 10, "voice_url": "https://example.com", "voice_fallback_url": "https://fallback.example.com", "voice_method": "get", "status_callback": "https://example.com", "status_callback_method": "get", "inbound": { "channel_limit": 10, "shaken_stir_enabled": true, "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" } } }, "CreateVerificationRequestCall": { "title": "CreateVerificationRequestCall", "description": "The request body when creating a verification.", "required": [ "phone_number", "verify_profile_id" ], "type": "object", "properties": { "phone_number": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "verify_profile_id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "type": "string", "format": "uuid", "description": "The identifier of the associated Verify profile." }, "timeout_secs": { "type": "integer", "example": 300, "description": "The number of seconds the verification code is valid for." }, "call_timeout_secs": { "type": "integer", "example": 30, "description": "Must be less than the profile's default_verification_timeout_secs or timeout_secs, whichever is lesser." } } }, "CreateVerificationRequestFlashcall": { "title": "CreateVerificationRequestFlashcall", "description": "The request body when creating a verification.", "required": [ "phone_number", "verify_profile_id" ], "type": "object", "properties": { "phone_number": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "verify_profile_id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "type": "string", "format": "uuid", "description": "The identifier of the associated Verify profile." }, "timeout_secs": { "type": "integer", "example": 300, "description": "The number of seconds the verification code is valid for." } } }, "CreateVerificationRequestPSD2": { "title": "CreateVerificationRequestPSD2", "description": "The request body when creating a verification.", "required": [ "phone_number", "verify_profile_id", "currency", "amount", "payee" ], "type": "object", "properties": { "phone_number": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "verify_profile_id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "type": "string", "format": "uuid", "description": "The identifier of the associated Verify profile." }, "currency": { "$ref": "#/components/schemas/Currencies" }, "amount": { "type": "string", "example": "99.99" }, "payee": { "type": "string", "example": "Acme Corp Inc. LTD" }, "timeout_secs": { "type": "integer", "example": 300, "description": "The number of seconds the verification code is valid for." } } }, "CreateVerificationRequestSMS": { "title": "CreateVerificationRequestSMS", "description": "The request body when creating a verification.", "required": [ "phone_number", "verify_profile_id" ], "type": "object", "properties": { "phone_number": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "verify_profile_id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "type": "string", "format": "uuid", "description": "The identifier of the associated Verify profile." }, "timeout_secs": { "type": "integer", "example": 300, "description": "The number of seconds the verification code is valid for." } } }, "CreateVerificationRequestWhatsapp": { "title": "CreateVerificationRequestWhatsapp", "description": "The request body when creating a verification.", "required": [ "phone_number", "verify_profile_id" ], "type": "object", "properties": { "phone_number": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "verify_profile_id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "type": "string", "format": "uuid", "description": "The identifier of the associated Verify profile." }, "timeout_secs": { "type": "integer", "example": 300, "description": "The number of seconds the verification code is valid for." } } }, "CreateVerificationResponse": { "title": "CreateVerifyVerificationResponse", "required": [ "data" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Verification" } } }, "CreateVerifiedCallsDisplayProfileRequest": { "type": "object", "required": [ "business_identity_id", "name" ], "properties": { "business_identity_id": { "type": "string", "format": "uuid", "description": "The ID of the business identity that owns the record", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba" }, "name": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile/properties/name" }, "display_name": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile/properties/display_name" }, "logo_url": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile/properties/logo_url" }, "call_reasons": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile/properties/call_reasons" }, "phone_numbers": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile/properties/phone_numbers" } }, "example": { "business_identity_id": "c32fadfd-7f2b-4399-b66f-84ce06e23073", "name": "My Verified Calls Display Profile", "display_name": "Acme Inc.", "logo_url": "https://acme.com/logo.png", "call_reasons": [ { "reason": "Order completed" } ], "phone_numbers": [ { "phone_number": "+12345678900" } ] } }, "CreateVerifiedNumberResponse": { "title": "CreateVerifiedNumberResponse", "type": "object", "properties": { "phone_number": { "example": "+15551234567", "type": "string" }, "verification_method": { "example": "sms", "type": "string" } } }, "CreateVerifyProfileCallRequest": { "title": "CreateVerifyProfileCallRequest", "required": [ "name" ], "type": "object", "properties": { "msg_template": { "example": "Hello, this is the Acme Inc verification code you requested: {code}.", "type": "string", "description": "Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code." }, "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "default_call_timeout_secs": { "type": "integer", "example": 30, "default": 45, "description": "Must be less than default_verification_timeout_secs" } } }, "CreateVerifyProfileFlashcallRequest": { "title": "CreateVerifyProfileFlashcallRequest", "required": [ "name" ], "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" } } }, "CreateVerifyProfilePSD2Request": { "title": "CreateVerifyProfilePSD2Request", "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" } } }, "CreateVerifyProfileSMSRequest": { "title": "CreateVerifyProfileSMSRequest", "type": "object", "properties": { "messaging_enabled": { "example": true, "description": "Enables SMS text messaging for the Verify profile.", "type": "boolean" }, "rcs_enabled": { "example": true, "description": "Enables RCS messaging for the Verify profile.", "type": "boolean" }, "messaging_template": { "example": "Hello, this is the Acme Inc verification code you requested: {code}.", "type": "string", "description": "Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code." }, "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "vsms_enabled": { "example": true, "description": "Enables VSMS for the Verify profile.", "type": "boolean" } } }, "CreateVerifyProfileWhatsappRequest": { "title": "CreateVerifyProfileWhatsappRequest", "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "app_name": { "example": "Example Secure App", "description": "The name that identifies the application requesting 2fa in the verification message.", "type": "string" } } }, "CreatedAt": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "CreationDate": { "type": "string", "format": "date-time" }, "CreationStatus": { "description": "An enumeration.", "enum": [ "pending", "created", "failed" ], "title": "CreationStatus", "type": "string" }, "CredentialActive": { "title": "Credential Active", "description": "If the credential associated with this service is active.", "type": "boolean", "default": false, "example": true }, "CredentialConnection": { "type": "object", "title": "Credential Connection", "properties": { "id": { "type": "string", "format": "int64", "description": "Identifies the type of resource.", "example": "1293384261075731499" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "credential_connection" }, "active": { "type": "boolean", "description": "Defaults to true" }, "user_name": { "type": "string", "description": "The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).", "example": "myusername123" }, "password": { "type": "string", "description": "The password to be used as part of the credentials. Must be 8 to 128 characters long.", "example": "my123secure456password789" }, "created_at": { "type": "string", "description": "ISO-8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO-8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "type": "string" }, "sip_uri_calling_preference": { "type": "string", "example": "disabled", "description": "This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).", "enum": [ "disabled", "unrestricted", "internal" ] }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": true, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout." }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios." }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings." }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "inbound": { "$ref": "#/components/schemas/CredentialInbound" }, "outbound": { "$ref": "#/components/schemas/CredentialOutbound" } }, "example": { "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "credential_connection", "active": true, "user_name": "myusername123", "password": "my123secure456password789", "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z", "anchorsite_override": "Latency", "connection_name": "string", "sip_uri_calling_preference": "disabled", "default_on_hold_comfort_noise_enabled": true, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": true, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtp+1", "capture_enabled": true, "report_frequency_seconds": 10 }, "inbound": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": [ "G722" ], "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "timeout_1xx_secs": 10, "timeout_2xx_secs": "15", "shaken_stir_enabled": true }, "outbound": { "call_parking_enabled": true, "ani_override": "string", "ani_override_type": "always", "channel_limit": 10, "instant_ringback_enabled": true, "generate_ringback_tone": true, "localization": "string", "t38_reinvite_source": "telnyx", "outbound_voice_profile_id": "1293384261075731499" } } }, "CredentialInbound": { "type": "object", "title": "Credential Inbound", "example": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": "G722", "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "timeout_1xx_secs": 10, "timeout_2xx_secs": 20, "shaken_stir_enabled": true }, "properties": { "ani_number_format": { "type": "string", "enum": [ "+E.164", "E.164", "+E.164-national", "E.164-national" ], "default": "E.164-national", "description": "This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls." }, "dnis_number_format": { "type": "string", "enum": [ "+e164", "e164", "national", "sip_username" ], "default": "e164" }, "codecs": { "type": "array", "items": { "type": "string" }, "description": "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.", "default": [ "G722", "G711U", "G711A", "G729", "OPUS", "H.264" ] }, "channel_limit": { "type": "integer", "default": null, "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection." }, "generate_ringback_tone": { "type": "boolean", "default": false, "description": "Generate ringback tone through 183 session progress message with early media." }, "isup_headers_enabled": { "type": "boolean", "default": false, "description": "When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)" }, "prack_enabled": { "type": "boolean", "description": "Enable PRACK messages as defined in RFC3262.", "default": false }, "privacy_zone_enabled": { "type": "boolean", "description": "By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.", "default": false }, "sip_compact_headers_enabled": { "type": "boolean", "description": "Defaults to true.", "default": true }, "timeout_1xx_secs": { "type": "integer", "description": "Time(sec) before aborting if connection is not made.", "minimum": 1, "maximum": 120, "default": 3 }, "timeout_2xx_secs": { "type": "string", "description": "Time(sec) before aborting if call is unanswered (min: 1, max: 600).", "minimum": 1, "maximum": 600, "default": "90" }, "shaken_stir_enabled": { "type": "boolean", "description": "When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.", "default": false } } }, "CredentialOutbound": { "type": "object", "title": "Credential Outbound", "example": { "call_parking_enabled": true, "ani_override": "always", "channel_limit": 10, "instant_ringback_enabled": true, "generate_ringback_tone": true, "localization": "US", "t38_reinvite_source": "telnyx", "outbound_voice_profile_id": "1293384261075731499" }, "properties": { "call_parking_enabled": { "type": "boolean", "default": false, "description": "Forces all SIP calls originated on this connection to be \"parked\" instead of \"bridged\" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next." }, "ani_override": { "type": "string", "description": "Set a phone number as the ani_override value to override caller id number on outbound calls.", "default": "" }, "ani_override_type": { "type": "string", "enum": [ "always", "normal", "emergency" ], "description": "Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.", "default": "always" }, "channel_limit": { "type": "integer", "default": null, "description": "When set, this will limit the total number of outbound calls to phone numbers associated with this connection." }, "instant_ringback_enabled": { "type": "boolean", "default": true, "description": "When set, ringback will not wait for indication before sending ringback tone to calling party." }, "generate_ringback_tone": { "type": "boolean", "default": false, "description": "Generate ringback tone through 183 session progress message with early media." }, "localization": { "type": "string", "default": "US", "description": "A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.", "example": "US" }, "t38_reinvite_source": { "type": "string", "enum": [ "telnyx", "customer", "disabled", "passthru", "caller-passthru", "callee-passthru" ], "description": "This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.

By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite.", "default": "telnyx" }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } }, "Credentials": { "description": "Opaque credential token used to authenticate and authorize with storage provider.", "type": "string", "format": "password", "example": "OPAQUE_CREDENTIALS_TOKEN" }, "CredentialsResponse": { "type": "object", "title": "CredentialsResponse", "required": [ "data", "connection_id", "record_type" ], "properties": { "data": { "$ref": "#/components/schemas/CustomStorageConfiguration" }, "connection_id": { "$ref": "#/components/parameters/ConnectionId" }, "record_type": { "$ref": "#/components/schemas/RecordType" } } }, "CsvDownload": { "type": "object", "properties": { "id": { "type": "string", "example": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "description": "Identifies the resource.", "readOnly": true }, "record_type": { "type": "string", "example": "csv_download", "description": "Identifies the type of the resource.", "readOnly": true }, "url": { "type": "string", "example": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "description": "The URL at which the CSV file can be retrieved." }, "status": { "type": "string", "enum": [ "pending", "complete", "failed", "expired" ], "default": "pending", "example": "pending", "description": "Indicates the completion level of the CSV report. Only complete CSV download requests will be able to be retrieved." } }, "example": { "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "record_type": "csv_download", "url": "https://www.telnyx.com/sample/42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "status": "pending" } }, "Currencies": { "title": "Currencies", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD" ], "type": "string", "example": "USD", "description": "The supported currencies." }, "Cursor": { "type": "object", "properties": { "after": { "type": "string", "description": "Opaque identifier of next page.", "example": "v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI=" }, "before": { "type": "string", "description": "Opaque identifier of previous page.", "example": "v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI=" } } }, "CursorPaginationMeta": { "type": "object", "title": "Cursor Pagination Meta", "properties": { "cursors": { "$ref": "#/components/schemas/Cursor" }, "total_items": { "type": "integer", "example": 50 }, "next": { "type": "string", "description": "Path to next page.", "example": "/v2/connections/1234567890/active_calls?page[after]=v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI=" }, "previous": { "type": "string", "description": "Path to previous page.", "example": "/v2/connections/1234567890/active_calls?page[before]=v1:g3QAAAADZAAKdGVsbnl4X2lkc2wAAAABbQAAACRlYmRiYzdkNi1kZWRmLTExZWQtYTM3MS0wMjQyMGFlZjAwYjRqZAAJdGltZXN0YW1wbggA8Le4pGhpVxdkAAR0eXBlZAAFYWZ0ZXI=" } } }, "CustomSipHeader": { "type": "object", "title": "Custom SIP Header", "required": [ "name", "value" ], "properties": { "name": { "description": "The name of the header to add.", "type": "string", "example": "head_1" }, "value": { "description": "The value of the header.", "type": "string", "example": "val_1" } }, "example": { "name": "head_1", "value": "val_1" } }, "CustomStorageConfiguration": { "type": "object", "title": "Custom Storage Configuration", "required": [ "backend", "configuration" ], "properties": { "backend": { "type": "string", "enum": [ "gcs", "s3", "azure" ], "example": "gcs" }, "configuration": { "oneOf": [ { "$ref": "#/components/schemas/GCSConfigurationData" }, { "$ref": "#/components/schemas/S3ConfigurationData" }, { "$ref": "#/components/schemas/AzureConfigurationData" } ] } } }, "CustomerServiceRecord": { "type": "object", "properties": { "id": { "description": "Uniquely identifies this customer service record", "type": "string", "format": "uuid", "example": "f1486bae-f067-460c-ad43-73a92848f902", "readOnly": true }, "phone_number": { "description": "The phone number of the customer service record.", "type": "string", "example": "+12065551212" }, "status": { "description": "The status of the customer service record", "type": "string", "enum": [ "pending", "completed", "failed" ], "example": "completed" }, "error_message": { "description": "The error message in case status is `failed`. This field would be null in case of `pending` or `completed` status.", "type": "string", "example": "CSR information not available." }, "result": { "description": "The result of the CSR request. This field would be null in case of `pending` or `failed` status.", "type": "object", "properties": { "carrier_name": { "description": "The name of the carrier that the customer service record is for.", "type": "string", "example": "ABC CARRIER, INC." }, "associated_phone_numbers": { "description": "The associated phone numbers of the customer service record.", "type": "array", "items": { "type": "string", "example": "+12065551212" } }, "admin": { "description": "The admin of the customer service record.", "type": "object", "properties": { "name": { "description": "The name of the customer service record.", "type": "string", "example": "John Doe" }, "billing_phone_number": { "description": "The billing phone number of the customer service record.", "type": "string", "example": "+12065551212" }, "account_number": { "description": "The account number of the customer service record.", "type": "string", "example": "1234567890" }, "authorized_person_name": { "description": "The authorized person name of the customer service record.", "type": "string", "example": "John Doe" } } }, "address": { "description": "The address of the customer service record", "type": "object", "properties": { "administrative_area": { "description": "The state of the address", "type": "string", "example": "NY" }, "locality": { "description": "The city of the address", "type": "string", "example": "New York" }, "postal_code": { "description": "The zip code of the address", "type": "string", "example": "10001" }, "street_address": { "description": "The street address", "type": "string", "example": "123 Main St" }, "full_address": { "description": "The full address", "type": "string", "example": "123 Main St; New York; NY; 10001" } } } } }, "record_type": { "type": "string", "example": "customer_service_record", "description": "Identifies the type of the resource.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527Z", "readOnly": true } } }, "CustomerServiceRecordAdditionalData": { "type": "object", "properties": { "name": { "description": "The name of the administrator of CSR.", "type": "string", "example": "Entity Inc." }, "authorized_person_name": { "description": "The name of the authorized person.", "type": "string", "example": "John Doe" }, "pin": { "description": "The PIN of the customer service record.", "type": "string", "example": "1234" }, "account_number": { "description": "The account number of the customer service record.", "type": "string", "example": "123456789" }, "customer_code": { "description": "The customer code of the customer service record.", "type": "string", "example": "123456789" }, "address_line_1": { "description": "The first line of the address of the customer service record.", "type": "string", "example": "123 Main St" }, "city": { "description": "The city of the customer service record.", "type": "string", "example": "New York" }, "state": { "description": "The state of the customer service record.", "type": "string", "example": "NY", "maxLength": 2, "pattern": "^[A-Z]{2}$" }, "zip_code": { "description": "The zip code of the customer service record.", "type": "string", "example": "10001", "maxLength": 5, "pattern": "^\\d{5}$" }, "billing_phone_number": { "description": "The billing phone number of the customer service record.", "type": "string", "example": "+12065551212", "pattern": "^\\+1\\d{10}$" } } }, "CustomerServiceRecordPhoneNumberCoverage": { "type": "object", "properties": { "phone_number": { "type": "string", "description": "The phone number that is being verified.", "example": "+12223334444" }, "has_csr_coverage": { "type": "boolean", "description": "Indicates whether the phone number is covered or not.", "example": true }, "reason": { "type": "string", "description": "The reason why the phone number is not covered. Only returned if `has_csr_coverage` is false.", "example": "The phone number '+19999999999' is invalid." }, "additional_data_required": { "type": "array", "description": "Additional data required to perform CSR for the phone number. Only returned if `has_csr_coverage` is true.", "items": { "type": "string", "enum": [ "name", "authorized_person_name", "account_number", "customer_code", "pin", "address_line_1", "city", "state", "zip_code", "billing_phone_number" ], "example": "name" } }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "customer_service_record_phone_number_coverage" } } }, "CustomerServiceRecordStatusChangedEvent": { "type": "object", "properties": { "id": { "description": "Uniquely identifies the callback event.", "type": "string", "format": "uuid", "example": "d3c462b5-8afa-4d48-9af1-4f9b1f00e7bd" }, "event_type": { "description": "The type of the callback event.", "type": "string", "enum": [ "customer_service_record.status_changed" ], "example": "customer_service_record.status_changed" }, "payload": { "type": "object", "properties": { "id": { "description": "Uniquely identifies the customer service record.", "type": "string", "format": "uuid", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "phone_number": { "description": "The phone number of the customer service record.", "type": "string", "example": "+12065551212" }, "status": { "description": "The status of the customer service record", "type": "string", "enum": [ "pending", "completed", "failed" ], "example": "completed" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating the last time where the resource was updated.", "example": "2021-03-19T10:07:15.527Z" } } }, "occurred_at": { "description": "ISO 8601 formatted date indicating when the callback event occurred.", "type": "string", "format": "date-time", "example": "2021-03-19T10:07:15.527Z" }, "record_type": { "description": "Identifies the type of the resource.", "type": "string", "enum": [ "event" ], "example": "event" } } }, "DateTimeRFC2822": { "type": "string", "format": "datetime-rfc2822", "example": "Fri, 11 Aug 2023 19:12:11 +0000" }, "Dca": { "title": "Dca", "required": [ "id", "displayName" ], "type": "object", "properties": { "id": { "title": "Id", "maxLength": 7, "type": "string", "description": "Unique identifier of the direct connect aggregator" }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display name of the direct connect aggregator." } } }, "DefaultGateway": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "type": "object", "title": "DefaultGateway", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "default_gateway" }, "network_id": { "type": "string", "format": "uuid", "description": "Network ID.", "example": "e66c496d-4a85-423b-8b2a-8e63fac20320" }, "wireguard_peer_id": { "type": "string", "format": "uuid", "description": "Wireguard peer ID.", "example": "e66c496d-4a85-423b-8b2a-8e63fac20320" }, "status": { "$ref": "#/components/schemas/InterfaceStatus" } } } ] }, "DeleteObjectsRequest": { "type": "array", "xml": { "wrapped": true, "name": "Delete" }, "items": { "type": "object", "xml": { "name": "Object" }, "properties": { "Key": { "type": "string" } } } }, "DeleteObjectsResponse": { "type": "object" }, "DetailRecord": { "type": "object", "description": "An object following one of the schemas published in https://developers.telnyx.com/docs/api/v2/detail-records", "oneOf": [ { "$ref": "#/components/schemas/MessageDetailRecord", "title": "Message" }, { "$ref": "#/components/schemas/ConferenceDetailRecord", "title": "Conference" }, { "$ref": "#/components/schemas/ConferenceParticipantDetailRecord", "title": "Conference Participant" }, { "$ref": "#/components/schemas/WhatsAppDetailRecord", "title": "WhatsApp Message" }, { "$ref": "#/components/schemas/WhatsAppConversationDetailRecord", "title": "WhatsApp Conversation" }, { "$ref": "#/components/schemas/AmdDetailRecord", "title": "AMD" }, { "$ref": "#/components/schemas/VerifyDetailRecord", "title": "Verify 2FA" }, { "$ref": "#/components/schemas/SimCardUsageDetailRecord", "title": "Sim Card Usage" }, { "$ref": "#/components/schemas/MediaStorageDetailRecord", "title": "Media Storage" } ], "required": [ "record_type" ], "discriminator": { "propertyName": "record_type" } }, "DetailRecordsSearchResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DetailRecord" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "DetailedTaskStatus": { "properties": { "taskId": { "description": "The ID of the task associated with bulk Sole Proprietor brand and campaign creation.", "example": "4b60017a-2f50-4c90-c9e6-5f67304cbde2", "title": "Taskid", "type": "string" }, "referenceId": { "description": "A user generated unique identifier that keeps track of sole proprietor brand/campaign combinations submitted during bulk creation.", "example": "4q90017a-2f50-4c90-c9e6-5f67304cbde9", "title": "Referenceid", "type": "string" }, "brand": { "items": { "$ref": "#/components/schemas/BrandStatus" }, "description": "The status of the individual brand submitted via bulk creation.", "title": "Brand", "type": "array" }, "campaign": { "items": { "$ref": "#/components/schemas/CampaignStatus" }, "description": "The status of the individual campaign submitted via bulk creation.", "title": "Campaign", "type": "array" }, "phoneNumbers": { "items": { "$ref": "#/components/schemas/PhoneNumberStatus" }, "title": "Phonenumbers", "type": "array" } }, "required": [ "taskId", "referenceId", "brand", "campaign", "phoneNumbers" ], "title": "DetailedTaskStatus", "type": "object" }, "DialConferenceParticipantRequest": { "type": "object", "title": "Create Conference Participant Request", "properties": { "Beep": { "description": "Whether to play a notification beep to the conference when the participant enters and exits.", "example": "onExit", "type": "string", "enum": [ "true", "false", "onEnter", "onExit" ] }, "StatusCallback": { "description": "URL destination for Telnyx to send status callback events to for the call.", "example": "https://www.example.com/callback", "type": "string" }, "StatusCallbackMethod": { "description": "HTTP request type used for `StatusCallback`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "StatusCallbackEvent": { "description": "The changes to the call's state that should generate a call to `StatusCallback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.", "example": "answered completed", "type": "string" }, "To": { "description": "The phone number of the called party. Phone numbers are formatted with a `+` and country code.", "example": "+16175551212", "type": "string" }, "From": { "description": "The phone number of the party that initiated the call. Phone numbers are formatted with a `+` and country code.", "example": "+16175551212", "type": "string" }, "Timeout": { "description": "The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5 and 120, inclusive. The default value is 30.", "example": 30, "type": "integer" }, "Muted": { "description": "Whether the participant should be muted.", "example": true, "type": "boolean" }, "StartConferenceOnEnter": { "description": "Whether to start the conference when the participant enters. Defaults to `true`.", "example": false, "type": "boolean" }, "EndConferenceOnExit": { "description": "Whether to end the conference when the participant leaves. Defaults to `false`.", "example": true, "type": "boolean" }, "WaitUrl": { "description": "The URL to call for an audio file to play while the participant is waiting for the conference to start.", "example": "https://www.example.com/wait_music.mp3", "type": "string" }, "MaxParticipants": { "description": "The maximum number of participants in the conference. Can be a positive integer from 2 to 800. The default value is 250.", "example": 30, "type": "integer" }, "Coaching": { "description": "Whether the participant is coaching another call. When `true`, `CallSidToCoach` has to be given.", "example": false, "type": "boolean" }, "CallSidToCoach": { "description": "The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ", "type": "string" }, "CallerId": { "description": "To be used as the caller id name (SIP From Display Name) presented to the destination (`To` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and `-_~!.+` special characters. If ommited, the display name will be the same as the number in the `From` field.", "example": "Info", "type": "string" }, "TimeLimit": { "description": "The maximum duration of the call in seconds.", "example": 30, "type": "integer" }, "MachineDetection": { "description": "Whether to detect if a human or an answering machine picked up the call. Use `Enable` if you would like to ne notified as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine.", "example": "Enable", "type": "string", "enum": [ "Enable", "DetectMessageEnd" ] }, "MachineDetectionTimeout": { "description": "How long answering machine detection should go on for before sending an `Unknown` result. Given in milliseconds.", "example": 1000, "type": "integer" }, "MachineDetectionSpeechThreshold": { "description": "Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used.", "example": 2000, "default": 3500, "type": "integer" }, "MachineDetectionSpeechEndThreshold": { "description": "Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used.", "example": 2000, "default": 800, "type": "integer" }, "MachineDetectionSilenceTimeout": { "description": "If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used.", "example": 2000, "default": 3500, "type": "integer" }, "AmdStatusCallback": { "description": "The URL the result of answering machine detection will be sent to.", "example": "https://www.example.com/amd_result", "type": "string" }, "AmdStatusCallbackMethod": { "description": "HTTP request type used for `AmdStatusCallback`. Defaults to `POST`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "CancelPlaybackOnMachineDetection": { "description": "Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.", "default": true, "example": false, "type": "boolean" }, "CancelPlaybackOnDetectMessageEnd": { "description": "Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`.", "default": true, "example": false, "type": "boolean" }, "PreferredCodecs": { "description": "The list of comma-separated codecs to be offered on a call.", "example": "PCMA,PCMU", "type": "string" }, "Record": { "description": "Whether to record the entire participant's call leg. Defaults to `false`.", "example": false, "type": "boolean" }, "RecordingChannels": { "description": "The number of channels in the final recording. Defaults to `mono`.", "example": "dual", "type": "string", "enum": [ "mono", "dual" ] }, "RecordingStatusCallback": { "description": "The URL the recording callbacks will be sent to.", "example": "https://example.com/recording_status_callback", "type": "string" }, "RecordingStatusCallbackMethod": { "description": "HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "RecordingStatusCallbackEvent": { "description": "The changes to the recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.", "example": "in-progress completed absent", "type": "string" }, "RecordingTrack": { "description": "The audio track to record for the call. The default is `both`.", "example": "inbound", "type": "string", "enum": [ "inbound", "outbound", "both" ] }, "SipAuthPassword": { "description": "The password to use for SIP authentication.", "example": "1234", "type": "string" }, "SipAuthUsername": { "description": "The username to use for SIP authentication.", "example": "user", "type": "string" }, "Trim": { "description": "Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`.", "example": false, "type": "string", "enum": [ "trim-silence", "do-not-trim" ] }, "ConferenceRecord": { "description": "Whether to record the conference the participant is joining. Defualts to `do-not-record`. The boolean values `true` and `false` are synonymous with `record-from-start` and `do-not-record` respectively.", "example": "record-from-start", "type": "string", "enum": [ "true", "false", "record-from-start", "do-not-record" ] }, "ConferenceRecordingStatusCallback": { "description": "The URL the conference recording callbacks will be sent to.", "example": "https://example.com/conference_recording_status_callback", "type": "string" }, "ConferenceRecordingStatusCallbackMethod": { "description": "HTTP request type used for `ConferenceRecordingStatusCallback`. Defaults to `POST`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "ConferenceRecordingStatusCallbackEvent": { "description": "The changes to the conference recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`. `failed` and `absent` are synonymous.", "example": "in-progress completed failed absent", "type": "string" }, "ConferenceRecordingTimeout": { "description": "The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)", "example": 5, "type": "integer", "default": 0 }, "ConferenceTrim": { "description": "Whether to trim any leading and trailing silence from the conference recording. Defaults to `trim-silence`.", "example": false, "type": "string", "enum": [ "trim-silence", "do-not-trim" ] } }, "example": { "To": "+12065550100", "From": "+12065550200" } }, "DialogflowConfig": { "type": "object", "title": "Dialogflow Config", "properties": { "analyze_sentiment": { "description": "Enable sentiment analysis from Dialogflow.", "type": "boolean", "example": true, "default": false }, "partial_automated_agent_reply": { "description": "Enable partial automated agent reply from Dialogflow.", "type": "boolean", "example": true, "default": false } } }, "DialogflowConnection": { "type": "object", "title": "Dialogflow Connection Params", "required": [ "service_account" ], "properties": { "service_account": { "description": "The JSON map to connect your Dialoglow account.", "type": "object", "example": "{\"service_account\":{\"type\":\"service_account\",\"project_id\":\"your-project-id\",\"private_key_id\":\"your-private-key\",\"private_key\":\"-----BEGIN PRIVATE KEY-----n-----END PRIVATE\",\"client_email\":\"example@example.com\",\"client_id\":\"your-client-id\",\"auth_uri\":\"http://example.com\",\"token_uri\":\"http://example.com\",\"auth_provider_x509_cert_url\":\"http://example.com\",\"client_x509_cert_url\":\"http://example.com\"}}" }, "dialogflow_api": { "description": "Determin which Dialogflow will be used.", "type": "string", "enum": [ "cx", "es" ], "example": "cx", "default": "es" }, "conversation_profile_id": { "description": "The id of a configured conversation profile on your Dialogflow account. (If you use Dialogflow CX, this param is required)", "type": "string", "example": "a-VMHLWzTmKjiJw5S6O0-w" }, "location": { "description": "The region of your agent is. (If you use Dialogflow CX, this param is required)", "type": "string", "example": "global" }, "environment": { "description": "Which Dialogflow environment will be used.", "type": "string", "example": "development" } }, "example": { "service_Account": "{\"type\":\"service_account\",\"project_id\":\"your-project-id\",\"private_key_id\":\"your-private-key\",\"private_key\":\"-----BEGIN PRIVATE KEY-----n-----END PRIVATE\",\"client_email\":\"example@example.com\",\"client_id\":\"your-client-id\",\"auth_uri\":\"http://example.com\",\"token_uri\":\"http://example.com\",\"auth_provider_x509_cert_url\":\"http://example.com\",\"client_x509_cert_url\":\"http://example.com\"}", "dialogflow_api": "cx", "conversation_profile_id": "a-VMHLWzTmKjiJw5S6O0-w", "location": "global", "environment": "development" } }, "DialogflowConnectionResponse": { "type": "object", "title": "Dialogflow Connection Response", "required": [ "data" ], "properties": { "data": { "type": "object", "title": "Dialogflow Connection", "properties": { "record_type": { "type": "string", "example": "dialogflow_connections" }, "connection_id": { "type": "string", "example": "1234541231", "description": "Uniquely identifies a Telnyx application (Call Control)." }, "conversation_profile_id": { "type": "string", "description": "The id of a configured conversation profile on your Dialogflow account. (If you use Dialogflow CX, this param is required)", "example": "a-VMHLWzTmKjiJw5S6O0-w" }, "environment": { "type": "string", "description": "Which Dialogflow environment will be used.", "example": "development" }, "service_account": { "type": "string", "description": "The JSON map to connect your Dialoglow account.", "example": "****" } } } } }, "Direction": { "description": "The direction of the fax.", "type": "string", "example": "outbound", "enum": [ "inbound", "outbound" ] }, "DocReqsRequirement": { "type": "object", "properties": { "record_type": { "description": "Identifies the type of the resource.", "type": "string", "readOnly": true, "example": "requirement" }, "country_code": { "description": "The 2-character (ISO 3166-1 alpha-2) country code where this requirement applies", "type": "string", "readOnly": false, "example": "FR" }, "locality": { "description": "The locality where this requirement applies", "type": "string", "readOnly": false, "example": "Nice" }, "phone_number_type": { "description": "Indicates the phone_number_type this requirement applies to. Leave blank if this requirement applies to all number_types.", "type": "string", "enum": [ "local", "national", "toll_free" ], "example": "local", "readOnly": false }, "action": { "description": "Indicates whether this requirement applies to ordering, porting, or both", "type": "string", "enum": [ "both", "ordering", "porting" ], "example": "ordering", "readOnly": false }, "requirements_types": { "description": "Lists the requirement types necessary to fulfill this requirement", "type": "array", "items": { "$ref": "#/components/schemas/DocReqsRequirementType" }, "readOnly": true }, "id": { "description": "Identifies the associated document", "type": "string", "format": "uuid", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2021-04-09T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was last updated.", "readOnly": true, "example": "2021-04-12T20:20:20.020Z" } } }, "DocReqsRequirementList": { "type": "array", "items": { "$ref": "#/components/schemas/DocReqsRequirement" } }, "DocReqsRequirementType": { "type": "object", "properties": { "acceptance_criteria": { "description": "Specifies objective criteria for acceptance", "type": "object", "properties": { "time_limit": { "description": "Specifies time-based acceptance criteria", "example": "Current and not expired", "type": "string", "readOnly": false }, "locality_limit": { "description": "Specifies geography-based acceptance criteria", "example": "Issued by the same country that the phone number belongs to", "type": "string", "readOnly": false }, "acceptable_values": { "description": "Specifies the list of strictly possible values for the requirement. Ignored when empty", "type": "array", "items": { "type": "string", "example": "US" }, "readOnly": false } } }, "description": { "description": "Describes the requirement type", "example": "Proves the customer has a physical address in the same locality as the phone number", "type": "string", "readOnly": false }, "example": { "description": "Provides one or more examples of acceptable documents", "example": "Utility bill, internet bill, phone bill, or lease", "type": "string", "readOnly": false }, "type": { "description": "Defines the type of this requirement type", "example": "document", "type": "string", "enum": [ "document", "address", "textual" ], "readOnly": false }, "name": { "description": "A short descriptive name for this requirement_type", "example": "Proof of Address", "type": "string", "readOnly": true }, "record_type": { "description": "Identifies the type of the resource", "example": "requirement_type", "type": "string", "readOnly": true }, "id": { "description": "Identifies the associated document", "type": "string", "format": "uuid", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2021-04-09T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was last updated.", "readOnly": true, "example": "2021-04-12T20:20:20.020Z" } } }, "DocReqsRequirementTypeList": { "type": "array", "items": { "$ref": "#/components/schemas/DocReqsRequirementType" } }, "DocServiceDocument": { "allOf": [ { "$ref": "#/components/schemas/DocServiceRecord" }, { "type": "object", "properties": { "record_type": { "description": "Identifies the type of the resource.", "type": "string", "readOnly": true, "example": "document" }, "content_type": { "description": "The document's content_type.", "type": "string", "readOnly": true, "example": "application/pdf" }, "size": { "description": "Indicates the document's filesize", "type": "object", "readOnly": true, "properties": { "unit": { "description": "Identifies the unit", "type": "string", "readOnly": true, "example": "bytes" }, "amount": { "description": "The number of bytes", "type": "integer", "readOnly": true, "example": 123456 } } }, "status": { "type": "string", "description": "Indicates the current document reviewing status", "readOnly": true, "enum": [ "pending", "verified", "denied" ], "example": "pending" }, "sha256": { "description": "The document's SHA256 hash provided for optional verification purposes.", "type": "string", "readOnly": true, "example": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c" }, "filename": { "description": "The filename of the document.", "type": "string", "example": "test-document.pdf" }, "customer_reference": { "type": "string", "description": "Optional reference string for customer tracking.", "example": "MY REF 001" } } } ] }, "DocServiceDocumentLink": { "allOf": [ { "$ref": "#/components/schemas/DocServiceRecord" }, { "type": "object", "properties": { "record_type": { "description": "Identifies the type of the resource.", "type": "string", "readOnly": true, "example": "document_link" }, "document_id": { "description": "Identifies the associated document.", "type": "string", "format": "uuid", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "linked_record_type": { "description": "The linked resource's record type.", "type": "string", "readOnly": true, "example": "porting_order" }, "linked_resource_id": { "description": "Identifies the linked resource.", "type": "string", "readOnly": true, "example": "132091b4-442b-4a2a-b87f-61e707e46d54" } } } ] }, "DocServiceDocumentUploadInline": { "type": "object", "properties": { "file": { "description": "The Base64 encoded contents of the file you are uploading.", "type": "string", "format": "byte", "example": "[Base64 encoded content]" }, "filename": { "description": "The filename of the document.", "type": "string", "example": "test-document.pdf" }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" } }, "required": [ "file" ] }, "DocServiceDocumentUploadURL": { "type": "object", "properties": { "url": { "description": "If the file is already hosted publicly, you can provide a URL and have the documents service fetch it for you.", "type": "string", "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf" }, "filename": { "description": "The filename of the document.", "type": "string", "example": "test-document.pdf" }, "customer_reference": { "type": "string", "description": "Optional reference string for customer tracking.", "example": "MY REF 001" } }, "required": [ "url" ] }, "DocServiceRecord": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "sample_record_type" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "DownlinkData": { "type": "object", "properties": { "amount": { "type": "number", "description": "Downlink data", "example": 1 }, "unit": { "description": "Transmission unit", "type": "string", "enum": [ "B", "KB", "MB" ], "default": "MB" } } }, "DtmfType": { "title": "DTMF Type", "type": "string", "description": "Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.", "enum": [ "RFC 2833", "Inband", "SIP INFO" ], "default": "RFC 2833", "example": "Inband" }, "DynamicEmergencyAddress": { "type": "object", "properties": { "id": { "type": "string", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f1", "readOnly": true }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "dynamic_emergency_address" }, "sip_geolocation_id": { "type": "string", "description": "Unique location reference string to be used in SIP INVITE from / p-asserted headers.", "example": "XYZ123", "readOnly": true }, "status": { "type": "string", "description": "Status of dynamic emergency address", "readOnly": true, "enum": [ "pending", "activated", "rejected" ], "example": "pending" }, "house_number": { "type": "string", "example": 311 }, "house_suffix": { "type": "string" }, "street_pre_directional": { "type": "string", "example": "W" }, "street_name": { "type": "string", "example": "Superior" }, "street_suffix": { "type": "string" }, "street_post_directional": { "type": "string" }, "extended_address": { "type": "string" }, "locality": { "type": "string", "example": "Chicago" }, "administrative_area": { "type": "string", "example": "IL" }, "postal_code": { "type": "string", "example": "60654" }, "country_code": { "type": "string", "example": "US", "enum": [ "US", "CA", "PR" ] }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the resource was created", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the resource was last updated", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } }, "required": [ "house_number", "street_name", "locality", "administrative_area", "postal_code", "country_coude" ] }, "DynamicEmergencyEndpoint": { "type": "object", "properties": { "id": { "type": "string", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "readOnly": true }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "dynamic_emergency_endpoint" }, "dynamic_emergency_address_id": { "type": "string", "description": "An id of a currently active dynamic emergency location.", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "status": { "type": "string", "description": "Status of dynamic emergency address", "readOnly": true, "enum": [ "pending", "activated", "rejected" ], "example": "pending" }, "sip_from_id": { "type": "string", "example": "FXDFWEDF", "readOnly": true }, "callback_number": { "type": "string", "example": "+13125550000" }, "caller_name": { "type": "string", "example": "Jane Doe Desk Phone" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the resource was created", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the resource was last updated", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } }, "required": [ "dynamic_emergency_address_id", "callback_number", "caller_name" ] }, "ESimPurchase": { "title": "SIMCardRegistration", "type": "object", "properties": { "sim_card_group_id": { "type": "string", "format": "uuid", "description": "The group SIMCardGroup identification. This attribute can be null when it's present in an associated resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "tags": { "type": "array", "description": "Searchable tags associated with the SIM cards", "items": { "type": "string" }, "example": [ "personal", "customers", "active-customers" ] }, "amount": { "type": "integer", "description": "The amount of eSIMs to be purchased.", "example": 10, "minimum": 1 }, "status": { "type": "string", "description": "Status on which the SIM cards will be set after being successfully registered.", "enum": [ "enabled", "disabled", "standby" ], "example": "standby", "default": "enabled" } }, "required": [ "amount" ] }, "EmbeddingBucketRequest": { "properties": { "bucket_name": { "type": "string", "title": "Bucket Name" }, "document_chunk_size": { "type": "integer", "title": "Document Chunk Size", "default": 1024 }, "document_chunk_overlap_size": { "type": "integer", "title": "Document Chunk Overlap Size", "default": 512 }, "embedding_model": { "allOf": [ { "$ref": "#/components/schemas/SupportedEmbeddingModels" } ], "default": "thenlper/gte-large" }, "loader": { "allOf": [ { "$ref": "#/components/schemas/SupportedEmbeddingLoaders" } ], "default": "default" } }, "type": "object", "required": [ "bucket_name" ], "title": "EmbeddingBucketRequest" }, "EmbeddingMetadata": { "properties": { "source": { "type": "string", "title": "Source" }, "checksum": { "type": "string", "title": "Checksum" }, "embedding": { "type": "string", "title": "Embedding" }, "filename": { "type": "string", "title": "Filename" }, "certainty": { "type": "number", "title": "Certainty" }, "loader_metadata": { "type": "object", "title": "Loader Metadata" } }, "type": "object", "required": [ "source", "checksum", "embedding", "filename" ], "title": "EmbeddingMetadata" }, "EmbeddingResponse": { "properties": { "data": { "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "title": "Task ID" }, "task_name": { "type": "string", "title": "Task Name" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "title": "Created At" }, "finished_at": { "type": "string", "title": "Finished At", "nullable": true }, "user_id": { "type": "string", "format": "uuid", "title": "User ID" } } } }, "type": "object", "required": [ "data" ], "title": "EmbeddingResponse" }, "EmbeddingSimilaritySearchDocument": { "properties": { "document_chunk": { "type": "string", "title": "Document Chunk" }, "distance": { "type": "number", "title": "Distance" }, "metadata": { "$ref": "#/components/schemas/EmbeddingMetadata" } }, "type": "object", "required": [ "document_chunk", "distance", "metadata" ], "title": "EmbeddingSimilaritySearchDocument", "description": "Example document response from embedding service\n{\n \"document_chunk\": \"your status? This is Vanessa Bloome...\",\n \"distance\": 0.18607724,\n \"metadata\": {\n \"source\": \"https://us-central-1.telnyxstorage.com/scripts/bee_movie_script.txt\",\n \"checksum\": \"343054dd19bab39bbf6761a3d20f1daa\",\n \"embedding\": \"openai/text-embedding-ada-002\",\n \"filename\": \"bee_movie_script.txt\",\n \"certainty\": 0.9069613814353943,\n \"loader_metadata\": {}\n }\n}" }, "EmbeddingSimilaritySearchRequest": { "properties": { "bucket_name": { "type": "string", "title": "Bucket Name" }, "query": { "type": "string", "title": "Query" }, "num_of_docs": { "type": "integer", "title": "Num Of Docs", "default": 3 } }, "type": "object", "required": [ "bucket_name", "query" ], "title": "EmbeddingSimilaritySearchRequest" }, "EmbeddingSimilaritySearchResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EmbeddingSimilaritySearchDocument" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "EmbeddingSimilaritySearchResponse" }, "EmbeddingsBucketFiles": { "properties": { "filename": { "type": "string", "title": "Filename" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "last_embedded_at": { "type": "string", "format": "date-time", "title": "Last Embedded At" }, "error_reason": { "type": "string", "title": "Error Reason" } }, "type": "object", "required": [ "filename", "status", "created_at" ], "title": "EmbeddingsBucketFiles" }, "EmbeddingsBucketFilesData": { "properties": { "data": { "items": { "$ref": "#/components/schemas/EmbeddingsBucketFiles" }, "type": "array", "title": "Data" } }, "type": "object", "required": [ "data" ], "title": "EmbeddingsBucketFilesData" }, "EmergencySettings": { "description": "The emergency services settings for a phone number.", "type": "object", "properties": { "emergency_enabled": { "type": "boolean", "default": false, "description": "Allows you to enable or disable emergency services on the phone number. In order to enable emergency services, you must also set an emergency_address_id." }, "emergency_address_id": { "type": "string", "format": "int64", "description": "Identifies the address to be used with emergency services." }, "emergency_status": { "type": "string", "description": "Represents the state of the number regarding emergency activation.", "default": "disabled", "enum": [ "disabled", "active", "provisioning", "deprovisioning" ] } }, "example": { "emergency_enabled": true, "emergency_address_id": "1315261609962112019" } }, "EncryptedMedia": { "type": "string", "enum": [ "SRTP" ], "nullable": true, "example": "SRTP", "description": "Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS." }, "EnqueueRequest": { "type": "object", "title": "Enqueue Request", "properties": { "queue_name": { "description": "The name of the queue the call should be put in. If a queue with a given name doesn't exist yet it will be created.", "type": "string", "required": true, "example": "tier_1_support" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "max_wait_time_secs": { "description": "The number of seconds after which the call will be removed from the queue.", "type": "integer", "example": 600 }, "max_size": { "description": "The maximum number of calls allowed in the queue at a given time. Can't be modified for an existing queue.", "type": "integer", "default": 100, "example": 200 } }, "example": { "queue_name": "support", "max_wait_time_secs": 600, "max_size": 20, "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "EntityType": { "title": "EntityType", "enum": [ "PRIVATE_PROFIT", "PUBLIC_PROFIT", "NON_PROFIT", "SOLE_PROPRIETOR", "GOVERNMENT" ], "description": "Entity type behind the brand. This is the form of business establishment.", "example": "PRIVATE_PROFIT" }, "Error": { "required": [ "code", "title" ], "properties": { "code": { "type": "string", "format": "int" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "description": "JSON pointer (RFC6901) to the offending entity.", "type": "string", "format": "json-pointer" }, "parameter": { "description": "Indicates which query parameter caused the error.", "type": "string" } } }, "meta": { "type": "object" } } }, "ErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "meta": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } } }, "title": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "type": "string" } } } } } } } }, "Errors": { "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "Exchange": { "title": "Exchange", "enum": [ "NONE", "NASDAQ", "NYSE", "AMEX", "AMX", "ASX", "B3", "BME", "BSE", "FRA", "ICEX", "JPX", "JSE", "KRX", "LON", "NSE", "OMX", "SEHK", "SSE", "STO", "SWX", "SZSE", "TSX", "TWSE", "VSE" ], "description": "An enumeration." }, "ExportPortingOrdersCSVReport": { "description": "The parameters for generating a porting orders CSV report.", "type": "object", "required": [ "filters" ], "properties": { "filters": { "type": "object", "description": "The filters to apply to the export porting order CSV report.", "properties": { "status__in": { "type": "array", "description": "The status of the porting orders to include in the report.", "items": { "type": "string", "enum": [ "draft", "in-process", "submitted", "exception", "foc-date-confirmed", "cancel-pending", "ported", "cancelled" ] } }, "customer_reference__in": { "type": "array", "description": "The customer reference of the porting orders to include in the report.", "items": { "type": "string", "example": "my-customer-reference" } }, "created_at__lt": { "type": "string", "description": "The date and time the porting order was created before.", "format": "date-time" }, "created_at__gt": { "type": "string", "description": "The date and time the porting order was created after.", "format": "date-time" } } } } }, "ExtVettingProvider": { "title": "ExtVettingProvider", "type": "object", "properties": { "evpId": { "title": "Evpid", "type": "string" }, "displayName": { "title": "Displayname", "type": "string" }, "tcrBillable": { "title": "Tcrbillable", "type": "boolean" }, "vettingClasses": { "title": "Vettingclasses", "type": "array", "items": { "type": "string" } }, "vettingInstruction": { "title": "Vettinginstruction", "type": "string" } } }, "ExternalConnection": { "type": "object", "title": "External Connection", "properties": { "id": { "$ref": "#/components/schemas/IntId" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "external_connection" }, "active": { "$ref": "#/components/schemas/ConnectionActive" }, "credential_active": { "$ref": "#/components/schemas/CredentialActive" }, "external_sip_connection": { "$ref": "#/components/schemas/ExternalSipConnection" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "id": "1930241863466354012", "record_type": "external_connection", "external_sip_connection": "zoom", "credential_active": false, "active": false, "created_at": "2022-06-29T19:23:59Z", "updated_at": "2022-06-29T19:39:47Z", "outbound": { "outbound_voice_profile_id": "1911630617284445511" } } }, "ExternalConnectionPhoneNumber": { "type": "object", "title": "Phone number details with relation to an external connection", "properties": { "ticket_id": { "$ref": "#/components/schemas/UUID" }, "telephone_number": { "type": "string", "description": "Phone number in E164 format." }, "number_id": { "type": "string", "description": "Phone number ID from the Telnyx API." }, "civic_address_id": { "type": "string", "format": "uuid", "description": "Identifies the civic address assigned to the phone number." }, "location_id": { "type": "string", "format": "uuid", "description": "Identifies the location assigned to the phone number." }, "displayed_country_code": { "type": "string", "description": "The iso country code that will be displayed to the user when they receive a call from this phone number." }, "acquired_capabilities": { "type": "array", "items": { "type": "string", "enum": [ "FirstPartyAppAssignment", "InboundCalling", "Office365", "OutboundCalling", "UserAssignment" ], "description": "The capabilities that are available for this phone number on Microsoft Teams." } } } }, "ExternalSipConnection": { "title": "External SIP Connection", "type": "string", "description": "The service that will be consuming this connection.", "enum": [ "zoom", "operator_connect" ], "default": "zoom", "example": "zoom" }, "ExternalSipConnectionZoomOnly": { "title": "External SIP Connection", "type": "string", "description": "The service that will be consuming this connection.", "enum": [ "zoom" ], "default": "zoom", "example": "zoom" }, "ExternalVetting": { "title": "ExternalVetting", "type": "object", "properties": { "evpId": { "title": "Evpid", "maxLength": 10, "type": "string", "description": "External vetting provider ID for the brand." }, "vettingId": { "title": "vettingId", "type": "string", "description": "Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting." }, "vettingToken": { "title": "vettingToken", "type": "string", "description": "Required by some providers for vetting record confirmation." }, "vettingScore": { "title": "vettingScore", "type": "integer", "description": "Vetting score ranging from 0-100." }, "vettingClass": { "title": "Vettingclass", "type": "string", "description": "Identifies the vetting classification." }, "vettedDate": { "title": "vettedDate", "type": "string", "description": "Vetting effective date. This is the date when vetting was completed, or the starting effective date in ISO 8601 format. If this date is missing, then the vetting was not complete or not valid." }, "createDate": { "title": "createDate", "type": "string", "description": "Vetting submission date. This is the date when the vetting request is generated in ISO 8601 format." } } }, "ExternalWdrDetailRecordDto": { "type": "object", "properties": { "id": { "type": "string", "description": "WDR id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "created_at": { "type": "string", "description": "Record created time", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "cost": { "$ref": "#/components/schemas/WirelessCost" }, "mcc": { "type": "string", "description": "Mobile country code.", "example": "204" }, "mnc": { "type": "string", "description": "Mobile network code.", "example": "01" }, "downlink_data": { "$ref": "#/components/schemas/DownlinkData" }, "duration_seconds": { "type": "number", "description": "Session duration in seconds.", "example": 1 }, "imsi": { "type": "string", "description": "International mobile subscriber identity.", "example": "123" }, "rate": { "$ref": "#/components/schemas/WirelessRate" }, "sim_group_name": { "type": "string", "description": "Defined sim group name", "example": "sim name" }, "sim_group_id": { "type": "string", "description": "Sim group unique identifier", "example": "f05a189f-7c46-4531-ac56-1460dc465a42" }, "sim_card_id": { "type": "string", "description": "Sim card unique identifier", "example": "877f80a6-e5b2-4687-9a04-88076265720f" }, "phone_number": { "type": "string", "description": "Phone number", "example": "+12345678910" }, "uplink_data": { "$ref": "#/components/schemas/UplinkData" }, "record_type": { "type": "string", "example": "wdr" } } }, "ExternalWdrGetDetailResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalWdrDetailRecordDto" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "Fax": { "type": "object", "properties": { "record_type": { "description": "Identifies the type of the resource.", "type": "string", "example": "fax", "enum": [ "fax" ] }, "id": { "$ref": "#/components/schemas/Id" }, "connection_id": { "$ref": "#/components/schemas/ConnectionId" }, "direction": { "$ref": "#/components/schemas/Direction" }, "media_url": { "$ref": "#/components/schemas/MediaUrl" }, "media_name": { "$ref": "#/components/schemas/MediaName" }, "to": { "$ref": "#/components/schemas/To" }, "from": { "$ref": "#/components/schemas/From" }, "from_display_name": { "description": "The string used as the caller id name (SIP From Display Name) presented to the destination (`to` number).", "type": "string", "example": "Company Name" }, "quality": { "$ref": "#/components/schemas/Quality" }, "status": { "description": "Status of the fax", "type": "string", "example": "queued", "enum": [ "queued", "media.processed", "originated", "sending", "delivered", "failed", "initiated", "receiving", "media.processing", "received" ] }, "webhook_url": { "description": "URL that will receive fax webhooks", "type": "string" }, "webhook_failover_url": { "description": "Optional failover URL that will receive fax webhooks if webhook_url doesn't return a 2XX response", "type": "string" }, "store_media": { "description": "Should fax media be stored on temporary URL. It does not support media_name.", "type": "boolean" }, "stored_media_url": { "description": "If store_media was set to true, this is a link to temporary location. Link expires after 10 minutes.", "type": "string" }, "created_at": { "description": "ISO 8601 timestamp when resource was created", "type": "string", "format": "datetime" }, "updated_at": { "description": "ISO 8601 timestamp when resource was updated", "type": "string", "format": "datetime" } }, "example": { "record_type": "fax", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "connection_id": "c-1", "direction": "outbound", "from": "+123", "to": "+456", "media_url": "http://www.example.com/fax.pdf", "store_media": true, "stored_media_url": "https://s3.amazonaws.com/faxes-dev/user-1/cf4a6b52-bf8e-4945-9f49-611d0d2b083b.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=xxxxxxxxxx%2F20200505%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20200505T095917Z&X-Amz-Expires=7200&X-Amz-SignedHeaders=host&X-Amz-Signature=fac2af40464fcc77673ad762db86e34f9c1b91a82699b5578c5327f53874df51", "quality": "high", "webhook_url": "http://www.example.com/webhooks", "webhook_failover_url": "", "status": "queued", "created_at": "2020-05-05T09:59:12", "updated_at": "2020-05-05T09:59:12" } }, "FaxApplication": { "type": "object", "title": "Fax Application", "properties": { "id": { "$ref": "#/components/schemas/IntId" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "fax_application" }, "application_name": { "$ref": "#/components/schemas/ApplicationName" }, "active": { "$ref": "#/components/schemas/ConnectionActive" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "webhook_event_url": { "$ref": "#/components/schemas/WebhookEventUrl" }, "webhook_event_failover_url": { "$ref": "#/components/schemas/WebhookEventFailoverUrl" }, "webhook_timeout_secs": { "$ref": "#/components/schemas/WebhookTimeoutSecs" }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "inbound_fax_file_type": { "type": "string", "description": "The file type used for inbound faxes.", "enum": [ "pdf", "tiff" ], "default": "pdf", "example": "pdf" }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.", "default": null, "example": "example" }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ], "default": "from_anyone", "example": "only_my_connections" } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "id": "1293384261075731499", "record_type": "fax_application", "application_name": "fax-router", "active": false, "anchorsite_override": "Amsterdam, Netherlands", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_timeout_secs": 25, "inbound": { "channel_limit": 10, "inbound_fax_file_type": "pdf", "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" }, "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z" } }, "FaxDelivered": { "type": "object", "example": { "data": { "event_type": "fax.delivered", "id": "95479a2e-b947-470a-a88f-2da6dd07ae0f", "occurred_at": "2020-05-05T13:08:22.039204Z", "payload": { "call_duration_secs": 25, "connection_id": "234423", "direction": "outbound", "fax_id": "f8338808-3dc6-4f2b-942a-5d1f39255784", "from": "+17733372107", "original_media_url": "http://www.example.com/fax.pdf", "page_count": 2, "status": "delivered", "to": "+15107882622", "user_id": "19a75cea-02c6-4b9a-84fa-c9bc8341feb8" }, "record_type": "event" } }, "properties": { "record_type": { "$ref": "#/components/schemas/RecordType" }, "id": { "$ref": "#/components/schemas/Id" }, "event_type": { "type": "string", "example": "fax.delivered", "enum": [ "fax.delivered" ], "description": "The type of event being delivered." }, "payload": { "type": "object", "properties": { "call_duration_secs": { "description": "The duration of the call in seconds.", "type": "integer", "example": 25 }, "connection_id": { "$ref": "#/components/schemas/ConnectionId" }, "direction": { "$ref": "#/components/schemas/Direction" }, "fax_id": { "$ref": "#/components/schemas/FaxId" }, "original_media_url": { "$ref": "#/components/schemas/OriginalMediaUrl" }, "media_name": { "$ref": "#/components/schemas/MediaName" }, "to": { "$ref": "#/components/schemas/To" }, "from": { "$ref": "#/components/schemas/From" }, "user_id": { "$ref": "#/components/schemas/UserId" }, "page_count": { "description": "Number of transferred pages", "type": "integer", "example": 2 }, "status": { "type": "string", "example": "delivered", "enum": [ "delivered" ], "description": "The status of the fax." } } } } }, "FaxEmailRecipient": { "title": "Fax Email Recipient", "type": "string", "description": "Specifies an email address where faxes sent to this application will be forwarded to (as pdf or tiff attachments)", "default": null, "nullable": true, "format": "email", "example": "user@example.com" }, "FaxFailed": { "type": "object", "example": { "data": { "event_type": "fax.failed", "id": "95479a2e-b947-470a-a88f-2da6dd07ae0f", "occurred_at": "2020-05-05T13:08:22.039204Z", "payload": { "connection_id": "234423", "direction": "outbound", "failure_reason": "rejected", "fax_id": "f8338808-3dc6-4f2b-942a-5d1f39255784", "from": "+17733372107", "original_media_url": "http://www.example.com/fax.pdf", "status": "failed", "to": "+15107882622", "user_id": "19a75cea-02c6-4b9a-84fa-c9bc8341feb8" }, "record_type": "event" } }, "properties": { "record_type": { "$ref": "#/components/schemas/RecordType" }, "id": { "$ref": "#/components/schemas/Id" }, "event_type": { "type": "string", "example": "fax.failed", "enum": [ "fax.failed" ], "description": "The type of event being delivered." }, "payload": { "type": "object", "properties": { "connection_id": { "$ref": "#/components/schemas/ConnectionId" }, "direction": { "$ref": "#/components/schemas/Direction" }, "fax_id": { "$ref": "#/components/schemas/FaxId" }, "original_media_url": { "$ref": "#/components/schemas/OriginalMediaUrl" }, "media_name": { "$ref": "#/components/schemas/MediaName" }, "to": { "$ref": "#/components/schemas/To" }, "from": { "$ref": "#/components/schemas/From" }, "user_id": { "$ref": "#/components/schemas/UserId" }, "failure_reason": { "type": "string", "enum": [ "rejected" ], "description": "Cause of the sending failure" }, "status": { "type": "string", "example": "failed", "enum": [ "failed" ], "description": "The status of the fax." } } } } }, "FaxId": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the fax." }, "FaxMediaProcessed": { "type": "object", "example": { "data": { "event_type": "fax.media.processed", "id": "95479a2e-b947-470a-a88f-2da6dd07ae0f", "occurred_at": "2020-05-05T13:08:22.039204Z", "payload": { "connection_id": "234423", "direction": "outbound", "fax_id": "f8338808-3dc6-4f2b-942a-5d1f39255784", "from": "+17733372107", "original_media_url": "http://www.example.com/fax.pdf", "status": "media.processed", "to": "+15107882622", "user_id": "19a75cea-02c6-4b9a-84fa-c9bc8341feb8" }, "record_type": "event" } }, "properties": { "record_type": { "$ref": "#/components/schemas/RecordType" }, "id": { "$ref": "#/components/schemas/Id" }, "event_type": { "type": "string", "example": "fax.media.processed", "enum": [ "fax.media.processed" ], "description": "The type of event being delivered." }, "payload": { "type": "object", "properties": { "connection_id": { "$ref": "#/components/schemas/ConnectionId" }, "direction": { "$ref": "#/components/schemas/Direction" }, "fax_id": { "$ref": "#/components/schemas/FaxId" }, "original_media_url": { "$ref": "#/components/schemas/OriginalMediaUrl" }, "media_name": { "$ref": "#/components/schemas/MediaName" }, "to": { "$ref": "#/components/schemas/To" }, "from": { "$ref": "#/components/schemas/From" }, "user_id": { "$ref": "#/components/schemas/UserId" }, "status": { "type": "string", "example": "media.processed", "enum": [ "media.processed" ], "description": "The status of the fax." } } } } }, "FaxQueued": { "type": "object", "example": { "data": { "event_type": "fax.queued", "id": "95479a2e-b947-470a-a88f-2da6dd07ae0f", "occurred_at": "2020-05-05T13:08:22.039204Z", "payload": { "connection_id": "234423", "direction": "outbound", "fax_id": "f8338808-3dc6-4f2b-942a-5d1f39255784", "from": "+17733372107", "original_media_url": "http://www.example.com/fax.pdf", "status": "queued", "to": "+15107882622", "user_id": "19a75cea-02c6-4b9a-84fa-c9bc8341feb8" }, "record_type": "event" } }, "properties": { "record_type": { "$ref": "#/components/schemas/RecordType" }, "id": { "$ref": "#/components/schemas/Id" }, "event_type": { "type": "string", "example": "fax.queued", "enum": [ "fax.queued" ], "description": "The type of event being delivered." }, "payload": { "type": "object", "properties": { "connection_id": { "$ref": "#/components/schemas/ConnectionId" }, "direction": { "$ref": "#/components/schemas/Direction" }, "fax_id": { "$ref": "#/components/schemas/FaxId" }, "original_media_url": { "$ref": "#/components/schemas/OriginalMediaUrl" }, "media_name": { "$ref": "#/components/schemas/MediaName" }, "to": { "$ref": "#/components/schemas/To" }, "from": { "$ref": "#/components/schemas/From" }, "user_id": { "$ref": "#/components/schemas/UserId" }, "status": { "type": "string", "example": "queued", "enum": [ "queued" ], "description": "The status of the fax." } } } } }, "FaxSendingStarted": { "type": "object", "example": { "data": { "event_type": "fax.sending.started", "id": "95479a2e-b947-470a-a88f-2da6dd07ae0f", "occurred_at": "2020-05-05T13:08:22.039204Z", "payload": { "connection_id": "234423", "direction": "outbound", "fax_id": "f8338808-3dc6-4f2b-942a-5d1f39255784", "from": "+17733372107", "original_media_url": "http://www.example.com/fax.pdf", "status": "sending", "to": "+15107882622", "user_id": "19a75cea-02c6-4b9a-84fa-c9bc8341feb8" }, "record_type": "event" } }, "properties": { "record_type": { "$ref": "#/components/schemas/RecordType" }, "id": { "$ref": "#/components/schemas/Id" }, "event_type": { "type": "string", "example": "fax.sending.started", "enum": [ "fax.sending.started" ], "description": "The type of event being delivered." }, "payload": { "type": "object", "properties": { "connection_id": { "$ref": "#/components/schemas/ConnectionId" }, "direction": { "$ref": "#/components/schemas/Direction" }, "fax_id": { "$ref": "#/components/schemas/FaxId" }, "original_media_url": { "$ref": "#/components/schemas/OriginalMediaUrl" }, "media_name": { "$ref": "#/components/schemas/MediaName" }, "to": { "$ref": "#/components/schemas/To" }, "from": { "$ref": "#/components/schemas/From" }, "user_id": { "$ref": "#/components/schemas/UserId" }, "status": { "type": "string", "example": "sending", "enum": [ "sending" ], "description": "The status of the fax." } } } } }, "Feature": { "properties": { "name": { "type": "string", "example": "sms" } }, "example": { "name": "sms" } }, "Filter": { "type": "object", "properties": { "filter_type": { "type": "string", "enum": [ "and", "or" ] }, "cli": { "type": "string", "example": "+13129457420" }, "cli_filter": { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, "cld": { "type": "string", "example": "+13129457420" }, "cld_filter": { "type": "string", "enum": [ "contains", "starts_with", "ends_with" ] }, "tags_list": { "type": "string", "example": "tag1" }, "billing_group": { "type": "string", "example": "adfaa016-f921-4b6c-97bb-e4c1dad231c5" } } }, "FirstCommandTimeout": { "title": "First Command Timeout", "type": "boolean", "description": "Specifies whether calls to phone numbers associated with this connection should hangup after timing out.", "default": false, "example": true }, "FirstCommandTimeoutSecs": { "title": "First Command Timeout Secs", "type": "integer", "description": "Specifies how many seconds to wait before timing out a dial command.", "default": 30, "example": 10 }, "ForbiddenError": { "allOf": [ { "$ref": "#/components/schemas/GenericError" }, { "properties": { "code": { "example": "10010" }, "title": { "example": "Authorization failed" }, "detail": { "example": "You do not have permission to perform the requested action on the specified resource or resources." }, "meta": { "type": "object", "properties": { "url": { "type": "string", "example": "https://developers.telnyx.com/docs/overview/errors/10010" } } } } } ] }, "Fqdn": { "type": "object", "title": "Fqdn", "properties": { "id": { "type": "string", "format": "int64", "description": "Identifies the resource.", "example": "1293384261075731499" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "fqdn" }, "connection_id": { "type": "string", "description": "ID of the FQDN connection to which this FQDN is attached." }, "fqdn": { "type": "string", "description": "FQDN represented by this resource.", "example": "example.com" }, "port": { "type": "integer", "description": "Port to use when connecting to this FQDN.", "default": 5060, "example": 5060 }, "dns_record_type": { "type": "string", "description": "The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.", "example": "a" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "id": "1293384261075731499", "record_type": "fqdn", "connection_id": "1516447646313612565", "fqdn": "example.com", "port": 5060, "dns_record_type": "a", "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z" } }, "FqdnConnection": { "type": "object", "title": "FQDN Connection", "required": [ "connection_name" ], "properties": { "id": { "type": "string", "format": "int64", "description": "Identifies the resource.", "example": "1293384261075731499" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "fqdn_connection" }, "active": { "type": "boolean", "description": "Defaults to true" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "$ref": "#/components/schemas/ConnectionName" }, "transport_protocol": { "$ref": "#/components/schemas/FqdnConnectionTransportProtocol" }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": true, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout." }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios." }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "microsoft_teams_sbc": { "type": "boolean", "description": "The connection is enabled for Microsoft Teams Direct Routing.", "default": false }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer that the sender and receiver negotiate T38 directly when both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call according to each leg's settings." }, "user_name": { "type": "string", "description": "The username for the FQDN connection." }, "password": { "type": "string", "description": "The password for the FQDN connection." }, "rtp_pass_codecs_on_stream_change": { "type": "boolean", "description": "Defines if codecs should be passed on stream change." }, "adjust_dtmf_timestamp": { "type": "boolean", "description": "Indicates whether DTMF timestamp adjustment is enabled." }, "ignore_dtmf_duration": { "type": "boolean", "description": "Indicates whether DTMF duration should be ignored." }, "ignore_mark_bit": { "type": "boolean", "description": "Indicates whether the mark bit should be ignored." }, "call_cost_enabled": { "type": "boolean", "description": "Indicates whether call cost calculation is enabled." }, "noise_suppression": { "type": "boolean", "description": "Indicates whether noise suppression is enabled." }, "send_normalized_timestamps": { "type": "boolean", "description": "Indicates whether normalized timestamps should be sent." }, "third_party_control_enabled": { "type": "boolean", "description": "Indicates whether third-party control is enabled." }, "txt_name": { "type": "string", "description": "The name for the TXT record associated with the FQDN connection." }, "txt_value": { "type": "string", "description": "The value for the TXT record associated with the FQDN connection." }, "txt_ttl": { "type": "integer", "description": "The time to live for the TXT record associated with the FQDN connection." }, "webhook_event_url": { "$ref": "#/components/schemas/WebhookEventUrl" }, "webhook_event_failover_url": { "$ref": "#/components/schemas/WebhookEventFailoverUrl" }, "webhook_api_version": { "$ref": "#/components/schemas/WebhookApiVersion" }, "webhook_timeout_secs": { "$ref": "#/components/schemas/WebhookTimeoutSecs" }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "created_at": { "$ref": "#/components/schemas/CreatedAt" }, "updated_at": { "$ref": "#/components/schemas/UpdatedAt" }, "inbound": { "$ref": "#/components/schemas/InboundFqdn" }, "outbound": { "$ref": "#/components/schemas/OutboundFqdn" } }, "example": { "id": "1293384261075731499", "record_type": "fqdn_connection", "active": true, "anchorsite_override": "Latency", "connection_name": "string", "transport_protocol": "UDP", "default_on_hold_comfort_noise_enabled": true, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": true, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_secs": 10 }, "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z", "inbound": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": [ "G722" ], "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "string", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 10, "shaken_stir_enabled": true }, "outbound": { "ani_override": "string", "ani_override_type": "always", "call_parking_enabled": true, "channel_limit": 10, "generate_ringback_tone": true, "instant_ringback_enabled": true, "ip_authentication_method": "token", "ip_authentication_token": "string", "localization": "string", "outbound_voice_profile_id": "1293384261075731499", "t38_reinvite_source": "telnyx", "tech_prefix": "string" } } }, "FqdnConnectionTransportProtocol": { "type": "string", "description": "One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.", "default": "UDP", "enum": [ "UDP", "TCP", "TLS" ] }, "From": { "description": "The phone number, in E.164 format, the fax will be sent from.", "type": "string", "example": "+13125790015" }, "GCSConfigurationData": { "type": "object", "title": "Google Cloud Storage Configuration Data", "properties": { "credentials": { "$ref": "#/components/schemas/Credentials" }, "bucket": { "$ref": "#/components/schemas/Bucket" } } }, "GatherRequest": { "type": "object", "title": "Gather", "properties": { "minimum_digits": { "description": "The minimum number of digits to fetch. This parameter has a minimum value of 1.", "default": 1, "type": "integer", "example": 1, "format": "int32" }, "maximum_digits": { "description": "The maximum number of digits to fetch. This parameter has a maximum value of 128.", "default": 128, "type": "integer", "example": 10, "format": "int32" }, "timeout_millis": { "description": "The number of milliseconds to wait to complete the request.", "default": 60000, "type": "integer", "example": 60000, "format": "int32" }, "inter_digit_timeout_millis": { "description": "The number of milliseconds to wait for input between digits.", "default": 5000, "type": "integer", "example": 10000, "format": "int32" }, "initial_timeout_millis": { "description": "The number of milliseconds to wait for the first DTMF.", "default": 5000, "type": "integer", "example": 10000, "format": "int32" }, "terminating_digit": { "description": "The digit used to terminate input if fewer than `maximum_digits` digits have been gathered.", "default": "#", "type": "string", "example": "#" }, "valid_digits": { "description": "A list of all digits accepted as valid.", "default": "0123456789#*", "type": "string", "example": "123" }, "gather_id": { "description": "An id that will be sent back in the corresponding `call.gather.ended` webhook. Will be randomly generated if not specified.", "type": "string", "example": "my_gather_id", "min_length": 1, "max_length": 40 }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } } }, "GatherUsingAudioRequest": { "type": "object", "title": "Gather Using Audio Request", "properties": { "audio_url": { "type": "string", "example": "http://example.com/message.wav", "description": "The URL of a file to be played back at the beginning of each prompt. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played back at the beginning of each prompt. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file." }, "invalid_audio_url": { "type": "string", "description": "The URL of a file to play when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. The URL can point to either a WAV or MP3 file. invalid_media_name and invalid_audio_url cannot be used together in one request.", "example": "http://example.com/invalid.wav" }, "invalid_media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played back when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file." }, "minimum_digits": { "description": "The minimum number of digits to fetch. This parameter has a minimum value of 1.", "default": 1, "type": "integer", "example": 1, "format": "int32" }, "maximum_digits": { "description": "The maximum number of digits to fetch. This parameter has a maximum value of 128.", "default": 128, "type": "integer", "example": 10, "format": "int32" }, "maximum_tries": { "description": "The maximum number of times the file should be played if there is no input from the user on the call.", "default": 3, "type": "integer", "example": 3, "format": "int32" }, "timeout_millis": { "description": "The number of milliseconds to wait for a DTMF response after file playback ends before a replaying the sound file.", "default": 60000, "type": "integer", "example": 60000, "format": "int32" }, "terminating_digit": { "description": "The digit used to terminate input if fewer than `maximum_digits` digits have been gathered.", "default": "#", "type": "string", "example": "#" }, "valid_digits": { "description": "A list of all digits accepted as valid.", "default": "0123456789#*", "type": "string", "example": "123" }, "inter_digit_timeout_millis": { "description": "The number of milliseconds to wait for input between digits.", "default": 5000, "type": "integer", "example": 10000, "format": "int32" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "audio_url": "http://example.com/message.wav", "invalid_audio_url": "http://example.com/message.wav", "minimum_digits": 1, "maximum_digits": 10, "timeout_millis": 10000, "terminating_digit": "#", "valid_digits": "123", "inter_digit_timeout_millis": 10000, "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "GatherUsingSpeakRequest": { "type": "object", "title": "Gather Using Speak Request", "required": [ "voice", "payload" ], "properties": { "payload": { "description": "The text or SSML to be converted into speech. There is a 3,000 character limit.", "type": "string", "example": "Say this on the call" }, "invalid_payload": { "description": "The text or SSML to be converted into speech when digits don't match the `valid_digits` parameter or the number of digits is not between `min` and `max`. There is a 3,000 character limit.", "type": "string", "example": "Say this on the call" }, "payload_type": { "description": "The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).", "default": "text", "type": "string", "enum": [ "text", "ssml" ], "example": "ssml" }, "service_level": { "description": "This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed.", "default": "premium", "type": "string", "enum": [ "basic", "premium" ], "example": "premium" }, "voice": { "description": "The gender of the voice used to speak back the text or the specific Amazon Polly voice to be used in the form of `Polly.`, e.g. `Polly.Brian`. All standard Amazon Polly voices are supported.", "type": "string", "enum": [ "male", "female" ], "example": "female" }, "language": { "description": "The language you want spoken. This parameter is ignored when a `Polly.*` voice is specified.", "type": "string", "enum": [ "arb", "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "is-IS", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR" ], "example": "en-US" }, "minimum_digits": { "description": "The minimum number of digits to fetch. This parameter has a minimum value of 1.", "default": 1, "type": "integer", "example": 1, "format": "int32" }, "maximum_digits": { "description": "The maximum number of digits to fetch. This parameter has a maximum value of 128.", "default": 128, "type": "integer", "example": 10, "format": "int32" }, "maximum_tries": { "description": "The maximum number of times that a file should be played back if there is no input from the user on the call.", "default": 3, "type": "integer", "example": 3, "format": "int32" }, "timeout_millis": { "description": "The number of milliseconds to wait for a DTMF response after speak ends before a replaying the sound file.", "default": 60000, "type": "integer", "example": 60000, "format": "int32" }, "terminating_digit": { "description": "The digit used to terminate input if fewer than `maximum_digits` digits have been gathered.", "default": "#", "type": "string", "example": "#" }, "valid_digits": { "description": "A list of all digits accepted as valid.", "default": "0123456789#*", "type": "string", "example": "123" }, "inter_digit_timeout_millis": { "description": "The number of milliseconds to wait for input between digits.", "default": 5000, "type": "integer", "example": 10000, "format": "int32" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "payload": "say this on call", "invalid_payload": "say this on call", "payload_type": "text", "service_level": "premium", "voice": "male", "language": "arb", "minimum_digits": 1, "maximum_digits": 10, "terminating_digit": "#", "valid_digits": "123", "inter_digit_timeout_millis": 10000, "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "GcbChannelZone": { "title": "Channel zone object", "required": [ "record_type", "countries", "id", "name", "channels" ], "type": "object", "properties": { "record_type": { "type": "string", "enum": [ "channel_zone" ], "example": "channel_zone" }, "countries": { "type": "array", "items": { "type": "string" }, "description": "List of countries (in ISO 3166-2, capitalized) members of the billing channel zone", "example": [ "BE", "EL", "LT", "PT", "BG", "ES", "LU", "RO", "CZ", "FR", "HU", "SI", "DK", "HR", "MT", "SK", "DE", "IT", "NL", "FI", "EE", "CY", "AT", "SE", "IE", "LV", "PL" ] }, "id": { "type": "string", "example": "1653e6a1-4bfd-4857-97c6-6a51e1c34477" }, "name": { "type": "string", "example": "Euro channel zone" }, "channels": { "type": "integer", "format": "int64", "example": 7 }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the channel zone was created", "example": "2019-01-23T18:10:02.574Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the channel zone was updated", "example": "2019-01-23T18:10:02.574Z" } } }, "GcbPhoneNumber": { "title": "Phone Number object", "required": [ "record_type", "channel_zone_id", "phone_number" ], "type": "object", "properties": { "record_type": { "type": "string", "enum": [ "channel_zone_phone_number" ], "example": "channel_zone_phone_number" }, "channel_zone_id": { "type": "string", "example": "1653e6a1-4bfd-4857-97c6-6a51e1c34477" }, "id": { "type": "string", "example": "3da3c749-bb7d-4ad6-acae-ca0d415ae08b" }, "phone_number": { "type": "string", "format": "+E.164", "example": "+15554441234" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the phone number was created", "example": "2019-01-23T18:10:02.574Z" } } }, "GenericError": { "properties": { "code": { "type": "string", "format": "int" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "description": "JSON pointer (RFC6901) to the offending entity.", "type": "string", "format": "json-pointer" }, "parameter": { "description": "Indicates which query parameter caused the error.", "type": "string" } } }, "meta": { "type": "object" } } }, "GetSubRequestByPortingOrder": { "type": "object", "properties": { "sub_request_id": { "type": "string", "description": "Identifies the Sub Request associated with the Porting Order", "example": "9787fb5f-cbe5-4de4-b765-3303774ee9fe" }, "port_request_id": { "type": "string", "description": "Identifies the Port Request associated with the Porting Order", "example": "59b0762a-b274-4f76-ac32-4d5cf0272e66" } } }, "GlobalIP": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "type": "object", "title": "Global IP", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "global_ip" }, "ip_address": { "type": "string", "description": "The Global IP address.", "readOnly": true, "example": "198.51.100.1" }, "ports": { "type": "object", "description": "A Global IP ports grouped by protocol code.", "example": { "tcp": [ 80, 8080 ], "udp": [ 5000, 5050 ] } }, "name": { "type": "string", "description": "A user specified name for the address.", "example": "test interface" }, "description": { "type": "string", "description": "A user specified description for the address.", "example": "test interface" } } } ] }, "GlobalIPAllowedPort": { "allOf": [ { "type": "object", "title": "Global IP Allowed Port Range", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "global_ip_allowed_port" }, "protocol_code": { "type": "string", "description": "The Global IP Protocol code.", "readOnly": true, "example": "tcp" }, "name": { "type": "string", "description": "A name for the Global IP ports range.", "example": "TCP Registered" }, "first_port": { "type": "integer", "description": "First port of a range.", "example": 1024 }, "last_port": { "type": "integer", "description": "Last port of a range.", "example": 49151 } } } ] }, "GlobalIPHealthCheck": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "type": "object", "title": "Global IP health check", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "global_ip_health_check" }, "health_check_type": { "type": "string", "description": "The Global IP health check type.", "example": "http_status_2xx" }, "health_check_params": { "type": "object", "description": "A Global IP health check params.", "example": { "path": "/", "port": 8080 } }, "global_ip_id": { "type": "string", "format": "uuid", "description": "Global IP ID.", "example": "a836125b-20b6-452e-9c03-2653f09c7ed7" } } } ] }, "GlobalIPProtocol": { "allOf": [ { "type": "object", "title": "Global IP Protocol", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "global_ip_protocol" }, "code": { "type": "string", "description": "The Global IP Protocol code.", "readOnly": true, "example": "tcp" }, "name": { "type": "string", "description": "A name for Global IP Protocol.", "example": "TCP" } } } ] }, "GlobalIpAssignment": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "type": "object", "title": "Global IP", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "global_ip_assignment" }, "global_ip_id": { "type": "string", "format": "uuid", "description": "Global IP ID.", "example": "a836125b-20b6-452e-9c03-2653f09c7ed7" }, "wireguard_peer_id": { "type": "string", "format": "uuid", "description": "Wireguard peer ID.", "example": "e66c496d-4a85-423b-8b2a-8e63fac20320" }, "status": { "$ref": "#/components/schemas/InterfaceStatus" }, "is_connected": { "type": "boolean", "readOnly": true, "description": "Wireguard peer is connected." }, "is_in_maintenance": { "type": "boolean", "description": "Enable/disable BGP announcement." }, "is_announced": { "type": "boolean", "readOnly": true, "description": "Status of BGP announcement." } } } ] }, "GlobalIpAssignmentHealthMetric": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the metric.", "example": "2020-01-01T00:00:00.000Z" }, "global_ip": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Global IP ID.", "example": "a836125b-20b6-452e-9c03-2653f09c7ed7" }, "ip_address": { "type": "string", "description": "The Global IP address.", "readOnly": true, "example": null } } }, "global_ip_assignment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Global IP assignment ID.", "example": "a836125b-20b6-452e-9c03-2653f09c7ed7" }, "wireguard_peer_id": { "type": "string", "format": "uuid", "description": "Wireguard peer ID.", "example": "e66c496d-4a85-423b-8b2a-8e63fac20320" }, "wireguard_peer": { "type": "object", "properties": { "name": { "type": "string", "description": "A user specified name for the interface.", "example": "Wireguard Peer 1" }, "ip_address": { "type": "string", "description": "The IP address of the interface.", "example": "73.47.1.23" } } } } }, "health": { "type": "object", "properties": { "pass": { "type": "number", "description": "The number of successful health checks.", "example": 100 }, "fail": { "type": "number", "description": "The number of failed health checks.", "example": 0 } } } } }, "GlobalIpAssignmentUpdate": { "allOf": [ { "$ref": "#/components/schemas/GlobalIpAssignment" }, { "type": "object", "title": "Global IP", "properties": { "global_ip_id": { "readOnly": true }, "wireguard_peer_id": { "readOnly": true } } } ] }, "GlobalIpAssignmentUsageMetric": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the metric.", "example": "2020-01-01T00:00:00.000Z" }, "global_ip": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Global IP ID.", "example": "a836125b-20b6-452e-9c03-2653f09c7ed7" }, "ip_address": { "type": "string", "description": "The Global IP address.", "readOnly": true, "example": "64.1.4.130" } } }, "global_ip_assignment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Global IP assignment ID.", "example": "a836125b-20b6-452e-9c03-2653f09c7ed7" }, "wireguard_peer_id": { "type": "string", "format": "uuid", "description": "Wireguard peer ID.", "example": "e66c496d-4a85-423b-8b2a-8e63fac20320" }, "wireguard_peer": { "type": "object", "properties": { "name": { "type": "string", "description": "A user specified name for the interface.", "example": "Wireguard Peer 1" }, "ip_address": { "type": "string", "description": "The IP address of the interface.", "example": "172.1.0.1" } } } } }, "transmitted": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of data transmitted.", "example": 100000 }, "unit": { "type": "string", "description": "The unit of the amount of data transmitted.", "example": "B" } } }, "received": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of data received.", "example": 100000 }, "unit": { "type": "string", "description": "The unit of the amount of data received.", "example": "B" } } } } }, "GlobalIpHealthCheckType": { "allOf": [ { "type": "object", "title": "Global IP Health Check Type", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "global_ip_health_check_type" }, "health_check_type": { "type": "string", "description": "Global IP Health check type.", "example": "http_status_2xx" }, "health_check_params": { "type": "object", "description": "Global IP Health check params.", "example": { "health_check_params": { "path": "str", "port": "int" } } } } } ] }, "GlobalIpLatencyMetric": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the metric.", "example": "2020-01-01T00:00:00.000Z" }, "global_ip": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Global IP ID.", "example": "a836125b-20b6-452e-9c03-2653f09c7ed7" }, "ip_address": { "type": "string", "description": "The Global IP address.", "readOnly": true, "example": null } } }, "prober_location": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Location ID.", "example": 1 }, "name": { "type": "string", "description": "Location name.", "example": "Amsterdam" }, "lat": { "type": "number", "description": "Latitude.", "example": 52.370216 }, "lon": { "type": "number", "description": "Longitude.", "example": 4.895168 } } }, "mean_latency": { "type": "object", "properties": { "amount": { "type": "number", "description": "The average latency.", "example": 100 }, "unit": { "type": "string", "description": "The unit of the average latency.", "example": "ms" } } }, "percentile_latency": { "type": "object", "properties": { "0": { "type": "object", "properties": { "amount": { "type": "number", "description": "The minimum latency.", "example": 100 }, "unit": { "type": "string", "description": "The unit of the minimum latency.", "example": "ms" } } }, "25": { "type": "object", "properties": { "amount": { "type": "number", "description": "The 25th percentile latency.", "example": 100 }, "unit": { "type": "string", "description": "The unit of the 25th percentile latency.", "example": "ms" } } }, "50": { "type": "object", "properties": { "amount": { "type": "number", "description": "The 50th percentile latency.", "example": 100 }, "unit": { "type": "string", "description": "The unit of the 50th percentile latency.", "example": "ms" } } }, "75": { "type": "object", "properties": { "amount": { "type": "number", "description": "The 75th percentile latency.", "example": 100 }, "unit": { "type": "string", "description": "The unit of the 75th percentile latency.", "example": "ms" } } }, "90": { "type": "object", "properties": { "amount": { "type": "number", "description": "The 90th percentile latency.", "example": 100 }, "unit": { "type": "string", "description": "The unit of the 90th percentile latency.", "example": "ms" } } }, "99": { "type": "object", "properties": { "amount": { "type": "number", "description": "The 99th percentile latency.", "example": 100 }, "unit": { "type": "string", "description": "The unit of the 99th percentile latency.", "example": "ms" } } }, "100": { "type": "object", "properties": { "amount": { "type": "number", "description": "The maximum latency.", "example": 100 }, "unit": { "type": "string", "description": "The unit of the maximum latency.", "example": "ms" } } } } } } }, "GlobalIpUsageMetric": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the metric.", "example": "2020-01-01T00:00:00.000Z" }, "global_ip": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Global IP ID.", "example": "a836125b-20b6-452e-9c03-2653f09c7ed7" }, "ip_address": { "type": "string", "description": "The Global IP address.", "readOnly": true, "example": "64.1.2.130" } } }, "transmitted": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of data transmitted.", "example": 100000 }, "unit": { "type": "string", "description": "The unit of the amount of data transmitted.", "example": "B" } } }, "received": { "type": "object", "properties": { "amount": { "type": "number", "description": "The amount of data received.", "example": 100000 }, "unit": { "type": "string", "description": "The unit of the amount of data received.", "example": "B" } } } } }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HangupRequest": { "type": "object", "title": "Hangup Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "HostedNumber": { "example": [ { "record_type": "messaging_hosted_number", "id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c", "phone_number": "+18665550001", "status": "successful" } ], "type": "object", "properties": { "record_type": { "type": "string", "example": "messaging_hosted_number" }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource.", "readOnly": true }, "phone_number": { "type": "string", "format": "+E.164", "description": "The messaging hosted phone number (+E.164 format)" }, "status": { "type": "string", "enum": [ "deleted", "failed", "pending", "successful" ] } } }, "Id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "ImmutableSetLong": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "example": "[1234567890L, 9876543210L]", "items": { "type": "integer", "format": "int64" } }, "ImportExternalVetting": { "title": "ImportExternalVetting", "required": [ "evpId", "vettingId" ], "type": "object", "properties": { "evpId": { "title": "Evpid", "maxLength": 10, "type": "string", "description": "External vetting provider ID for the brand." }, "vettingId": { "title": "Vettingid", "type": "string", "description": "Unique ID that identifies a vetting transaction performed by a vetting provider. This ID is provided by the vetting provider at time of vetting." }, "vettingToken": { "title": "Vettingtoken", "type": "string", "description": "Required by some providers for vetting record confirmation." } } }, "InboundFqdn": { "type": "object", "title": "Inbound FQDN", "properties": { "ani_number_format": { "type": "string", "enum": [ "+E.164", "E.164", "+E.164-national", "E.164-national" ], "default": "E.164-national", "description": "This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls." }, "dnis_number_format": { "type": "string", "enum": [ "+e164", "e164", "national", "sip_username" ], "default": "e164" }, "codecs": { "type": "array", "items": { "type": "string" }, "description": "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.", "default": [ "G722", "G711U", "G711A", "G729", "OPUS", "H.264" ] }, "default_routing_method": { "type": "string", "enum": [ "sequential", "round-robin" ], "nullable": true, "default": "sequential", "description": "Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or null, other values are not allowed." }, "default_primary_fqdn_id": { "type": "string", "format": "int64", "nullable": true, "default": null, "description": "The default primary FQDN to use for the number. Only settable if the connection is\nof FQDN type. Value must be the ID of an FQDN set on the connection." }, "default_secondary_fqdn_id": { "type": "string", "format": "int64", "nullable": true, "default": null, "description": "The default secondary FQDN to use for the number. Only settable if the connection is\nof FQDN type. Value must be the ID of an FQDN set on the connection." }, "default_tertiary_fqdn_id": { "type": "string", "format": "int64", "nullable": true, "default": null, "description": "The default tertiary FQDN to use for the number. Only settable if the connection is\nof FQDN type. Value must be the ID of an FQDN set on the connection." }, "channel_limit": { "type": "integer", "default": null, "nullable": true, "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection." }, "generate_ringback_tone": { "type": "boolean", "default": false, "description": "Generate ringback tone through 183 session progress message with early media." }, "isup_headers_enabled": { "type": "boolean", "default": false, "description": "When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)" }, "prack_enabled": { "type": "boolean", "description": "Enable PRACK messages as defined in RFC3262.", "default": false }, "privacy_zone_enabled": { "type": "boolean", "description": "By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.", "default": false }, "sip_compact_headers_enabled": { "type": "boolean", "description": "Defaults to true.", "default": true }, "sip_region": { "type": "string", "default": "US", "description": "Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used.", "enum": [ "US", "Europe", "Australia" ] }, "sip_subdomain": { "type": "string", "default": null, "nullable": true, "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls." }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ], "default": "from_anyone" }, "timeout_1xx_secs": { "type": "integer", "description": "Time(sec) before aborting if connection is not made.", "minimum": 1, "maximum": 120, "default": 3 }, "timeout_2xx_secs": { "type": "integer", "description": "Time(sec) before aborting if call is unanswered (min: 1, max: 600).", "minimum": 1, "maximum": 600, "default": 90 }, "shaken_stir_enabled": { "type": "boolean", "description": "When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.", "default": false } }, "example": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": [ "G722" ], "default_routing_method": "sequential", "default_primary_fqdn_id": "1293384261075731497", "default_secondary_fqdn_id": "1293384261075731498", "default_tertiary_fqdn_id": "1293384261075731499", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "test", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 20, "shaken_stir_enabled": true } }, "InboundIp": { "type": "object", "title": "Inbound Ip", "example": { "ani_number_format": "+E.164", "dns_number_format": "+e164", "codecs": "G722", "default_primary_ip_id": "192.168.0.0", "default_tertiary_ip_id": "192.168.0.0", "default_secondary_ip_id": "192.168.0.0", "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "test", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 20, "shaken_stir_enabled": true }, "properties": { "ani_number_format": { "type": "string", "enum": [ "+E.164", "E.164", "+E.164-national", "E.164-national" ], "default": "E.164-national", "description": "This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls." }, "dnis_number_format": { "type": "string", "enum": [ "+e164", "e164", "national", "sip_username" ], "default": "e164" }, "codecs": { "type": "array", "items": { "type": "string" }, "description": "Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.", "default": [ "G722", "G711U", "G711A", "G729", "OPUS", "H.264" ] }, "default_primary_ip_id": { "type": "string", "description": "The default primary IP to use for the number. Only settable if the connection is\n of IP authentication type. Value must be the ID of an authorized IP set on the connection.", "example": "192.168.0.0" }, "default_secondary_ip_id": { "type": "string", "description": "The default secondary IP to use for the number. Only settable if the connection is\n of IP authentication type. Value must be the ID of an authorized IP set on the connection.", "example": "192.168.0.0" }, "default_tertiary_ip_id": { "type": "string", "description": "The default tertiary IP to use for the number. Only settable if the connection is\n of IP authentication type. Value must be the ID of an authorized IP set on the connection.", "example": "192.168.0.0" }, "default_routing_method": { "type": "string", "enum": [ "sequential", "round-robin" ], "description": "Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed." }, "channel_limit": { "type": "integer", "default": null, "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection.", "example": 10 }, "generate_ringback_tone": { "type": "boolean", "default": false, "description": "Generate ringback tone through 183 session progress message with early media." }, "isup_headers_enabled": { "type": "boolean", "default": false, "description": "When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)" }, "prack_enabled": { "type": "boolean", "description": "Enable PRACK messages as defined in RFC3262.", "default": false }, "privacy_zone_enabled": { "type": "boolean", "description": "By default, Telnyx does not send caller-id information when the caller has chosen to hide this information. When this option is enabled, Telnyx will send the SIP header Privacy:id plus the caller-id information so that the receiver side can choose when to hide it.", "default": false }, "sip_compact_headers_enabled": { "type": "boolean", "description": "Defaults to true.", "default": true }, "sip_region": { "type": "string", "default": "US", "description": "Selects which `sip_region` to receive inbound calls from. If null, the default region (US) will be used.", "enum": [ "US", "Europe", "Australia" ] }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls." }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ] }, "timeout_1xx_secs": { "type": "integer", "description": "Time(sec) before aborting if connection is not made.", "minimum": 1, "maximum": 120, "default": 3 }, "timeout_2xx_secs": { "type": "integer", "description": "Time(sec) before aborting if call is unanswered (min: 1, max: 600).", "default": 90 }, "shaken_stir_enabled": { "type": "boolean", "description": "When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.", "default": false } } }, "InboundMessage": { "type": "object", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource." }, "event_type": { "type": "string", "example": "message.received", "enum": [ "message.received" ], "description": "The type of event being delivered." }, "occurred_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created." }, "payload": { "$ref": "#/components/schemas/InboundMessagePayload" } }, "example": { "record_type": "event", "id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c", "event_type": "message.received", "occurred_at": "date-time", "payload": { "record_type": "message", "direction": "inbound", "id": "7ee4241c-f127-47e5-9c34-3aac291f8058", "type": "SMS", "messaging_profile_id": "0f512bda-ae1e-4597-8e11-e5f5686b97d3", "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950", "from": { "phone_number": "+18665550001", "carrier": "T-MOBILE USA, INC.", "line_type": "Wireless" }, "to": [ { "phone_number": "+18445550001", "status": "delivered", "carrier": "TELNYX LLC", "line_type": "VoIP" } ], "text": "Hello, World!", "subject": "From Telnyx!", "media": [], "webhook_url": "https://www.example.com/hooks", "webhook_failover_url": "https://backup.example.com/hooks", "encoding": "GSM-7", "parts": 1, "tags": [ "Greetings" ], "cost": null, "received_at": "2019-01-23T18:10:02.574Z", "sent_at": null, "completed_at": null, "valid_until": null, "errors": [] } } }, "InboundMessageEvent": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/InboundMessage" } } }, "InboundMessagePayload": { "properties": { "record_type": { "type": "string", "example": "message", "enum": [ "message" ], "description": "Identifies the type of the resource." }, "direction": { "type": "string", "example": "inbound", "enum": [ "inbound" ], "description": "The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you." }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource." }, "type": { "type": "string", "enum": [ "SMS", "MMS" ], "description": "The type of message. This value can be either 'sms' or 'mms'." }, "messaging_profile_id": { "type": "string", "description": "Unique identifier for a messaging profile." }, "to": { "type": "array", "items": { "type": "object", "properties": { "phone_number": { "type": "string", "format": "address", "description": "Receiving address (+E.164 formatted phone number or short code)." }, "status": { "type": "string", "enum": [ "queued", "sending", "sent", "delivered", "sending_failed", "delivery_failed", "delivery_unconfirmed", "webhook_delivered" ] }, "carrier": { "type": "string", "description": "The carrier of the receiver." }, "line_type": { "type": "string", "description": "The line-type of the receiver.", "enum": [ "Wireline", "Wireless", "VoWiFi", "VoIP", "Pre-Paid Wireless", "" ] } } } }, "cc": { "type": "array", "items": { "type": "object", "properties": { "phone_number": { "type": "string", "format": "address", "description": "Receiving address (+E.164 formatted phone number or short code)." }, "status": { "type": "string", "enum": [ "queued", "sending", "sent", "delivered", "sending_failed", "delivery_failed", "delivery_unconfirmed" ] }, "carrier": { "type": "string", "description": "The carrier of the receiver." }, "line_type": { "type": "string", "description": "The line-type of the receiver.", "enum": [ "Wireline", "Wireless", "VoWiFi", "VoIP", "Pre-Paid Wireless", "" ] } } } }, "from": { "type": "object", "properties": { "phone_number": { "type": "string", "format": "address", "description": "Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code)." }, "status": { "type": "string", "enum": [ "received", "delivered" ] }, "carrier": { "type": "string", "description": "The carrier of the sender." }, "line_type": { "type": "string", "description": "The line-type of the sender.", "enum": [ "Wireline", "Wireless", "VoWiFi", "VoIP", "Pre-Paid Wireless", "" ] } } }, "text": { "type": "string", "description": "Message body (i.e., content) as a non-empty string.\n\n**Required for SMS**" }, "media": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "url", "description": "The url of the media requested to be sent." }, "content_type": { "type": "string", "format": "mime-type", "description": "The MIME type of the requested media." }, "size": { "type": "integer", "description": "The size of the requested media." }, "hash_sha256": { "type": "string", "minLength": 32, "maxLength": 32, "description": "The SHA256 hash of the requested media." } } } }, "webhook_url": { "type": "string", "format": "url", "nullable": true, "description": "The URL where webhooks related to this message will be sent." }, "webhook_failover_url": { "type": "string", "format": "url", "nullable": true, "description": "The failover URL where webhooks related to this message will be sent if sending to the primary URL fails." }, "encoding": { "type": "string", "description": "Encoding scheme used for the message body." }, "parts": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Number of parts into which the message's body must be split." }, "tags": { "type": "array", "description": "Tags associated with the resource.", "items": { "type": "string" } }, "cost": { "type": "object", "nullable": true, "properties": { "amount": { "type": "string", "format": "decimal", "description": "The amount deducted from your account." }, "currency": { "type": "string", "format": "iso4217", "description": "The ISO 4217 currency identifier." } } }, "received_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the message request was received." }, "sent_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Not used for inbound messages." }, "completed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Not used for inbound messages." }, "valid_until": { "type": "string", "description": "Not used for inbound messages.", "format": "date-time", "nullable": true }, "errors": { "type": "array", "description": "These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.", "items": { "$ref": "#/components/schemas/Error" } } }, "example": { "record_type": "message", "direction": "inbound", "id": "7ee4241c-f127-47e5-9c34-3aac291f8058", "type": "SMS", "messaging_profile_id": "0f512bda-ae1e-4597-8e11-e5f5686b97d3", "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950", "from": { "phone_number": "+18665550001", "status": "delivered", "carrier": "T-MOBILE USA, INC.", "line_type": "Wireless" }, "to": [ { "phone_number": "+18445550001", "status": "delivered", "carrier": "TELNYX LLC", "line_type": "VoIP" } ], "text": "Hello, World!", "subject": "From Telnyx!", "media": [], "webhook_url": "https://www.example.com/hooks", "webhook_failover_url": "https://backup.example.com/hooks", "encoding": "GSM-7", "parts": 1, "tags": [ "Greetings" ], "cost": null, "received_at": "2019-01-23T18:10:02.574Z", "sent_at": null, "completed_at": null, "valid_until": null, "errors": [] } }, "InferenceRequest": { "properties": { "text": { "items": { "type": "string" }, "type": "array", "title": "Text" }, "model": { "allOf": [ { "$ref": "#/components/schemas/ModelNamespace" } ], "default": "mistralai/Mistral-7B-Instruct-v0.1" }, "bucket": { "type": "string", "title": "Bucket" }, "openai_api_key": { "type": "string", "title": "Openai Api Key" }, "max_tokens": { "type": "integer", "title": "Max Tokens", "default": 128 }, "temperature": { "type": "number", "title": "Temperature", "default": 0.9 } }, "type": "object", "required": [ "text" ], "title": "InferenceRequest" }, "InferenceResponse": { "properties": { "answer": { "items": { "type": "string" }, "type": "array", "title": "Answer" } }, "type": "object", "required": [ "answer" ], "title": "InferenceResponse" }, "InferenceResponseData": { "properties": { "data": { "$ref": "#/components/schemas/InferenceResponse" } }, "type": "object", "required": [ "data" ], "title": "InferenceResponseData" }, "InferenceResponseStreamData": { "properties": { "data": { "$ref": "#/components/schemas/InferenceStreamResponse" } }, "type": "object", "required": [ "data" ], "title": "InferenceResponseStreamData" }, "InferenceStreamResponse": { "properties": { "token": { "type": "string" } }, "type": "object", "title": "InferenceStreamResponse" }, "InitiateCallRequest": { "type": "object", "title": "Initiate Call Request", "required": [ "To", "From", "ApplicationSid" ], "properties": { "ApplicationSid": { "description": "The ID of the TeXML Application.", "type": "string" }, "To": { "description": "The phone number of the called party. Phone numbers are formatted with a `+` and country code.", "example": "+16175551212", "type": "string" }, "From": { "description": "The phone number of the party that initiated the call. Phone numbers are formatted with a `+` and country code.", "example": "+16175551212", "type": "string" }, "Url": { "description": "The URL from which Telnyx will retrieve the TeXML call instructions.", "example": "https://www.example.com/instructions.xml", "type": "string" }, "UrlMethod": { "description": "HTTP request type used for `Url`. The default value is inherited from TeXML Application setting.", "example": "GET", "default": "POST", "type": "string", "enum": [ "GET", "POST" ] }, "FallbackUrl": { "description": "A failover URL for which Telnyx will retrieve the TeXML call instructions if the `Url` is not responding.", "example": "https://www.example.com/instructions-fallback.xml", "type": "string" }, "StatusCallback": { "description": "URL destination for Telnyx to send status callback events to for the call.", "example": "https://www.example.com/callback", "type": "string" }, "StatusCallbackMethod": { "description": "HTTP request type used for `StatusCallback`.", "example": "GET", "default": "POST", "type": "string", "enum": [ "GET", "POST" ] }, "StatusCallbackEvent": { "description": "The call events for which Telnyx should send a webhook. Multiple events can be defined when separated by a space.", "example": "iniated ringing", "default": "completed", "type": "string", "enum": [ "initiated", "ringing", "answered", "completed" ] }, "MachineDetection": { "description": "Enables Answering Machine Detection.", "example": "Enable", "default": "Disable", "type": "string", "enum": [ "Enable", "Disable", "DetectMessageEnd" ] }, "DetectionMode": { "description": "Allows you to chose between Premium and Standard detections.", "example": "Premium", "default": "Regular", "type": "string", "enum": [ "Premium", "Regular" ] }, "AsyncAmd": { "description": "Select whether to perform answering machine detection in the background. By default execution is blocked until Answering Machine Detection is completed.", "example": true, "default": false, "type": "boolean" }, "AsyncAmdStatusCallback": { "description": "URL destination for Telnyx to send AMD callback events to for the call.", "example": "https://www.example.com/callback", "type": "string" }, "AsyncAmdStatusCallbackMethod": { "description": "HTTP request type used for `AsyncAmdStatusCallback`. The default value is inherited from TeXML Application setting.", "example": "GET", "default": "POST", "type": "string", "enum": [ "GET", "POST" ] }, "MachineDetectionTimeout": { "description": "Maximum timeout threshold in milliseconds for overall detection.", "example": 5000, "default": 30000, "maximum": 60000, "minimum": 500, "type": "integer" }, "MachineDetectionSpeechThreshold": { "description": "Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used.", "example": 2000, "default": 3500, "type": "integer" }, "MachineDetectionSpeechEndThreshold": { "description": "Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used.", "example": 2000, "default": 800, "type": "integer" }, "MachineDetectionSilenceTimeout": { "description": "If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used.", "example": 2000, "default": 3500, "type": "integer" }, "CancelPlaybackOnMachineDetection": { "description": "Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.", "default": true, "example": false, "type": "boolean" }, "CancelPlaybackOnDetectMessageEnd": { "description": "Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`.", "default": true, "example": false, "type": "boolean" }, "PreferredCodecs": { "description": "The list of comma-separated codecs to be offered on a call.", "example": "PCMA,PCMU", "type": "string" }, "Record": { "description": "Whether to record the entire participant's call leg. Defaults to `false`.", "example": false, "type": "boolean" }, "RecordingChannels": { "description": "The number of channels in the final recording. Defaults to `mono`.", "example": "dual", "type": "string", "enum": [ "mono", "dual" ] }, "RecordingStatusCallback": { "description": "The URL the recording callbacks will be sent to.", "example": "https://example.com/recording_status_callback", "type": "string" }, "RecordingStatusCallbackMethod": { "description": "HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "RecordingStatusCallbackEvent": { "description": "The changes to the recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.", "example": "in-progress completed absent", "type": "string" }, "RecordingTimeout": { "description": "The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)", "example": 5, "type": "integer", "default": 0 }, "RecordingTrack": { "description": "The audio track to record for the call. The default is `both`.", "example": "inbound", "type": "string", "enum": [ "inbound", "outbound", "both" ] }, "SipAuthPassword": { "description": "The password to use for SIP authentication.", "example": "1234", "type": "string" }, "SipAuthUsername": { "description": "The username to use for SIP authentication.", "example": "user", "type": "string" }, "Trim": { "description": "Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`.", "example": false, "type": "string", "enum": [ "trim-silence", "do-not-trim" ] } }, "example": { "To": "+13121230000", "From": "+13120001234", "Url": "https://www.example.com/texml.xml", "StatusCallback": "https://www.example.com/statuscallback-listener" } }, "InitiateCallResult": { "type": "object", "title": "Initaite TeXML Call Result", "example": { "from": "+13120001234", "to": "+13121230000", "status": "queued" }, "properties": { "from": { "type": "string", "example": "+13120001234" }, "to": { "type": "string", "example": "+13120000000" }, "status": { "type": "string", "example": "accepted" } } }, "IntId": { "type": "string", "format": "int64", "description": "Identifies the resource.", "example": "1293384261075731499", "readOnly": true }, "Interface": { "type": "object", "properties": { "network_id": { "description": "The id of the network associated with the interface.", "type": "string", "format": "uuid", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "name": { "type": "string", "description": "A user specified name for the interface.", "example": "test interface" }, "status": { "$ref": "#/components/schemas/InterfaceStatus" } } }, "InterfaceStatus": { "type": "string", "enum": [ "created", "provisioning", "provisioned", "deleting" ], "description": "The current status of the interface deployment.", "readOnly": true, "example": "provisioned" }, "InventoryCoverage": { "type": "object", "properties": { "group": { "type": "string", "example": "318" }, "group_type": { "type": "string", "example": "npa" }, "number_range": { "type": "integer", "example": 1 }, "number_type": { "type": "string", "enum": [ "did", "toll-free" ], "example": "did" }, "phone_number_type": { "type": "string", "enum": [ "local", "toll_free", "national", "landline", "shared_cost", "mobile" ], "example": "local" }, "coverage_type": { "type": "string", "enum": [ "number", "block" ], "example": "number" }, "record_type": { "type": "string", "example": "inventory_coverage_group" }, "count": { "type": "integer", "example": 3 } }, "example": { "group": "318", "group_type": "npa", "number_range": 1, "number_type": "did", "phone_number_type": "local", "coverage_type": "number", "record_type": "inventory_coverage_group", "count": 3 } }, "InventoryCoverageMetadata": { "type": "object", "example": { "total_results": 25 }, "properties": { "total_results": { "type": "integer", "example": 25 } } }, "Ip": { "type": "object", "title": "Ip", "properties": { "id": { "type": "string", "format": "int64", "description": "Identifies the type of resource.", "example": "1293384261075731499" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "ip" }, "connection_id": { "type": "string", "description": "ID of the IP Connection to which this IP should be attached." }, "ip_address": { "type": "string", "description": "IP adddress represented by this resource.", "example": "192.168.0.0" }, "port": { "type": "integer", "description": "Port to use when connecting to this IP.", "default": 5060, "example": 5060 }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "ip", "connection_id": "3456789987654", "ip_address": "192.168.0.0", "port": 5060, "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z" } }, "IpConnection": { "type": "object", "title": "Ip Connection", "properties": { "id": { "type": "string", "format": "int64", "description": "Identifies the type of resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "ip_connection" }, "active": { "type": "boolean", "description": "Defaults to true", "example": true }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "type": "string", "example": "string" }, "transport_protocol": { "type": "string", "description": "One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.", "default": "UDP", "enum": [ "UDP", "TCP", "TLS" ], "example": "UDP" }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": true, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.", "example": true }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.", "example": true }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.", "example": false }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" }, "inbound": { "$ref": "#/components/schemas/InboundIp" }, "outbound": { "$ref": "#/components/schemas/OutboundIp" } }, "example": { "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "ip_connection", "active": true, "anchorsite_override": "Latency", "connection_name": "string", "transport_protocol": "UDP", "default_on_hold_comfort_noise_enabled": true, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": true, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_secs": 10 }, "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z", "inbound": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": [ "G722" ], "default_primary_ip_id": "192.0.2.1", "default_secondary_ip_id": "198.51.100.1", "default_tertiary_ip_id": "203.0.113.1", "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "string", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 10, "shaken_stir_enabled": true }, "outbound": { "call_parking_enabled": true, "ani_override": "string", "ani_override_type": "always", "channel_limit": 10, "instant_ringback_enabled": true, "generate_ringback_tone": true, "localization": "string", "t38_reinvite_source": "telnyx", "tech_prefix": "string", "ip_authentication_method": "token", "ip_authentication_token": "string", "outbound_voice_profile_id": "1293384261075731499" } } }, "JoinConferenceRequest": { "required": [ "call_control_id" ], "type": "object", "title": "Join Conference Request", "properties": { "call_control_id": { "description": "Unique identifier and token for controlling the call", "example": "v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ==", "type": "string" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. Please note that the client_state will be updated for the participient call leg and the change will not affect conferencing webhooks unless the participient is the owner of the conference.", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "type": "string" }, "command_id": { "description": "Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.", "example": "891510ac-f3e4-11e8-af5b-de00688a4901", "type": "string" }, "end_conference_on_exit": { "description": "Whether the conference should end and all remaining participants be hung up after the participant leaves the conference. Defaults to \"false\".", "example": true, "type": "boolean" }, "soft_end_conference_on_exit": { "description": "Whether the conference should end after the participant leaves the conference. NOTE this doesn't hang up the other participants. Defaults to \"false\".", "example": true, "type": "boolean" }, "hold": { "description": "Whether the participant should be put on hold immediately after joining the conference. Defaults to \"false\".", "example": true, "type": "boolean" }, "hold_audio_url": { "type": "string", "example": "http://example.com/message.wav", "description": "The URL of a file to be played to the participant when they are put on hold after joining the conference. hold_media_name and hold_audio_url cannot be used together in one request. Takes effect only when \"start_conference_on_create\" is set to \"false\". This property takes effect only if \"hold\" is set to \"true\"." }, "hold_media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played to the participant when they are put on hold after joining the conference. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. Takes effect only when \"start_conference_on_create\" is set to \"false\". This property takes effect only if \"hold\" is set to \"true\"." }, "mute": { "description": "Whether the participant should be muted immediately after joining the conference. Defaults to \"false\".", "example": true, "type": "boolean" }, "start_conference_on_enter": { "description": "Whether the conference should be started after the participant joins the conference. Defaults to \"false\".", "example": true, "type": "boolean" }, "supervisor_role": { "description": "Sets the joining participant as a supervisor for the conference. A conference can have multiple supervisors. \"barge\" means the supervisor enters the conference as a normal participant. This is the same as \"none\". \"monitor\" means the supervisor is muted but can hear all participants. \"whisper\" means that only the specified \"whisper_call_control_ids\" can hear the supervisor. Defaults to \"none\".", "example": "whisper", "type": "string", "enum": [ "barge", "monitor", "none", "whisper" ] }, "whisper_call_control_ids": { "description": "Array of unique call_control_ids the joining supervisor can whisper to. If none provided, the supervisor will join the conference as a monitoring participant only.", "example": [ "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ", "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw" ], "type": "array", "items": { "type": "string" } }, "beep_enabled": { "description": "Whether a beep sound should be played when the participant joins and/or leaves the conference. Can be used to override the conference-level setting.", "enum": [ "always", "never", "on_enter", "on_exit" ], "example": "on_exit", "type": "string" } }, "example": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "end_conference_on_exit": true, "hold": true, "hold_audio_url": "http://www.example.com/audio.wav", "mute": true, "start_conference_on_enter": true, "supervisor_role": "whisper", "whisper_call_control_ids": [ "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ", "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw" ], "beep_enabled": "always" } }, "LastModified": { "type": "string", "format": "date-time" }, "LeaveConferenceRequest": { "required": [ "call_control_id" ], "type": "object", "title": "Leave Conference Request", "properties": { "call_control_id": { "description": "Unique identifier and token for controlling the call", "example": "f91269aa-61d1-417f-97b3-10e020e8bc47", "type": "string" }, "command_id": { "description": "Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.", "example": "891510ac-f3e4-11e8-af5b-de00688a4901", "type": "string" }, "beep_enabled": { "description": "Whether a beep sound should be played when the participant leaves the conference. Can be used to override the conference-level setting.", "enum": [ "always", "never", "on_enter", "on_exit" ], "example": "on_exit", "type": "string" } }, "example": { "call_control_id": "c46e06d7-b78f-4b13-96b6-c576af9640ff", "beep_enabled": "never" } }, "LeaveQueueRequest": { "type": "object", "title": "Leave Queue Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "LedgerBillingGroupReport": { "type": "object", "properties": { "record_type": { "type": "string", "example": "ledger_billing_group_report", "enum": [ "ledger_billing_group_report" ], "description": "Identifies the type of the resource." }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource." }, "organization_id": { "type": "string", "format": "uuid", "description": "Uniquely identifies the organization that owns the resource." }, "status": { "type": "string", "format": "string", "enum": [ "pending", "complete", "failed", "deleted" ], "description": "Status of the ledger billing group report" }, "report_url": { "type": "string", "format": "string", "nullable": true, "description": "External url of the ledger billing group report, if the status is complete" }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated." } }, "example": { "record_type": "ledger_billing_group_report", "id": "f5586561-8ff0-4291-a0ac-84fe544797bd", "organization_id": "f5586561-8ff0-4291-a0ac-84fe544797bd", "report_url": "https://example.com", "created_at": "2019-10-15T10:07:15.527Z", "updated_at": "2019-10-15T10:07:15.527Z" } }, "ListBucketsResponse": { "type": "object", "xml": { "name": "ListAllMyBucketsResult" }, "properties": { "Buckets": { "type": "array", "xml": { "wrapped": true }, "items": { "type": "object", "xml": { "name": "Bucket" }, "properties": { "Name": { "type": "string" }, "CreationDate": { "type": "string", "format": "date-time" } } } } } }, "ListObjectsResponse": { "type": "object", "xml": { "name": "ListBucketResult" }, "properties": { "Name": { "type": "string" }, "Contents": { "type": "array", "items": { "type": "object", "properties": { "Key": { "type": "string" }, "Size": { "type": "number" }, "LastModified": { "type": "string", "format": "date-time" } } } } } }, "ListVerificationsResponse": { "title": "ListVerificationsResponse", "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Verification" } }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "ListVerifiedNumbersResponse": { "title": "ListVerifiedNumbersResponse", "description": "A paginated list of Verified Numbers", "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VerifiedNumberResponse" } }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "ListVerifyProfilesResponse": { "title": "ListVerifyProfilesResponse", "description": "A paginated list of Verify profiles", "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyProfileResponse" } }, "meta": { "$ref": "#/components/schemas/Meta" } } }, "Location": { "type": "object", "title": "Location", "properties": { "id": { "$ref": "#/components/schemas/UUID" }, "additional_info": { "type": "string", "example": "Main building, Suite 504" }, "description": { "type": "string", "example": "Chicago Office" }, "is_default": { "type": "boolean", "description": "Represents whether the location is the default or not." } } }, "LocationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "location_id": { "type": "string", "format": "uuid" }, "static_emergency_address_id": { "type": "string", "format": "uuid" }, "accepted_address_suggestions": { "type": "boolean" } } } } }, "LogMessage": { "required": [ "code", "title" ], "type": "object", "properties": { "code": { "type": "string", "format": "integer", "example": "10015" }, "title": { "type": "string", "example": "Invalid attribute" }, "detail": { "type": "string", "example": "The value provided for the attribute is not valid. Check the value used and try again." }, "source": { "type": "object", "properties": { "pointer": { "description": "JSON pointer (RFC6901) to the offending entity.", "type": "string", "format": "json-pointer", "example": "/attribute" } } }, "meta": { "type": "object", "properties": { "telephone_number": { "type": "string", "description": "The telephone number the log message is associated with, if any.", "example": "+12345678" }, "external_connection_id": { "format": "int64", "type": "string", "example": "1293384261075731499", "description": "The external connection the log message is associated with, if any." }, "ticket_id": { "type": "string", "format": "uuid", "example": "542c3bca-d247-42bc-8fe7-e01d16ecd761", "description": "The ticket ID for an operation that generated the log message, if any." } } } } }, "Loopcount": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "ManagedAccount": { "type": "object", "title": "ManagedAccount", "required": [ "record_type", "id", "email", "api_key", "api_user", "api_token", "manager_account_id", "created_at", "updated_at" ], "properties": { "record_type": { "type": "string", "example": "managed_account", "enum": [ "managed_account" ], "description": "Identifies the type of the resource." }, "id": { "type": "string", "format": "UUID", "description": "Uniquely identifies the managed account.", "example": "f65ceda4-6522-4ad6-aede-98de83385123" }, "email": { "type": "string", "format": "email", "description": "The managed account's email.", "example": "user@example.com" }, "api_key": { "type": "string", "description": "The managed account's V2 API access key", "example": "KEY01236170692E74656C6E79782E636F6D_YmlnIGlyb24gaXMgZGVhZA" }, "api_user": { "type": "string", "description": "The manager account's email, which serves as the V1 API user identifier", "example": "managed_account@example.com" }, "api_token": { "type": "string", "description": "The managed account's V1 API token", "example": "x6oexQNHTs-fZ7-QsDMOeg" }, "organization_name": { "type": "string", "description": "The organization the managed account is associated with.", "example": "Example Company LLC" }, "manager_account_id": { "type": "string", "description": "The ID of the manager account associated with the managed account.", "example": "f65ceda4-6522-4ad6-aede-98de83385123" }, "balance": { "$ref": "#/components/schemas/ManagedAccountBalance" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" }, "managed_account_allow_custom_pricing": { "type": "boolean", "description": "Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect.", "example": true }, "rollup_billing": { "type": "boolean", "description": "Boolean value that indicates if the billing information and charges to the managed account \"roll up\" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false.", "example": false } } }, "ManagedAccountBalance": { "type": "object", "properties": { "record_type": { "type": "string", "example": "balance", "enum": [ "balance" ], "description": "Identifies the type of the resource." }, "balance": { "type": "string", "format": "decimal", "description": "The account's current balance.", "example": "300.00" }, "credit_limit": { "type": "string", "format": "decimal", "description": "The account's credit limit.", "example": "100.00" }, "available_credit": { "type": "string", "format": "decimal", "description": "Available amount to spend (balance + credit limit)", "example": "400.00" }, "currency": { "type": "string", "format": "iso4217", "description": "The ISO 4217 currency identifier.", "example": "USD" } }, "example": { "record_type": "balance", "balance": "300.00", "credit_limit": "100.00", "available_credit": "400.00", "currency": "USD" } }, "ManagedAccountMultiListing": { "type": "object", "title": "ManagedAccount", "required": [ "record_type", "id", "email", "api_user", "manager_account_id", "created_at", "updated_at" ], "properties": { "record_type": { "type": "string", "example": "managed_account", "enum": [ "managed_account" ], "description": "Identifies the type of the resource." }, "id": { "type": "string", "format": "UUID", "description": "Uniquely identifies the managed account.", "example": "f65ceda4-6522-4ad6-aede-98de83385123" }, "email": { "type": "string", "format": "email", "description": "The managed account's email.", "example": "user@example.com" }, "api_user": { "type": "string", "description": "The manager account's email, which serves as the V1 API user identifier", "example": "managed_account@example.com" }, "organization_name": { "type": "string", "description": "The organization the managed account is associated with.", "example": "Example Company LLC" }, "manager_account_id": { "type": "string", "description": "The ID of the manager account associated with the managed account.", "example": "f65ceda4-6522-4ad6-aede-98de83385123" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" }, "managed_account_allow_custom_pricing": { "type": "boolean", "description": "Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect.", "example": true }, "rollup_billing": { "type": "boolean", "description": "Boolean value that indicates if the billing information and charges to the managed account \"roll up\" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false.", "example": false } } }, "ManagedAccountsGlobalOutboundChannels": { "title": "Managed Accounts Global Outbound Channels", "properties": { "managed_account_allow_custom_pricing": { "type": "boolean", "description": "Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed, but there may be time lag between when the value is changed and pricing changes take effect.", "example": false }, "allocatable_global_outbound_channels": { "type": "integer", "description": "The total amount of allocatable global outbound channels available to the authenticated manager. Will be 0 if the feature is not enabled for their account.", "example": 500 }, "record_type": { "type": "string", "description": "The type of the data contained in this record.", "example": "allocatable_global_outbound_channels" }, "total_global_channels_allocated": { "type": "integer", "description": "The total number of allocatable global outbound channels currently allocated across all managed accounts for the authenticated user. This includes any amount of channels allocated by default at managed account creation time. Will be 0 if the feature is not enabled for their account.", "example": 135 } }, "example": { "allocatable_global_outbound_channels": 500, "record_type": "allocatable_global_outbound_channels", "total_global_channels_allocated": 135 } }, "MdrDeleteDetailReportResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MdrDetailReportResponse" } } }, "MdrDeleteUsageReportsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MdrUsageReportResponse" } } }, "MdrDetailReportResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifies the resource", "format": "uuid" }, "start_date": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "end_date": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] } }, "record_types": { "type": "array", "items": { "type": "string", "enum": [ "INCOMPLETE", "COMPLETED", "ERRORS" ] } }, "connections": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "report_name": { "type": "string", "example": "report_name_8hvb45Gu" }, "status": { "type": "string", "enum": [ "PENDING", "COMPLETE", "FAILED", "EXPIRED" ] }, "report_url": { "type": "string", "example": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/Filter" } }, "created_at": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "profiles": { "type": "string", "example": "My profile" }, "record_type": { "type": "string", "example": "mdr_report" } } }, "MdrDetailResponse": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Message sent time", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "profile_name": { "type": "string", "description": "Configured profile name. New profiles can be created and configured on Telnyx portal", "example": "configured-profile-name" }, "direction": { "type": "string", "description": "Direction of message - inbound or outbound.", "example": "outbound" }, "parts": { "type": "number", "description": "Number of parts this message has. Max number of character is 160. If message contains more characters then that it will be broken down in multiple parts", "example": 2 }, "status": { "type": "string", "description": "Message status", "example": "DELIVERED", "enum": [ "GW_TIMEOUT", "DELIVERED", "DLR_UNCONFIRMED", "DLR_TIMEOUT", "RECEIVED", "GW_REJECT", "FAILED" ] }, "cld": { "type": "string", "description": "The destination number for a call, or the callee", "example": "+1555123456" }, "cli": { "type": "string", "description": "The number associated with the person initiating the call, or the caller", "example": "+1555123456" }, "rate": { "type": "string", "description": "Rate applied to the message", "example": "0.05" }, "cost": { "type": "string", "description": "Final cost. Cost is calculated as rate * parts", "example": "0.1" }, "currency": { "type": "string", "description": "Currency of the rate and cost", "example": "USD", "enum": [ "AUD", "CAD", "EUR", "GBP", "USD" ] }, "id": { "type": "string", "description": "Id of message detail record", "example": "99b637f3-07fd-45ac-b9ca-b87208c24650" }, "message_type": { "type": "string", "description": "Type of message", "example": "SMS", "enum": [ "SMS", "MMS" ] }, "record_type": { "type": "string", "example": "mdr_report" } } }, "MdrGetDetailReportByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MdrDetailReportResponse" } } }, "MdrGetDetailReportResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MdrDetailReportResponse" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "MdrGetDetailResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MdrDetailResponse" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "MdrGetSyncUsageReportResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MdrUsageReportResponse" } } }, "MdrGetUsageReportsByIdResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MdrUsageReportResponse" } } }, "MdrGetUsageReportsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MdrUsageReportResponse" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } }, "MdrPostDetailReportRequest": { "required": [ "end_date", "start_date" ], "type": "object", "properties": { "start_date": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "end_date": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "directions": { "type": "array", "items": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] } }, "record_types": { "type": "array", "items": { "type": "string", "enum": [ "INCOMPLETE", "COMPLETED", "ERRORS" ] } }, "connections": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "report_name": { "type": "string" }, "include_message_body": { "type": "boolean", "example": true }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/Filter" } }, "profiles": { "type": "string", "example": "My profile" } } }, "MdrPostDetailReportResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MdrDetailReportResponse" } } }, "MdrPostUsageReportRequest": { "required": [ "aggregation_type", "end_date", "start_date" ], "type": "object", "properties": { "start_date": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "end_date": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "aggregation_type": { "type": "string", "enum": [ "NO_AGGREGATION", "PROFILE", "TAGS" ] }, "profiles": { "type": "string", "example": "My profile" } } }, "MdrPostUsageReportsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MdrUsageReportResponse" } } }, "MdrUsageRecord": { "type": "object", "properties": { "cost": { "type": "string", "example": "0" }, "direction": { "type": "string", "example": "outbound" }, "product": { "type": "string", "example": "outbound" }, "connection": { "type": "string", "example": "all" }, "received": { "type": "string", "example": "0" }, "delivered": { "type": "string", "example": "0" }, "currency": { "type": "string", "example": "USD" }, "parts": { "type": "string", "example": "0" }, "sent": { "type": "string", "example": "0" }, "profile_id": { "type": "string", "example": "All" }, "tags": { "type": "string", "example": "All" }, "message_type": { "type": "string", "example": "SMS" }, "tn_type": { "type": "string", "example": "TF" }, "carrier_passthrough_fee": { "type": "string", "example": "0" } } }, "MdrUsageReportResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifies the resource", "format": "uuid" }, "start_date": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "end_date": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "connections": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "aggregation_type": { "type": "string", "enum": [ "NO_AGGREGATION", "PROFILE", "TAGS" ] }, "status": { "type": "string", "enum": [ "PENDING", "COMPLETE", "FAILED", "EXPIRED" ] }, "report_url": { "type": "string", "example": "http://portal.telnyx.com/downloads/report_name_8hvb45Gu.csv" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/MdrUsageRecord" } }, "created_at": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2020-07-01T00:00:00-06:00" }, "profiles": { "type": "string", "example": "My profile" }, "record_type": { "type": "string", "example": "mdr_usage_report" } } }, "MediaFeatures": { "description": "The media features settings for a phone number.", "type": "object", "properties": { "rtp_auto_adjust_enabled": { "type": "boolean", "default": true, "description": "When RTP Auto-Adjust is enabled, the destination RTP address port will be automatically changed to match the source of the incoming RTP packets." }, "accept_any_rtp_packets_enabled": { "type": "boolean", "default": false, "description": "When enabled, Telnyx will accept RTP packets from any customer-side IP address and port, not just those to which Telnyx is sending RTP." }, "t38_fax_gateway_enabled": { "type": "boolean", "default": false, "description": "Controls whether Telnyx will accept a T.38 re-INVITE for this phone number. Note that Telnyx will not send a T.38 re-INVITE; this option only controls whether one will be accepted." } }, "example": { "rtp_auto_adjust_enabled": true, "accept_any_rtp_packets_enabled": true, "t38_fax_gateway_enabled": true } }, "MediaName": { "description": "The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. media_name and media_url/contents can't be submitted together.", "type": "string", "example": "my_media_uploaded_to_media_storage_api" }, "MediaResource": { "type": "object", "title": "Media Resource", "properties": { "media_name": { "description": "Uniquely identifies a media resource.", "type": "string" }, "expires_at": { "description": "ISO 8601 formatted date of when the media resource will expire and be deleted.", "type": "string", "example": "2020-01-23T18:10:02.574Z" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the media resource was created", "example": "2019-01-23T18:10:02.574Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the media resource was last updated", "example": "2019-01-23T18:10:02.574Z" }, "content_type": { "type": "string", "description": "Content type of the file", "example": "application/xml" } }, "example": { "media_name": "f5586561-8ff0-4291-a0ac-84fe544797bd", "expires_at": "2020-01-23T18:10:02.574Z", "created_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z", "content_type": "application/xml" } }, "MediaStorageDetailRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the Media Storage Event", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "created_at": { "type": "string", "description": "Event creation time", "format": "date-time", "example": "2020-07-01T00:00:00Z" }, "asset_id": { "type": "string", "description": "Asset id", "example": "a46f4764-4ce4-4391-804c-02f00bc4ff9b" }, "user_id": { "type": "string", "description": "User id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "org_id": { "type": "string", "description": "Organization owner id", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "action_type": { "type": "string", "description": "Type of action performed against the Media Storage API", "example": "upload" }, "link_channel_type": { "type": "string", "description": "Link channel type", "example": "message" }, "link_channel_id": { "type": "string", "description": "Link channel id", "example": "2065f482-64b9-4680-a3a9-c6d3142efdf7" }, "status": { "type": "string", "description": "Request status", "example": "failed" }, "webhook_id": { "type": "string", "description": "Webhook id", "example": "b46f4764-4ce4-4391-804c-02f00bc4ff9b" }, "rate": { "type": "string", "description": "Currency amount per billing unit used to calculate the Telnyx billing cost", "example": "0.0001" }, "rate_measured_in": { "type": "string", "description": "Billing unit used to calculate the Telnyx billing cost", "example": "events" }, "cost": { "type": "string", "description": "Currency amount for Telnyx billing cost", "example": "0.004" }, "currency": { "type": "string", "description": "Telnyx account currency used to describe monetary values, including billing cost", "example": "USD" }, "record_type": { "type": "string", "example": "media_storage", "default": "media_storage" } }, "required": [ "record_type" ] }, "MediaUrl": { "description": "The URL to the PDF used for the fax's media. media_url and media_name/contents can't be submitted together.", "type": "string", "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf" }, "MessageDetailRecord": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier of the message", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "user_id": { "type": "string", "description": "Identifier of the Telnyx account who owns the message", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "completed_at": { "type": "string", "description": "Message completion time", "format": "date-time", "example": "2020-07-01T00:00:00Z" }, "created_at": { "type": "string", "description": "Message creation time", "format": "date-time", "example": "2020-07-01T00:00:00Z" }, "updated_at": { "type": "string", "description": "Message updated time", "format": "date-time", "example": "2020-07-01T00:00:00Z" }, "sent_at": { "type": "string", "description": "Time when the message was sent", "format": "date-time", "example": "2020-07-01T00:00:00Z" }, "carrier": { "type": "string", "description": "Country-specific carrier used to send or receive the message", "example": "T-Mobile USA" }, "carrier_fee": { "type": "string", "description": "Fee charged by certain carriers in order to deliver certain message types. Telnyx passes this fee on to the customer according to our pricing table", "example": "0.003" }, "cld": { "type": "string", "description": "The recipient of the message (to parameter in the Messaging API)", "example": "+1555123456" }, "cli": { "type": "string", "description": "The sender of the message (from parameter in the Messaging API). For Alphanumeric ID messages, this is the sender ID value", "example": "+1555123456" }, "country_code": { "type": "string", "description": "Two-letter representation of the country of the cld property using the ISO 3166-1 alpha-2 format", "example": "US" }, "delivery_status": { "type": "string", "description": "Final webhook delivery status", "example": "success: webhook succeeded" }, "delivery_status_failover_url": { "type": "string", "description": "Failover customer-provided URL which Telnyx posts delivery status webhooks to", "example": "https://api.example.com/sms/telnyx/inbound" }, "delivery_status_webhook_url": { "type": "string", "description": "Primary customer-provided URL which Telnyx posts delivery status webhooks to", "example": "https://api.example.com/sms/telnyx/inbound" }, "direction": { "type": "string", "description": "Logical direction of the message from the Telnyx customer's perspective. It's inbound when the Telnyx customer receives the message, or outbound otherwise", "example": "outbound", "enum": [ "inbound", "outbound" ] }, "fteu": { "type": "boolean", "description": "Indicates whether this is a Free-To-End-User (FTEU) short code message", "example": false }, "mcc": { "type": "string", "description": "Mobile country code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID", "example": "204" }, "mnc": { "type": "string", "description": "Mobile network code. Only available for certain products, such as Global Outbound-Only from Alphanumeric Sender ID", "example": "01" }, "message_type": { "type": "string", "description": "Describes the Messaging service used to send the message. Available services are: Short Message Service (SMS), Multimedia Messaging Service (MMS), and Rich Communication Services (RCS)", "example": "SMS", "enum": [ "SMS", "MMS", "RCS" ] }, "on_net": { "type": "boolean", "description": "Indicates whether both sender and recipient numbers are Telnyx-managed", "example": true }, "profile_id": { "type": "string", "description": "Unique identifier of the Messaging Profile used to send or receive the message", "example": "30ef55db-c4a2-4c4a-9804-a68077973d07" }, "profile_name": { "type": "string", "description": "Name of the Messaging Profile used to send or receive the message", "example": "My Messaging Profile" }, "source_country_code": { "type": "string", "description": "Two-letter representation of the country of the cli property using the ISO 3166-1 alpha-2 format", "example": "US" }, "status": { "type": "string", "description": "Final status of the message after the delivery attempt", "example": "delivered", "enum": [ "gw_timeout", "delivered", "dlr_unconfirmed", "dlr_timeout", "received", "gw_reject", "failed" ] }, "tags": { "type": "string", "description": "Comma-separated tags assigned to the Telnyx number associated with the message", "example": "tag1,tag2,tag3" }, "rate": { "type": "string", "description": "Currency amount per billing unit used to calculate the Telnyx billing cost", "example": "0.003" }, "currency": { "type": "string", "description": "Telnyx account currency used to describe monetary values, including billing cost", "example": "USD" }, "cost": { "type": "string", "description": "Amount, in the user currency, for the Telnyx billing cost", "example": "0.003" }, "errors": { "type": "array", "description": "Telnyx API error codes returned by the Telnyx gateway", "items": { "type": "string", "example": "40001" } }, "parts": { "type": "integer", "description": "Number of message parts. The message is broken down in multiple parts when its length surpasses the limit of 160 characters", "example": 2 }, "record_type": { "type": "string", "description": "Identifies the record schema", "example": "message_detail_record", "default": "message_detail_record" } }, "required": [ "record_type" ] }, "MessagingFeatureSet": { "type": "object", "nullable": true, "required": [ "domestic_two_way", "international_inbound", "international_outbound" ], "description": "The set of features available for a specific messaging use case (SMS or MMS). Features\ncan vary depending on the characteristics the phone number, as well as its current\nproduct configuration.\n", "properties": { "domestic_two_way": { "type": "boolean", "description": "Send messages to and receive messages from numbers in the same country." }, "international_inbound": { "type": "boolean", "description": "Receive messages from numbers in other countries." }, "international_outbound": { "type": "boolean", "description": "Send messages to numbers in other countries." } }, "example": { "domestic_two_way": true, "international_inbound": false, "international_outbound": true } }, "MessagingHostedNumberOrder": { "type": "object", "example": { "id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323", "record_type": "messaging_hosted_number_order", "messaging_profile_id": "dc8f39ac-953d-4520-b93b-786ae87db0da", "status": "pending", "phone_numbers": [ { "record_type": "messaging_hosted_number", "id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c", "phone_number": "+18665550001", "status": "pending" }, { "record_type": "messaging_hosted_number", "id": "464bd54e-a328-4b11-a131-28e6793cb6f2", "phone_number": "+18665550002", "status": "pending" } ] }, "properties": { "record_type": { "type": "string", "example": "messaging_hosted_number_order", "description": "Identifies the type of the resource.", "readOnly": true }, "id": { "type": "string", "format": "uuid", "description": "Resource unique identifier.", "readOnly": true }, "messaging_profile_id": { "type": "string", "nullable": true, "description": "Automatically associate the number with this messaging profile ID when the order is complete." }, "status": { "type": "string", "enum": [ "failed", "pending", "successful" ] }, "phone_numbers": { "type": "array", "items": { "$ref": "#/components/schemas/HostedNumber" } } } }, "MessagingProfile": { "type": "object", "properties": { "record_type": { "description": "Identifies the type of the resource.", "type": "string", "enum": [ "messaging_profile" ], "readOnly": true }, "id": { "description": "Identifies the type of resource.", "type": "string", "format": "uuid", "readOnly": true }, "name": { "description": "A user friendly name for the messaging profile.", "type": "string" }, "enabled": { "description": "Specifies whether the messaging profile is enabled or not.", "type": "boolean" }, "webhook_url": { "description": "The URL where webhooks related to this messaging profile will be sent.", "type": "string", "format": "url", "nullable": true }, "webhook_failover_url": { "description": "The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.", "type": "string", "format": "url", "nullable": true }, "webhook_api_version": { "description": "Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.", "type": "string", "enum": [ "1", "2", "2010-04-01" ] }, "whitelisted_destinations": { "description": "Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `[\"*\"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes.", "type": "array", "nullable": true, "items": { "description": "ISO 3166-1 alpha-2 country code.", "type": "string", "pattern": "^[A-Z]{2}$" } }, "created_at": { "description": "ISO 8601 formatted date indicating when the resource was created.", "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "description": "ISO 8601 formatted date indicating when the resource was updated.", "type": "string", "format": "date-time", "readOnly": true }, "v1_secret": { "description": "Secret used to authenticate with v1 endpoints.", "type": "string" }, "number_pool_settings": { "$ref": "#/components/schemas/NumberPoolSettings" }, "url_shortener_settings": { "$ref": "#/components/schemas/UrlShortenerSettings" }, "alpha_sender": { "description": "The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.", "type": "string", "pattern": "^[A-Za-z0-9 ]{1,11}$", "nullable": true } }, "example": { "record_type": "messaging_profile", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Profile for Messages", "webhook_url": "https://www.example.com/hooks", "webhook_failover_url": "https://backup.example.com/hooks", "enabled": true, "webhook_api_version": "2", "whitelisted_destinations": [ "US" ], "created_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z", "number_pool_settings": { "toll_free_weight": 10, "long_code_weight": 2, "skip_unhealthy": false, "sticky_sender": true, "geomatch": false }, "url_shortener_settings": { "domain": "example.ex", "prefix": "cmpny", "replace_blacklist_only": true, "send_webhooks": false }, "v1_secret": "rP1VamejkU2v0qIUxntqLW2c" } }, "MessagingProfileDetailedMetric": { "type": "object", "properties": { "timestamp": { "type": "string", "description": "The timestamp of the aggregated data.", "example": "2019-01-23T18:10:02.574Z", "readOnly": true }, "metrics": { "type": "array", "items": { "$ref": "#/components/schemas/MessagingProfileMessageTypeMetrics" } } } }, "MessagingProfileDetailedMetrics": { "type": "object", "properties": { "overview": { "$ref": "#/components/schemas/MessagingProfileHighLevelMetrics" }, "detailed": { "type": "array", "items": { "$ref": "#/components/schemas/MessagingProfileDetailedMetric" } } }, "example": { "detailed": [ { "metrics": [ { "label": "longcode", "sent": 1000, "delivered": 990, "errors": 0.01, "received": 750 } ], "timestamp": "2019-01-23T18:10:02.574Z" } ], "overview": { "record_type": "messaging_profile_metrics", "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "phone_numbers": 250, "outbound": { "sent": 1000, "delivered": 990, "errors": 0.01 }, "inbound": { "received": 850 } } } }, "MessagingProfileHighLevelMetrics": { "type": "object", "example": { "record_type": "messaging_profile_metrics", "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "phone_numbers": 250, "outbound": { "sent": 1000, "delivered": 990, "errors": 0.01 }, "inbound": { "received": 850 } }, "properties": { "record_type": { "type": "string", "example": "messaging_profile_metrics", "enum": [ "messaging_profile_metrics" ], "description": "Identifies the type of the resource.", "readOnly": true }, "messaging_profile_id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource.", "readOnly": true }, "phone_numbers": { "type": "number", "description": "The number of phone numbers associated with the messaging profile.", "readOnly": true }, "outbound": { "type": "object", "properties": { "sent": { "type": "number", "description": "The number of outbound messages sent.", "readOnly": true }, "delivered": { "type": "number", "description": "The number of outbound messages successfully delivered.", "readOnly": true }, "error_ratio": { "type": "number", "description": "The ratio of messages sent that resulted in errors.", "readOnly": true } } }, "inbound": { "type": "object", "properties": { "received": { "type": "number", "description": "The number of inbound messages received.", "readOnly": true } } } } }, "MessagingProfileMessageTypeMetrics": { "type": "object", "example": { "label": "longcode", "sent": 1000, "delivered": 990, "errors": 0.01, "received": 750 }, "properties": { "label": { "type": "string", "description": "The metric type.", "readOnly": true }, "sent": { "type": "number", "description": "The number of outbound messages sent.", "readOnly": true }, "delivered": { "type": "number", "description": "The number of outbound messages successfully delivered.", "readOnly": true }, "outbound_error_ratio": { "type": "number", "description": "The ratio of outbound messages sent that resulted in errors.", "readOnly": true }, "received": { "type": "number", "description": "The number of inbound messages received.", "readOnly": true } } }, "MessagingUrlDomain": { "type": "object", "properties": { "record_type": { "type": "string" }, "id": { "type": "string" }, "url_domain": { "type": "string" }, "use_case": { "type": "string" } }, "example": { "record_type": "messaging_url_domain", "id": "464bd54e-a328-4b11-a131-28e6793cb6f2", "url_domain": "http://example.com", "use_case": "test" } }, "Meta": { "type": "object", "properties": { "total_pages": { "type": "integer", "example": 3 }, "total_results": { "type": "integer", "example": 55 }, "page_number": { "type": "integer", "example": 2 }, "page_size": { "type": "integer", "example": 25 } } }, "Metadata": { "type": "object", "title": "Metadata", "properties": { "total_pages": { "type": "number", "description": "Total number of pages based on pagination settings", "example": 13, "format": "double" }, "total_results": { "type": "number", "description": "Total number of results", "example": 13, "format": "double" }, "page_number": { "type": "number", "description": "Current Page based on pagination settings (included when defaults are used.)", "example": 3, "format": "double" }, "page_size": { "type": "number", "description": "Number of results to return per page based on pagination settings (included when defaults are used.)", "example": 1, "format": "double" } } }, "Mno": { "title": "Mno", "required": [ "networkId", "displayName", "osrBitmaskIndex" ], "type": "object", "properties": { "networkId": { "title": "Networkid", "minimum": 10000, "type": "integer", "description": "Unique network identifier assigned to MNO." }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display name of the mobile network operator." }, "osrBitmaskIndex": { "title": "Osrbitmaskindex", "maximum": 32, "minimum": 1, "type": "integer", "description": "NetNumber OSR 'campaign_id' property's 'status' attribute holds individual MNO campaign operation status. The 'status' attribute leverages bitmasking technique to store multiple MNOs' operating status. The campaign operation status is reduced to '1' or '0' value where '1' indicate an 'ACTIVE' status and '0' represents every other non-active statuses, including REVIEW, REJECT and SUSPEND. The 'osrBitmaskIndex' holds the bitmask index of the MNO. For example, T-Mobile's bitmask index is 2, which implies T-Mobile's campaign operation status is stored in bit #2, or 3rd bit when counting from right." } } }, "MobileNetworkOperator": { "type": "object", "title": "MobileNetworkOperator", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "mobile_network_operator" }, "name": { "description": "The network operator name.", "type": "string", "example": "AT&T Mobility (USACG)" }, "tadig": { "type": "string", "description": "TADIG stands for Transferred Account Data Interchange Group. The TADIG code is a unique identifier for network operators in GSM mobile networks.", "example": "USACG" }, "country_code": { "type": "string", "description": "The mobile operator two-character (ISO 3166-1 alpha-2) origin country code.", "example": "US" }, "mcc": { "type": "string", "description": "MCC stands for Mobile Country Code. It's a three decimal digit that identifies a country.

\nThis code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.", "example": "310" }, "mnc": { "type": "string", "description": "MNC stands for Mobile Network Code. It's a two to three decimal digits that identify a network.

\n This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.", "example": "410" }, "network_preferences_enabled": { "type": "boolean", "description": "Indicate whether the mobile network operator can be set as preferred in the Network Preferences API.", "readOnly": true, "example": true } } }, "MobileNetworkOperatorPreferencesRequest": { "description": "", "type": "object", "properties": { "mobile_network_operator_id": { "type": "string", "format": "uuid", "description": "The mobile network operator resource identification UUID.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "priority": { "type": "integer", "description": "It determines what is the priority of a specific network operator that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.", "example": 0 } } }, "MobileNetworkOperatorPreferencesResponse": { "description": "", "type": "object", "properties": { "mobile_network_operator_id": { "type": "string", "format": "uuid", "description": "The mobile network operator resource identification UUID.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "mobile_network_operator_name": { "type": "string", "description": "The mobile network operator resource name.", "example": "AT&T Mobility (USACG)" }, "priority": { "type": "integer", "description": "It determines what is the priority of a specific network operator that should be assumed by a SIM card when connecting to a network. The highest priority is 0, the second highest is 1 and so on.", "example": 0 } } }, "MobileNetworkOperatorsPreferencesRequest": { "type": "array", "description": "A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.", "items": { "$ref": "#/components/schemas/MobileNetworkOperatorPreferencesRequest" } }, "MobileNetworkOperatorsPreferencesResponse": { "type": "array", "description": "A list of mobile network operators and the priority that should be applied when the SIM is connecting to the network.", "items": { "$ref": "#/components/schemas/MobileNetworkOperatorPreferencesResponse" } }, "ModelNamespace": { "type": "string", "enum": [ "meta-llama/Llama-2-13b-chat-hf", "mistralai/Mistral-7B-Instruct-v0.1", "Trelis/Llama-2-7b-chat-hf-function-calling-v2", "openai/gpt-3.5-turbo", "openai/gpt-3.5-turbo-16k", "openai/gpt-4", "openai/gpt-4-32k" ], "title": "ModelNamespace", "description": "Provide a namespace to our supported models." }, "Monochrome": { "description": "The flag to enable monochrome, true black and white fax results.", "type": "boolean", "default": false }, "Network": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "type": "object", "title": "Network", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "network" }, "name": { "type": "string", "description": "A user specified name for the network.", "example": "test network" } } } ] }, "NetworkCreate": { "allOf": [ { "$ref": "#/components/schemas/Network" }, { "type": "object", "title": "NetworkCreate", "required": [ "name" ] } ] }, "NetworkInterface": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "$ref": "#/components/schemas/Interface" }, { "$ref": "#/components/schemas/RegionOut" }, { "type": "object", "title": "NetworkInterface", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "network_interface" }, "type": { "type": "string", "description": "Identifies the type of the interface.", "readOnly": true, "example": "wireguard_interface" } } } ] }, "NewBillingGroup": { "properties": { "name": { "type": "string", "description": "A name for the billing group" } }, "example": { "name": "string" } }, "NewLedgerBillingGroupReport": { "properties": { "year": { "type": "integer", "example": 2019, "description": "Year of the ledger billing group report" }, "month": { "type": "integer", "example": 10, "description": "Month of the ledger billing group report" } }, "example": { "year": 2019, "month": 10 } }, "NewParticipantResource": { "type": "object", "title": "New participant resource", "example": { "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6", "call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ", "coaching": false, "coaching_call_sid": null, "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1", "end_conference_on_exit": false, "hold": false, "muted": false, "status": "completed", "uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json" }, "properties": { "account_sid": { "type": "string", "description": "The id of the account the resource belongs to.", "example": "61bf923e-5e4d-4595-a110-56190ea18a1b" }, "call_sid": { "type": "string", "description": "The identifier of this participant's call.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ" }, "coaching": { "type": "boolean", "description": "Whether the participant is coaching another call.", "example": false }, "coaching_call_sid": { "type": "string", "description": "The identifier of the coached participant's call.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ" }, "end_conference_on_exit": { "type": "boolean", "description": "Whether the conference ends when the participant leaves.", "example": false }, "hold": { "type": "boolean", "description": "Whether the participant is on hold.", "example": false }, "muted": { "type": "boolean", "description": "Whether the participant is muted.", "example": false }, "status": { "type": "string", "description": "The status of the participant's call in the conference.", "enum": [ "connecting", "connected", "completed" ], "example": "in-progress" }, "uri": { "type": "string", "description": "The relative URI for this participant.", "example": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json" } } }, "NoiseSuppressionDirection": { "type": "string", "title": "Noise Suppression Direction", "description": "The direction of the audio stream to be noise suppressed.", "enum": [ "inbound", "outbound", "both" ], "default": "inbound", "example": "outbound" }, "NoiseSuppressionStart": { "type": "object", "title": "Noise Suppression Start Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "direction": { "$ref": "#/components/schemas/NoiseSuppressionDirection" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "direction": "both" } }, "NoiseSuppressionStop": { "type": "object", "title": "Noise Suppression Stop Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "NotFoundError": { "properties": { "code": { "type": "string", "title": "Telnyx error code" }, "detail": { "type": "string", "title": "Error details" }, "title": { "type": "string", "title": "Error title" } }, "type": "object", "required": [ "detail" ], "title": "NotFoundError" }, "NotificationChannel": { "description": "A Notification Channel", "properties": { "id": { "type": "string", "description": "A UUID.", "readOnly": true, "example": "12455643-3cf1-4683-ad23-1cd32f7d5e0a" }, "notification_profile_id": { "type": "string", "description": "A UUID reference to the associated Notification Profile.", "example": "12455643-3cf1-4683-ad23-1cd32f7d5e0a" }, "channel_type_id": { "type": "string", "description": "A Channel Type ID", "enum": [ "sms", "voice", "email", "webhook" ] }, "channel_destination": { "type": "string", "description": "The destination associated with the channel type.", "example": "+13125550000" }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2019-10-15T10:07:15.527Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2019-10-15T10:07:15.527Z", "readOnly": true } } }, "NotificationEvent": { "description": "An object representing the available notifications.", "properties": { "id": { "type": "string", "description": "A UUID.", "readOnly": true, "example": "d5c395cd-9864-4609-b5e2-3f9fd4ce201a" }, "name": { "type": "string", "description": "A human readable name.", "example": "Emergency Number Dialed" }, "notification_category": { "type": "string", "example": "Calls" }, "enabled": { "type": "boolean", "example": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2019-10-15T10:07:15.527Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2019-10-15T10:07:15.527Z" } } }, "NotificationEventCondition": { "properties": { "id": { "type": "string", "description": "A UUID.", "readOnly": true, "example": "70c7c5cb-dce2-4124-accb-870d39dbe852" }, "name": { "type": "string", "example": "from phone number" }, "description": { "type": "string", "example": "When emergency number dialed from phone number X" }, "notification_event_id": { "type": "string", "example": "d5c395cd-9864-4609-b5e2-3f9fd4ce201a" }, "associated_record_type": { "type": "string", "enum": [ "account", "phone_number" ], "example": "phone_number" }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "phone_number" }, "optional": { "type": "boolean", "example": false }, "data_type": { "type": "string", "example": "string" } } } }, "enabled": { "type": "boolean", "example": true }, "allow_multiple_channels": { "description": "Dictates whether a notification channel id needs to be provided when creating a notficiation setting.", "type": "boolean", "example": false }, "asynchronous": { "description": "Dictates whether a notification setting will take effect immediately.", "type": "boolean", "example": true }, "supported_channels": { "description": "Dictates the supported notification channel types that can be emitted.", "type": "array", "items": { "type": "string" }, "example": [ "webhook", "sms", "email", "voice" ] }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2019-10-15T10:07:15.527Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2019-10-15T10:07:15.527Z" } } }, "NotificationProfile": { "description": "A Collection of Notification Channels", "properties": { "id": { "type": "string", "description": "A UUID.", "readOnly": true, "example": "12455643-3cf1-4683-ad23-1cd32f7d5e0a" }, "name": { "type": "string", "description": "A human readable name." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2019-10-15T10:07:15.527Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2019-10-15T10:07:15.527Z", "readOnly": true } } }, "NotificationSetting": { "properties": { "id": { "type": "string", "description": "A UUID.", "readOnly": true, "example": "8eb5b5f9-5893-423c-9f15-b487713d44d4" }, "notification_event_condition_id": { "type": "string", "description": "A UUID reference to the associated Notification Event Condition.", "example": "70c7c5cb-dce2-4124-accb-870d39dbe852" }, "notification_profile_id": { "type": "string", "description": "A UUID reference to the associated Notification Profile.", "example": "12455643-3cf1-4683-ad23-1cd32f7d5e0a" }, "associated_record_type": { "type": "string", "example": "phone_number", "readOnly": true }, "associated_record_type_value": { "type": "string", "example": "+13125550000", "readOnly": true }, "status": { "type": "string", "description": "Most preferences apply immediately; however, other may needs to propagate.", "enum": [ "enabled", "enable-received", "enable-pending", "enable-submtited", "delete-received", "delete-pending", "delete-submitted", "deleted" ], "example": "enable-received", "readOnly": true }, "notification_channel_id": { "type": "string", "description": "A UUID reference to the associated Notification Channel.", "example": "12455643-3cf1-4683-ad23-1cd32f7d5e0a" }, "parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "phone_number" }, "value": { "type": "string", "example": "+13125550000" } } } }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2019-10-15T10:07:15.527Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2019-10-15T10:07:15.527Z", "readOnly": true } } }, "NumberBlockOrder": { "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "number_block_order", "readOnly": true }, "starting_number": { "type": "string", "description": "Starting phone number block", "format": "e164_phone_number", "example": "+19705555000" }, "range": { "type": "integer", "description": "The phone number range included in the block.", "example": 10 }, "phone_numbers_count": { "type": "integer", "description": "The count of phone numbers in the number order.", "example": 1, "readOnly": true }, "connection_id": { "type": "string", "example": "346789098765567", "description": "Identifies the connection associated to all numbers in the phone number block." }, "messaging_profile_id": { "type": "string", "example": "abc85f64-5717-4562-b3fc-2c9600", "description": "Identifies the messaging profile associated to all numbers in the phone number block." }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "example": "success", "description": "The status of the order.", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number order was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for every phone number, false otherwise.", "example": true, "readOnly": true } }, "example": { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "starting_number": "+19705555000", "range": 10, "record_type": "number_block_order", "connection_id": "346789098765567", "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600", "phone_numbers_count": 10, "status": "pending", "customer_reference": "MY REF 001", "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z", "requirements_met": true } }, "NumberHealthMetrics": { "type": "object", "nullable": false, "required": [ "message_count", "inbound_outbound_ratio", "success_ratio", "spam_ratio" ], "description": "High level health metrics about the number and it's messaging sending patterns.\n", "properties": { "message_count": { "type": "integer", "description": "The number of messages analyzed for the health metrics." }, "inbound_outbound_ratio": { "type": "number", "format": "float", "description": "The ratio of messages received to the number of messages sent." }, "success_ratio": { "type": "number", "format": "float", "description": "The ratio of messages sucessfully delivered to the number of messages attempted." }, "spam_ratio": { "type": "number", "format": "float", "description": "The ratio of messages blocked for spam to the number of messages attempted." } }, "example": { "message_count": 10, "inbound_outbound_ratio": 1, "success_ratio": 2, "spam_ratio": 10 } }, "NumberLookupRecord": { "type": "object", "title": "NumberLookup", "properties": { "record_type": { "type": "string", "description": "Identifies the type of record", "example": "number_lookup" }, "country_code": { "type": "string", "description": "Region code that matches the specific country calling code", "example": "US" }, "national_format": { "type": "string", "description": "Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found", "example": "(0312) 945-7420" }, "phone_number": { "type": "string", "description": "E164-formatted phone number", "example": "+13129457420" }, "fraud": { "type": "string", "description": "Unused", "example": null }, "carrier": { "$ref": "#/components/schemas/Carrier" }, "caller_name": { "$ref": "#/components/schemas/CallerName" }, "portability": { "$ref": "#/components/schemas/Portability" } } }, "NumberOrder": { "title": "Number Order With Phone Numbers", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "number_order", "readOnly": true }, "phone_numbers_count": { "type": "integer", "description": "The count of phone numbers in the number order.", "example": 1, "readOnly": true }, "connection_id": { "type": "string", "example": "346789098765567", "description": "Identifies the connection associated with this phone number." }, "messaging_profile_id": { "type": "string", "example": "abc85f64-5717-4562-b3fc-2c9600", "description": "Identifies the messaging profile associated with the phone number." }, "billing_group_id": { "type": "string", "example": "abc85f64-5717-4562-b3fc-2c9600", "description": "Identifies the messaging profile associated with the phone number." }, "phone_numbers": { "type": "array", "items": { "description": "The unique phone numbers given as arguments in the job creation.", "$ref": "#/components/schemas/PhoneNumbersJobPhoneNumber" } }, "sub_number_orders_ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the order.", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number order was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for every phone number, false otherwise.", "example": true, "readOnly": true } } }, "NumberOrderBlockEvent": { "type": "object", "title": "Number Order Event", "properties": { "data": { "$ref": "#/components/schemas/NumberBlockOrder" } } }, "NumberOrderDocument": { "properties": { "id": { "type": "string", "format": "uuid", "example": "387d1e31-a218-4375-8151-103f2d5e2d2c", "readOnly": true }, "record_type": { "type": "string", "example": "number_order_document", "readOnly": true }, "file_id": { "type": "string", "description": "The id of the file to associate as a number order document.", "example": "1e3c5822-0362-4702-8e46-5a129f0d3976" }, "requirements_id": { "type": "string", "description": "Unique id for a requirement.", "example": "36aaf27d-986b-493c-bd1b-de16af2e4292" }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "requirement_type": { "type": "string", "enum": [ "address_proof", "identification", "reg_form" ], "readOnly": true }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order document was uploaded.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true } }, "example": { "id": "387d1e31-a218-4375-8151-103f2d5e2d2c", "record_type": "number_order_document", "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976", "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292", "customer_reference": "MY REF 001", "requirement_type": "address_proof", "created_at": "2018-01-01T00:00:00.000000Z" } }, "NumberOrderPhoneNumber": { "properties": { "id": { "type": "string", "format": "uuid", "example": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "readOnly": true }, "record_type": { "type": "string", "example": "number_order_phone_number", "readOnly": true }, "phone_number": { "type": "string", "format": "e164_phone_number", "example": "+19705555098" }, "order_request_id": { "type": "string", "format": "uuid", "example": "dc8e4d67-33a0-4cbb-af74-7b58f05bd495" }, "sub_number_order_id": { "type": "string", "format": "uuid", "example": "dc8e4d67-33a0-4cbb-af74-7b58f05bd496" }, "country_code": { "type": "string", "example": "US" }, "phone_number_type": { "type": "string", "example": "local", "enum": [ "local", "toll_free", "mobile", "national", "shared_cost", "landline" ] }, "regulatory_requirements": { "type": "array", "items": { "$ref": "#/components/schemas/SubNumberOrderRegulatoryRequirementWithValue" } }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for a phone number, false otherwise.", "example": true, "readOnly": true }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the phone number in the order.", "readOnly": true } } }, "NumberOrderWithPhoneNumbers": { "title": "NumberOrder", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "number_order", "readOnly": true }, "phone_numbers_count": { "type": "integer", "description": "The count of phone numbers in the number order.", "example": 1, "readOnly": true }, "connection_id": { "type": "string", "example": "346789098765567", "description": "Identifies the connection associated with this phone number." }, "messaging_profile_id": { "type": "string", "example": "abc85f64-5717-4562-b3fc-2c9600", "description": "Identifies the messaging profile associated with the phone number." }, "billing_group_id": { "type": "string", "example": "abc85f64-5717-4562-b3fc-2c9600", "description": "Identifies the messaging profile associated with the phone number." }, "phone_numbers": { "type": "array", "items": { "description": "The unique phone numbers given as arguments in the job creation.", "$ref": "#/components/schemas/PhoneNumber" } }, "sub_number_orders_ids": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the order.", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number order was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for every phone number, false otherwise.", "example": true, "readOnly": true } } }, "NumberOrdered": { "type": "object", "title": "Number Order Event Data", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource." }, "event_type": { "type": "string", "example": "number_order.complete", "description": "The type of event being delivered." }, "occurred_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created." }, "payload": { "$ref": "#/components/schemas/NumberOrder" } } }, "NumberOrderedEvent": { "type": "object", "title": "Number Order Event", "properties": { "data": { "$ref": "#/components/schemas/NumberOrdered" } } }, "NumberPoolSettings": { "type": "object", "nullable": true, "required": [ "toll_free_weight", "long_code_weight", "skip_unhealthy" ], "description": "Number Pool allows you to send messages from a pool of numbers of different types, assigning\nweights to each type. The pool consists of all the long code and toll free numbers\nassigned to the messaging profile.\n\nTo disable this feature, set the object field to `null`.\n", "properties": { "toll_free_weight": { "type": "number", "example": 10, "description": "Defines the probability weight for a Toll Free number to be selected when sending a message.\nThe higher the weight the higher the probability. The sum of the weights for all number types\ndoes not necessarily need to add to 100. Weight must be a non-negative number, and when equal\nto zero it will remove the number type from the pool.\n" }, "long_code_weight": { "type": "number", "example": 1, "description": "Defines the probability weight for a Long Code number to be selected when sending a message.\nThe higher the weight the higher the probability. The sum of the weights for all number types\ndoes not necessarily need to add to 100. Weight must be a non-negative number, and when equal\nto zero it will remove the number type from the pool.\n" }, "skip_unhealthy": { "type": "boolean", "example": true, "description": "If set to true all unhealthy numbers will be automatically excluded from the pool.\nHealth metrics per number are calculated on a regular basis, taking into account the deliverability\nrate and the amount of messages marked as spam by upstream carriers.\nNumbers with a deliverability rate below 25% or spam ratio over 75% will be considered unhealthy.\n" }, "sticky_sender": { "type": "boolean", "default": false, "description": "If set to true, Number Pool will try to choose the same sending number for all messages to a particular\nrecipient. If the sending number becomes unhealthy and `skip_unhealthy` is set to true, a new\nnumber will be chosen.\n" }, "geomatch": { "type": "boolean", "default": false, "description": "If set to true, Number Pool will try to choose a sending number with the same area code as the destination\nnumber. If there are no such numbers available, a nunber with a different area code will be chosen. Currently\nonly NANP numbers are supported.\n" } }, "example": { "toll_free_weight": 10, "long_code_weight": 1, "skip_unhealthy": true, "sticky_sender": false, "geomatch": false } }, "NumberReservation": { "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "number_reservation", "readOnly": true }, "phone_numbers": { "type": "array", "items": { "$ref": "#/components/schemas/ReservedPhoneNumber" } }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the entire reservation.", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the numbers reservation was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number reservation was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true } }, "example": { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "record_type": "number_reservation", "phone_numbers": [ { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "record_type": "reserved_phone_number", "phone_number": "+19705555098", "status": "pending", "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z", "expired_at": "2018-01-01T00:00:00.000000Z", "errors": "" } ], "status": "pending", "customer_reference": "MY REF 001", "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z" } }, "OrderExternalVetting": { "title": "OrderExternalVetting", "required": [ "evpId", "vettingClass" ], "type": "object", "properties": { "evpId": { "title": "Evpid", "maxLength": 10, "type": "string", "description": "External vetting provider ID for the brand." }, "vettingClass": { "title": "Vettingclass", "type": "string", "description": "Identifies the vetting classification." } } }, "OriginalMediaUrl": { "description": "The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted", "type": "string", "example": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf" }, "OutboundCallRecording": { "type": "object", "example": { "call_recording_type": "by_caller_phone_number", "call_recording_caller_phone_numbers": [ "+19705555098" ], "call_recording_channels": "dual", "call_recording_format": "mp3" }, "properties": { "call_recording_type": { "type": "string", "description": "Specifies which calls are recorded.", "enum": [ "all", "none", "by_caller_phone_number" ] }, "call_recording_caller_phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "When call_recording_type is 'by_caller_phone_number', only outbound calls using one of these numbers will be recorded. Numbers must be specified in E164 format.", "example": [ "+19705555098" ] }, "call_recording_channels": { "type": "string", "description": "When using 'dual' channels, the final audio file will be a stereo recording with the first leg on channel A, and the rest on channel B.", "example": "dual", "default": "single", "enum": [ "single", "dual" ] }, "call_recording_format": { "type": "string", "description": "The audio file format for calls being recorded.", "example": "mp3", "default": "wav", "enum": [ "wav", "mp3" ] } } }, "OutboundFqdn": { "type": "object", "title": "Connection Outbound Settings", "properties": { "ani_override": { "title": "ANI override type", "type": "string", "format": "E.164", "description": "Set a phone number as the ani_override value to override caller id number on outbound calls." }, "ani_override_type": { "title": "ANI override type", "type": "string", "description": "Specifies when we should apply your ani_override setting. Only applies when ani_override is not blank.", "enum": [ "always", "normal", "emergency" ], "default": "always", "example": "normal" }, "call_parking_enabled": { "type": "boolean", "default": false, "description": "Forces all SIP calls originated on this connection to be \\\"parked\\\" instead of \\\"bridged\\\" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next." }, "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection." }, "generate_ringback_tone": { "type": "boolean", "default": false, "description": "Generate ringback tone through 183 session progress message with early media." }, "instant_ringback_enabled": { "type": "boolean", "default": false, "description": "When set, ringback will not wait for indication before sending ringback tone to calling party." }, "ip_authentication_method": { "type": "string", "example": "credential-authentication", "default": "ip-authentication", "enum": [ "credential-authentication", "ip-authentication" ] }, "ip_authentication_token": { "type": "string" }, "localization": { "type": "string", "default": "US", "description": "A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default.\",", "example": "US" }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" }, "t38_reinvite_source": { "type": "string", "enum": [ "telnyx", "customer", "disabled", "passthru", "caller-passthru", "callee-passthru" ], "description": "This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite. By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite.", "default": "telnyx" }, "tech_prefix": { "type": "string", "description": "Numerical chars only, exactly 4 characters." }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "timeout_1xx_secs": { "type": "integer", "description": "Time(sec) before aborting if connection is not made.", "minimum": 1, "maximum": 120, "default": 3 }, "timeout_2xx_secs": { "type": "integer", "description": "Time(sec) before aborting if call is unanswered (min: 1, max: 600).", "minimum": 1, "maximum": 600, "default": 90 } } }, "OutboundIp": { "type": "object", "title": "Outband Ip", "properties": { "call_parking_enabled": { "type": "boolean", "default": false, "description": "Forces all SIP calls originated on this connection to be \"parked\" instead of \"bridged\" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next." }, "ani_override": { "type": "string", "description": "Set a phone number as the ani_override value to override caller id number on outbound calls.", "default": "" }, "ani_override_type": { "type": "string", "enum": [ "always", "normal", "emergency" ], "description": "Specifies when we apply your ani_override setting. Only applies when ani_override is not blank.", "default": "always" }, "channel_limit": { "type": "integer", "default": null, "description": "When set, this will limit the total number of outbound calls to phone numbers associated with this connection." }, "instant_ringback_enabled": { "type": "boolean", "default": true, "description": "When set, ringback will not wait for indication before sending ringback tone to calling party." }, "generate_ringback_tone": { "type": "boolean", "default": false, "description": "Generate ringback tone through 183 session progress message with early media." }, "localization": { "type": "string", "default": null, "description": "A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default." }, "t38_reinvite_source": { "type": "string", "enum": [ "telnyx", "customer", "disabled", "passthru", "caller-passthru", "callee-passthru" ], "description": "This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.

By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite.", "default": "telnyx" }, "tech_prefix": { "type": "string", "description": "Numerical chars only, exactly 4 characters.", "default": "" }, "ip_authentication_method": { "type": "string", "default": "tech-prefixp-charge-info", "example": "tech-prefixp-charge-info", "enum": [ "tech-prefixp-charge-info", "token" ] }, "ip_authentication_token": { "type": "string", "default": null }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } }, "example": { "call_parking_enabled": true, "ani_override": "string", "ani_override_type": "always", "channel_limit": 10, "instant_ringback_enabled": true, "generate_ringback_tone": true, "localization": "string", "t38_reinvite_source": "telnyx", "tech_prefix": "string", "ip_authentication_method": "token", "ip_authentication_token": "string", "outbound_voice_profile_id": "1293384261075731499" } }, "OutboundMessage": { "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource." }, "event_type": { "type": "string", "example": "message.sent", "enum": [ "message.sent", "message.finalized" ], "description": "The type of event being delivered." }, "occurred_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created." }, "payload": { "$ref": "#/components/schemas/OutboundMessagePayload" } }, "example": { "record_type": "event", "id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323", "event_type": "message.sent", "occurred_at": "date-time", "payload": { "record_type": "message", "direction": "outbound", "id": "40385f64-5717-4562-b3fc-2c963f66afa6", "type": "MMS", "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6", "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950", "from": { "phone_number": "+18445550001", "carrier": "TELNYX LLC", "line_type": "VoIP" }, "to": [ { "phone_number": "+18665550001", "status": "queued", "carrier": "T-MOBILE USA, INC.", "line_type": "Wireless" } ], "text": "Hello, World!", "subject": "From Telnyx!", "media": [ { "url": "https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png", "content_type": null, "sha256": null, "size": null } ], "webhook_url": "https://www.example.com/hooks", "webhook_failover_url": "https://backup.example.com/hooks", "encoding": "GSM-7", "parts": 1, "tags": [ "Greetings" ], "cost": null, "received_at": "2019-01-23T18:10:02.574Z", "sent_at": null, "completed_at": null, "valid_until": null, "errors": [] } } }, "OutboundMessageEvent": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OutboundMessage" }, "meta": { "type": "object", "properties": { "attempt": { "type": "integer", "example": 1, "description": "Number of attempts to deliver the webhook event." }, "delivered_to": { "type": "string", "format": "url", "example": "https://www.example.com/hooks", "description": "The webhook URL the event was delivered to." } } } } }, "OutboundMessagePayload": { "type": "object", "properties": { "record_type": { "type": "string", "example": "message", "enum": [ "message" ], "description": "Identifies the type of the resource." }, "direction": { "type": "string", "example": "outbound", "enum": [ "outbound" ], "description": "The direction of the message. Inbound messages are sent to you whereas outbound messages are sent from you." }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource." }, "type": { "type": "string", "enum": [ "SMS", "MMS" ], "description": "The type of message." }, "messaging_profile_id": { "type": "string", "description": "Unique identifier for a messaging profile." }, "organization_id": { "type": "string", "format": "uuid", "description": "The id of the organization the messaging profile belongs to." }, "from": { "type": "object", "properties": { "phone_number": { "type": "string", "format": "address", "description": "Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code)." }, "carrier": { "type": "string", "description": "The carrier of the receiver." }, "line_type": { "type": "string", "description": "The line-type of the receiver.", "enum": [ "Wireline", "Wireless", "VoWiFi", "VoIP", "Pre-Paid Wireless", "" ] } } }, "to": { "type": "array", "items": { "type": "object", "properties": { "phone_number": { "type": "string", "format": "address", "description": "Receiving address (+E.164 formatted phone number or short code)." }, "status": { "type": "string", "description": "The delivery status of the message.", "enum": [ "queued", "sending", "sent", "expired", "sending_failed", "delivery_unconfirmed", "delivered", "delivery_failed" ] }, "carrier": { "type": "string", "description": "The carrier of the receiver." }, "line_type": { "type": "string", "description": "The line-type of the receiver.", "enum": [ "Wireline", "Wireless", "VoWiFi", "VoIP", "Pre-Paid Wireless", "" ] } } } }, "text": { "type": "string", "description": "Message body (i.e., content) as a non-empty string.\n\n**Required for SMS**" }, "subject": { "type": "string", "nullable": true, "description": "Subject of multimedia message" }, "media": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "url", "description": "The url of the media requested to be sent." }, "content_type": { "type": "string", "format": "mime-type", "nullable": true, "description": "The MIME type of the requested media." }, "sha256": { "type": "string", "nullable": true, "description": "The SHA256 hash of the requested media." }, "size": { "type": "integer", "nullable": true, "description": "The size of the requested media." } } } }, "webhook_url": { "type": "string", "format": "url", "nullable": true, "description": "The URL where webhooks related to this message will be sent." }, "webhook_failover_url": { "type": "string", "format": "url", "nullable": true, "description": "The failover URL where webhooks related to this message will be sent if sending to the primary URL fails." }, "encoding": { "type": "string", "description": "Encoding scheme used for the message body." }, "parts": { "type": "integer", "minimum": 1, "maximum": 10, "description": "Number of parts into which the message's body must be split." }, "tags": { "type": "array", "description": "Tags associated with the resource.", "items": { "type": "string" } }, "cost": { "type": "object", "nullable": true, "properties": { "amount": { "type": "string", "format": "decimal", "description": "The amount deducted from your account." }, "currency": { "type": "string", "format": "iso4217", "description": "The ISO 4217 currency identifier." } } }, "received_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the message request was received." }, "sent_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the message was sent." }, "completed_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the message was finalized." }, "valid_until": { "type": "string", "description": "Message must be out of the queue by this time or else it will be discarded and marked as 'sending_failed'. Once the message moves out of the queue, this field will be nulled", "format": "date-time", "nullable": true }, "errors": { "type": "array", "description": "These errors may point at addressees when referring to unsuccessful/unconfirmed delivery statuses.", "items": { "$ref": "#/components/schemas/Error" } } }, "example": { "record_type": "message", "direction": "outbound", "id": "40385f64-5717-4562-b3fc-2c963f66afa6", "type": "MMS", "messaging_profile_id": "4000eba1-a0c0-4563-9925-b25e842a7cb6", "organization_id": "b448f9cc-a842-4784-98e9-03c1a5872950", "from": { "phone_number": "+18445550001", "carrier": "TELNYX LLC", "line_type": "VoIP" }, "to": [ { "phone_number": "+18665550001", "status": "queued", "carrier": "T-MOBILE USA, INC.", "line_type": "Wireless" } ], "text": "Hello, World!", "subject": "From Telnyx!", "media": [ { "url": "https://pbs.twimg.com/profile_images/1142168442042118144/AW3F4fFD_400x400.png", "content_type": null, "sha256": null, "size": null } ], "webhook_url": "https://www.example.com/hooks", "webhook_failover_url": "https://backup.example.com/hooks", "encoding": "GSM-7", "parts": 1, "tags": [ "Greetings" ], "cost": null, "received_at": "2019-01-23T18:10:02.574Z", "sent_at": null, "completed_at": null, "valid_until": null, "errors": [] } }, "OutboundVoiceProfile": { "type": "object", "title": "Outbound Voice Profile", "required": [ "name" ], "example": { "id": "1293384261075731499", "record_type": "outbound_voice_profile", "name": "office", "connections_count": 12, "traffic_type": "conversational", "service_plan": "global", "concurrent_call_limit": 10, "enabled": true, "tags": [ "office-profile" ], "usage_payment_method": "rate-deck", "whitelisted_destinations": [ "US", "BR", "AU" ], "max_destination_rate": 10, "daily_spend_limit": "100.00", "daily_spend_limit_enabled": true, "call_recording": { "call_recording_type": "by_caller_phone_number", "call_recording_caller_phone_numbers": [ "+19705555098" ], "call_recording_channels": "dual", "call_recording_format": "mp3" }, "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z" }, "properties": { "id": { "type": "string", "format": "int64", "description": "Identifies the resource.", "example": "1293384261075731499" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "outbound_voice_profile" }, "name": { "type": "string", "description": "A user-supplied name to help with organization.", "example": "office", "minLength": 3 }, "connections_count": { "type": "integer", "description": "Amount of connections associated with this outbound voice profile.", "example": 12 }, "traffic_type": { "$ref": "#/components/schemas/TrafficType" }, "service_plan": { "$ref": "#/components/schemas/ServicePlan" }, "concurrent_call_limit": { "type": "integer", "description": "Must be no more than your global concurrent call limit. Null means no limit.", "example": 10, "nullable": true }, "enabled": { "type": "boolean", "description": "Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.", "example": true, "default": true }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "office-profile" ] }, "usage_payment_method": { "$ref": "#/components/schemas/UsagePaymentMethod" }, "whitelisted_destinations": { "type": "array", "items": { "type": "string" }, "description": "The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.", "example": [ "US", "BR", "AU" ], "default": [ "US", "CA" ] }, "max_destination_rate": { "type": "number", "description": "Maximum rate (price per minute) for a Destination to be allowed when making outbound calls." }, "daily_spend_limit": { "type": "string", "description": "The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.", "example": "100.00" }, "daily_spend_limit_enabled": { "type": "boolean", "description": "Specifies whether to enforce the daily_spend_limit on this outbound voice profile.", "example": true, "default": false }, "call_recording": { "$ref": "#/components/schemas/OutboundCallRecording" }, "billing_group_id": { "type": "string", "format": "uuid", "description": "The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "default": null, "nullable": true }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" } } }, "OutboundVoiceProfileId": { "title": "Outbound Voice Profile ID", "type": "string", "description": "Identifies the associated outbound voice profile.", "format": "int64", "example": "1293384261075731499" }, "PWGAssignedResourcesSummary": { "type": "object", "description": "The summary of the resource that have been assigned to the Private Wireless Gateway", "properties": { "record_type": { "type": "string", "description": "The type of the resource assigned to the Private Wireless Gateway", "example": "sim_card_group", "readOnly": true }, "count": { "type": "integer", "description": "The current count of a resource type assigned to the Private Wireless Gateway", "example": 1, "readOnly": true } } }, "Paginated_VerificationRequestStatus_": { "title": "Paginated[VerificationRequestStatus]", "type": "object", "properties": { "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/VerificationRequestStatus" }, "description": "The records yielded by this request", "default": [] }, "total_records": { "title": "Total Records", "type": "integer", "description": "The total amount of records for these query parameters", "default": 0 } }, "description": "A paginated response" }, "PaginationMeta": { "type": "object", "properties": { "total_pages": { "type": "integer", "example": 3 }, "total_results": { "type": "integer", "example": 55 }, "page_number": { "type": "integer", "example": 2 }, "page_size": { "type": "integer", "example": 25 } } }, "PaginationMetaSimple": { "type": "object", "properties": { "page_number": { "type": "integer", "example": 2 }, "page_size": { "type": "integer", "example": 25 }, "total_pages": { "type": "integer", "example": 3 }, "total_results": { "type": "integer", "example": 55 } } }, "Participant": { "type": "object", "title": "Participant", "required": [ "record_type", "id", "call_leg_id", "call_control_id", "conference", "whisper_call_control_ids", "created_at", "updated_at", "end_conference_on_exit", "soft_end_conference_on_exit", "status", "muted", "on_hold" ], "properties": { "record_type": { "type": "string", "enum": [ "participant" ], "example": "participant" }, "id": { "type": "string", "description": "Uniquely identifies the participant", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "call_leg_id": { "type": "string", "description": "Uniquely identifies the call leg associated with the participant", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "call_control_id": { "type": "string", "description": "Call Control ID associated with the partiipant of the conference", "example": "v2:v2:T02llQxIyaRkhfRKxgAP8nY511EhFLizdvdUKJiSw8d6A9BborherQczRrZvZakpWxBlpw48KyZQ" }, "conference": { "type": "object", "description": "Info about the conference that the participant is in", "properties": { "id": { "type": "string", "description": "Uniquely identifies the conference", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "description": "Name of the conference", "example": "All hands meeting" } } }, "whisper_call_control_ids": { "description": "Array of unique call_control_ids the participant can whisper to..", "example": [ "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ", "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw" ], "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the participant was created", "example": "2019-01-23T18:10:02.574Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the participant was last updated", "example": "2019-01-23T18:10:02.574Z" }, "end_conference_on_exit": { "type": "boolean", "description": "Whether the conference will end and all remaining participants be hung up after the participant leaves the conference.", "example": true }, "soft_end_conference_on_exit": { "type": "boolean", "description": "Whether the conference will end after the participant leaves the conference.", "example": true }, "status": { "type": "string", "enum": [ "joining", "joined", "left" ], "description": "The status of the participant with respect to the lifecycle within the conference", "example": "joining" }, "muted": { "type": "boolean", "description": "Whether the participant is muted.", "example": true }, "on_hold": { "type": "boolean", "description": "Whether the participant is put on_hold.", "example": true } }, "example": { "record_type": "participant", "created_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z", "end_conference_on_exit": true, "soft_end_conference_on_exit": true, "status": "joining", "muted": false, "on_hold": true, "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "whisper_call_control_ids": [ "v2:Sg1xxxQ_U3ixxxyXT_VDNI3xxxazZdg6Vxxxs4-GNYxxxVaJPOhFMRQ", "v2:qqpb0mmvd-ovhhBr0BUQQn0fld5jIboaaX3-De0DkqXHzbf8d75xkw" ], "id": "dfadada7-af74-47bc-83a4-554275f55f5c", "call_leg_id": "3a15df2d-c801-4729-adf5-b56dd42e2abb", "conference": { "id": "41b9acd4-f4da-4ff5-a85c-e07e90b53f46", "name": "1" } } }, "ParticipantJoined": { "type": "object", "title": "Participant Joined", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "An identifier for the type of the resource." }, "event_type": { "type": "string", "example": "video.room.participant.joined", "enum": [ "video.room.participant.joined" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Uniquely identify the event." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Session ID that identifies the session where the participant joined." }, "room_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Room ID that identifies the room where the participant joined." }, "context": { "type": "string", "example": "Alice", "description": "Context provided to the given participant through the client SDK" }, "participant_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Participant ID that identifies the participant that joined." } } } }, "example": { "record_type": "event", "event_type": "video.room.session.started", "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "room_id": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "participant_id": "5ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "context": "Alice" } } }, "ParticipantJoinedEvent": { "type": "object", "title": "Participant Joined Event", "properties": { "data": { "$ref": "#/components/schemas/ParticipantJoined" } } }, "ParticipantLeft": { "type": "object", "title": "Participant Left", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "An identifier for the type of the resource." }, "event_type": { "type": "string", "example": "video.room.participant.left", "enum": [ "video.room.participant.left" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Uniquely identify the event." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Session ID that identifies the session where the participant left." }, "room_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Room ID that identifies the room where the participant left." }, "context": { "type": "string", "example": "Alice", "description": "Context provided to the given participant through the client SDK" }, "participant_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Participant ID that identifies the participant that left." }, "duration_secs": { "type": "integer", "example": 245, "description": "The duration in seconds of the participant in the session" }, "left_reason": { "type": "string", "example": "kicked", "description": "The reason why the participant left" } } } }, "example": { "record_type": "event", "event_type": "video.room.session.started", "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "room_id": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "participant_id": "5ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "context": "Alice", "duration_secs": 34, "left_reason": "kick" } } }, "ParticipantLeftEvent": { "type": "object", "title": "Participant Left Event", "properties": { "data": { "$ref": "#/components/schemas/ParticipantLeft" } } }, "ParticipantResource": { "type": "object", "title": "Participant resource", "example": { "account_sid": "4e71926f-8f13-450e-b91c-23c2ef786aa6", "api_version": "v2/texml", "call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ", "call_sid_legacy": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ", "coaching": false, "coaching_call_sid": null, "coaching_call_sid_legacy": null, "conference_sid": "cd5a70f4-759b-4d5e-9c06-88c00f16f3c1", "date_created": "Fri, 27 Oct 2023 07:41:58 +0000", "date_updated": "Fri, 27 Oct 2023 07:41:58 +0000", "end_conference_on_exit": false, "hold": false, "muted": false, "status": "completed", "uri": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json" }, "properties": { "account_sid": { "type": "string", "description": "The id of the account the resource belongs to.", "example": "61bf923e-5e4d-4595-a110-56190ea18a1b" }, "api_version": { "type": "string", "description": "The version of the API that was used to make the request.", "example": "v2/texml" }, "call_sid": { "type": "string", "description": "The identifier of this participant's call.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ" }, "call_sid_legacy": { "type": "string", "description": "The identifier of this participant's call.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ" }, "coaching": { "type": "boolean", "description": "Whether the participant is coaching another call.", "example": false }, "coaching_call_sid": { "type": "string", "description": "The identifier of the coached participant's call.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ" }, "coaching_call_sid_legacy": { "type": "string", "description": "The identifier of the coached participant's call.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ" }, "date_created": { "type": "string", "description": "The timestamp of when the resource was created.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "date_updated": { "type": "string", "description": "The timestamp of when the resource was last updated.", "example": "Thu, 15 Jun 2023 09:56:45 +0000" }, "end_conference_on_exit": { "type": "boolean", "description": "Whether the conference ends when the participant leaves.", "example": false }, "hold": { "type": "boolean", "description": "Whether the participant is on hold.", "example": false }, "muted": { "type": "boolean", "description": "Whether the participant is muted.", "example": false }, "status": { "type": "string", "description": "The status of the participant's call in the conference.", "enum": [ "connecting", "connected", "completed" ], "example": "in-progress" }, "uri": { "type": "string", "description": "The relative URI for this participant.", "example": "/v2/texml/Accounts/4e71926f-8f13-450e-b91c-23c2ef786aa6/Conferences/cd5a70f4-759b-4d5e-9c06-88c00f16f3c1/Participants/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ.json" } } }, "ParticipantResourceIndex": { "type": "object", "title": "Multiple participant resources", "example": { "participants": [], "end": 0, "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20", "next_page_uri": null, "page": 0, "page_size": 20, "start": 0, "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20" }, "properties": { "participants": { "type": "array", "items": { "$ref": "#/components/schemas/ParticipantResource" } }, "end": { "type": "integer", "description": "The number of the last element on the page, zero-indexed.", "example": 19 }, "first_page_uri": { "type": "string", "description": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?page=0&pagesize=20", "example": "accepted" }, "next_page_uri": { "type": "string", "description": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ", "example": "accepted" }, "page": { "type": "integer", "description": "Current page number, zero-indexed.", "example": 0 }, "page_size": { "type": "integer", "description": "The number of items on the page", "example": 20 }, "start": { "type": "integer", "description": "The number of the first element on the page, zero-indexed.", "example": 0 }, "uri": { "type": "string", "description": "The URI of the current page.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Conferences/6dc6cc1a-1ba1-4351-86b8-4c22c95cd98f/Participants.json?Page=0&PageSize=1" } } }, "PatchRoomRequest": { "type": "object", "properties": { "unique_name": { "description": "The unique (within the Telnyx account scope) name of the room.", "type": "string", "example": "My room" }, "max_participants": { "description": "The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected.", "type": "integer", "example": 10, "default": 10, "minimum": 2, "maximum": 50 }, "enable_recording": { "description": "Enable or disable recording for that room.", "type": "boolean", "example": true, "default": false }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true } } }, "PauseConferenceRecordingRequest": { "type": "object", "title": "Pause Recording Request", "properties": { "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "recording_id": { "description": "Use this field to pause specific recording.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } } }, "PauseRecordingRequest": { "type": "object", "title": "Pause Recording Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } } }, "PhoneNumber": { "properties": { "id": { "type": "string", "format": "uuid", "example": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "readOnly": true }, "record_type": { "type": "string", "example": "number_order_phone_number", "readOnly": true }, "phone_number": { "type": "string", "format": "e164_phone_number", "example": "+19705555098" }, "regulatory_requirements": { "type": "array", "items": { "$ref": "#/components/schemas/SubNumberOrderRegulatoryRequirementWithValue" } }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for a phone number, false otherwise.", "example": true, "readOnly": true }, "requirements_status": { "type": "string", "enum": [ "pending", "approved", "cancelled", "deleted", "requirement-info-exception", "requirement-info-pending", "requirement-info-under-review" ], "description": "Status of document requirements (if applicable)", "readOnly": true }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the phone number in the order.", "readOnly": true }, "bundle_id": { "type": "string", "format": "uuid", "example": "bc8e4d67-33a0-4cbb-af74-7b58f05bd494", "readOnly": true }, "phone_number_type": { "type": "string", "enum": [ "local", "mobile", "national", "shared_cost", "toll_free" ], "description": "Phone number type", "readOnly": true }, "country_code": { "type": "string", "example": "US", "description": "Country code of the phone number", "readOnly": true } }, "example": { "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "record_type": "number_order_phone_number", "phone_number": "+19705555098", "bundle_id": "bc8e4d67-33a0-4cbb-af74-7b58f05bd474", "regulatory_requirements": [ { "record_type": "phone_number_regulatory_requirement", "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576", "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21", "field_type": "address" } ], "requirements_met": true, "status": "success" } }, "PhoneNumberBlocksJob": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "description": "Identifies the resource.", "readOnly": true }, "record_type": { "type": "string", "example": "phone_number_block_job", "description": "Identifies the type of the resource.", "readOnly": true }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed" ], "default": "pending", "example": "pending", "description": "Indicates the completion status of the background operation.", "readOnly": true }, "type": { "type": "string", "enum": [ "delete_phone_number_block" ], "example": "delete_phone_number_block", "description": "Identifies the type of the background job.", "readOnly": true }, "etc": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the estimated time of completion of the background job.", "readOnly": true }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "readOnly": true }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "readOnly": true }, "successful_operations": { "type": "array", "items": { "description": "The phone numbers successfully updated.", "$ref": "#/components/schemas/PhoneNumberBlocksJobSuccessfulOperation" }, "readOnly": true }, "failed_operations": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberBlocksJobFailedOperation" }, "readOnly": true } }, "example": { "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "record_type": "phone_numbers_job", "status": "pending", "type": "delete_phone_number_block", "etc": "2020-10-30T18:10:00.000Z", "created_at": "2020-10-23T18:10:00.000Z", "updated_at": "2020-10-23T18:10:01.000Z", "successful_operations": [], "failed_operations": [] } }, "PhoneNumberBlocksJobDeletePhoneNumberBlockRequest": { "type": "object", "required": [ "phone_number_block_id" ], "properties": { "phone_number_block_id": { "type": "string" } }, "example": { "phone_number_block_id": "f3946371-7199-4261-9c3d-81a0d7935146" } }, "PhoneNumberBlocksJobFailedOperation": { "properties": { "phone_number": { "type": "string", "description": "The phone number in e164 format.", "format": "e164" }, "id": { "type": "string", "format": "int64", "description": "The phone number's ID" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "PhoneNumberBlocksJobSuccessfulOperation": { "properties": { "phone_number": { "type": "string", "description": "The phone number in e164 format.", "format": "e164" }, "id": { "type": "string", "format": "int64", "description": "The phone number's ID" } } }, "PhoneNumberCampaign": { "title": "PhoneNumberCampaign", "required": [ "phoneNumber", "campaignId", "createdAt", "updatedAt" ], "type": "object", "properties": { "phoneNumber": { "title": "Phonenumber", "type": "string" }, "campaignId": { "title": "Campaignid", "type": "string" }, "createdAt": { "title": "Createdat", "type": "string", "format": "date-time" }, "updatedAt": { "title": "Updatedat", "type": "string", "format": "date-time" } } }, "PhoneNumberCampaignCreate": { "title": "PhoneNumberCampaignCreate", "required": [ "phoneNumber", "campaignId" ], "type": "object", "properties": { "phoneNumber": { "title": "Phonenumber", "type": "string", "description": "The phone number you want to link to a specified campaign.", "example": "+18005550199" }, "campaignId": { "title": "Campaignid", "type": "string", "description": "The ID of the campaign you want to link to the specified phone number.", "example": "4b300178-131c-d902-d54e-72d90ba1620j" } } }, "PhoneNumberCampaignPaginated": { "title": "PhoneNumberCampaignPaginated", "required": [ "records", "page", "totalRecords" ], "type": "object", "properties": { "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberCampaign" } }, "page": { "title": "Page", "type": "integer" }, "totalRecords": { "title": "Totalrecords", "type": "integer" } } }, "PhoneNumberCampaignUpdate": { "title": "PhoneNumberCampaignUpdate", "required": [ "campaignId" ], "type": "object", "properties": { "campaignId": { "title": "Campaignid", "type": "string" } } }, "PhoneNumberDeletedDetailed": { "type": "object", "example": { "id": "1293384261075731499", "record_type": "phone_number", "phone_number": "+19705555098", "status": "deleted", "tags": [ "tag_1", "tag_2" ], "external_pin": "1234", "connection_id": "1293384261075731499", "connection_name": "connection-name", "customer_reference": "customer-reference", "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000", "messaging_profile_name": "regional-customers", "billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323", "emergency_enabled": true, "emergency_address_id": "1315261609962112019", "call_forwarding_enabled": true, "cnam_listing_enabled": true, "caller_id_name_enabled": true, "call_recording_enabled": true, "t38_fax_gateway_enabled": true, "number_level_routing": "disabled", "phone_number_type": "local", "purchased_at": "2019-10-23T18:10:00.000Z", "created_at": "2019-10-23T18:10:00.000Z", "updated_at": "2019-10-24T18:10:00.000Z", "hd_voice_enabled": true }, "properties": { "id": { "$ref": "#/components/schemas/IntId" }, "record_type": { "type": "string", "example": "phone_number", "description": "Identifies the type of the resource.", "readOnly": true }, "phone_number": { "type": "string", "description": "The +E.164-formatted phone number associated with this record.", "readOnly": true }, "status": { "type": "string", "description": "The phone number's current status.", "enum": [ "purchase-pending", "purchase-failed", "port-pending", "port-failed", "active", "deleted", "emergency-only", "ported-out", "port-out-pending" ], "readOnly": true }, "tags": { "type": "array", "description": "A list of user-assigned tags to help manage the phone number.", "items": { "type": "string" } }, "external_pin": { "type": "string", "description": "If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism." }, "connection_name": { "type": "string", "description": "The user-assigned name of the connection to be associated with this phone number.", "readOnly": true }, "connection_id": { "type": "string", "description": "Identifies the connection associated with the phone number." }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "messaging_profile_id": { "type": "string", "description": "Identifies the messaging profile associated with the phone number." }, "messaging_profile_name": { "type": "string", "description": "The name of the messaging profile associated with the phone number.", "example": "regional-customers" }, "billing_group_id": { "type": "string", "description": "Identifies the billing group associated with the phone number." }, "emergency_enabled": { "type": "boolean", "description": "Indicates whether emergency services are enabled for this number.", "readOnly": true }, "emergency_address_id": { "type": "string", "format": "int64", "description": "Identifies the emergency address associated with the phone number.", "readOnly": true }, "call_forwarding_enabled": { "type": "boolean", "default": true, "description": "Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.", "readOnly": true }, "cnam_listing_enabled": { "type": "boolean", "description": "Indicates whether a CNAM listing is enabled for this number.", "readOnly": true }, "caller_id_name_enabled": { "type": "boolean", "description": "Indicates whether caller ID is enabled for this number.", "readOnly": true }, "call_recording_enabled": { "type": "boolean", "description": "Indicates whether call recording is enabled for this number.", "readOnly": true }, "t38_fax_gateway_enabled": { "type": "boolean", "description": "Indicates whether T38 Fax Gateway for inbound calls to this number.", "readOnly": true }, "purchased_at": { "type": "string", "description": "ISO 8601 formatted date indicating the time the request was made to purchase the number.", "readOnly": true }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the time it took to activate after the purchase.", "readOnly": true }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "readOnly": true }, "number_level_routing": { "type": "string", "description": "Deprecated field, the only value for this is 'disabled'. All routing for numbers should be configured via connection settings.", "enum": [ "disabled" ], "default": "disabled" }, "phone_number_type": { "type": "string", "description": "The phone number's type.", "enum": [ "local", "toll_free", "mobile", "national", "shared_cost", "landline" ], "readOnly": true } } }, "PhoneNumberDetailed": { "type": "object", "example": { "id": "1293384261075731499", "record_type": "phone_number", "phone_number": "+19705555098", "status": "active", "tags": [ "tag_1", "tag_2" ], "external_pin": "1234", "connection_id": "1293384261075731499", "connection_name": "connection-name", "customer_reference": "customer-reference", "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000", "messaging_profile_name": "regional-customers", "billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323", "emergency_enabled": true, "emergency_address_id": "1315261609962112019", "call_forwarding_enabled": true, "cnam_listing_enabled": true, "caller_id_name_enabled": true, "call_recording_enabled": true, "t38_fax_gateway_enabled": true, "number_level_routing": "disabled", "phone_number_type": "local", "inbound_call_screening": "disabled", "purchased_at": "2019-10-23T18:10:00.000Z", "created_at": "2019-10-23T18:10:00.000Z", "updated_at": "2019-10-24T18:10:00.000Z", "hd_voice_enabled": true }, "properties": { "id": { "$ref": "#/components/schemas/IntId" }, "record_type": { "type": "string", "example": "phone_number", "description": "Identifies the type of the resource.", "readOnly": true }, "phone_number": { "type": "string", "description": "The +E.164-formatted phone number associated with this record.", "readOnly": true }, "status": { "type": "string", "description": "The phone number's current status.", "enum": [ "purchase-pending", "purchase-failed", "port-pending", "port-failed", "active", "deleted", "emergency-only", "ported-out", "port-out-pending" ], "readOnly": true }, "tags": { "type": "array", "description": "A list of user-assigned tags to help manage the phone number.", "items": { "type": "string" } }, "external_pin": { "type": "string", "description": "If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism." }, "connection_name": { "type": "string", "description": "The user-assigned name of the connection to be associated with this phone number.", "readOnly": true }, "connection_id": { "type": "string", "description": "Identifies the connection associated with the phone number." }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "messaging_profile_id": { "type": "string", "description": "Identifies the messaging profile associated with the phone number." }, "messaging_profile_name": { "type": "string", "description": "The name of the messaging profile associated with the phone number.", "example": "regional-customers" }, "billing_group_id": { "type": "string", "description": "Identifies the billing group associated with the phone number." }, "emergency_enabled": { "type": "boolean", "description": "Indicates whether emergency services are enabled for this number.", "readOnly": true }, "emergency_address_id": { "type": "string", "format": "int64", "description": "Identifies the emergency address associated with the phone number.", "readOnly": true }, "call_forwarding_enabled": { "type": "boolean", "default": true, "description": "Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.", "readOnly": true }, "cnam_listing_enabled": { "type": "boolean", "description": "Indicates whether a CNAM listing is enabled for this number.", "readOnly": true }, "caller_id_name_enabled": { "type": "boolean", "description": "Indicates whether caller ID is enabled for this number.", "readOnly": true }, "call_recording_enabled": { "type": "boolean", "description": "Indicates whether call recording is enabled for this number.", "readOnly": true }, "t38_fax_gateway_enabled": { "type": "boolean", "description": "Indicates whether T38 Fax Gateway for inbound calls to this number.", "readOnly": true }, "purchased_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was purchased.", "readOnly": true }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "readOnly": true }, "number_level_routing": { "type": "string", "description": "Deprecated field, the only value for this is 'disabled'. All routing for numbers should be configured via connection settings.", "enum": [ "disabled" ], "default": "disabled" }, "phone_number_type": { "type": "string", "description": "The phone number's type.\nNote: For numbers purchased prior to July 2023 or when fetching a number's details immediately after a purchase completes, the legacy values `tollfree`, `shortcode` or `longcode` may be returned instead.", "enum": [ "local", "toll_free", "mobile", "national", "shared_cost", "landline", "tollfree", "shortcode", "longcode" ], "readOnly": true }, "inbound_call_screening": { "type": "string", "enum": [ "disabled", "reject_calls", "flag_calls" ], "default": "disabled", "description": "The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it." } } }, "PhoneNumberEnableEmergencyRequest": { "type": "object", "required": [ "emergency_enabled", "emergency_address_id" ], "properties": { "emergency_enabled": { "type": "boolean", "description": "Indicates whether to enable emergency services on this number." }, "emergency_address_id": { "type": "string", "format": "int64", "description": "Identifies the address to be used with emergency services." } }, "example": { "emergency_enabled": true, "emergency_address_id": "53829456729313" } }, "PhoneNumberStatus": { "properties": { "phoneNumber": { "description": "A phone number that is intended to be linked to a campaign.", "example": "+12193849584", "title": "Phonenumber", "type": "string" }, "status": { "allOf": [ { "$ref": "#/components/schemas/AssignmentStatus" } ], "description": "The current status of the phone number.", "example": "pending" }, "assigned_at": { "description": "The date and time that the this phone number was assigned.", "example": "2021-06-30T10:49:04-07:00", "format": "date-time", "title": "Assigned At", "type": "string" }, "error": { "description": "Errors related to an individual phone number assignment.", "example": "Detailed error description here.", "title": "Error", "type": "string" } }, "required": [ "phoneNumber", "status" ], "title": "PhoneNumberStatus", "type": "object" }, "PhoneNumberStatusResponsePaginated": { "title": "PhoneNumberStatusResponsePaginated", "required": [ "records", "meta" ], "type": "object", "properties": { "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/ProfileAssignmentPhoneNumbers" } } } }, "PhoneNumberWithMessagingSettings": { "type": "object", "example": { "record_type": "messaging_settings", "id": "1293384261075731499", "phone_number": "+18005550001", "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "created_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z", "country_code": "US", "type": "toll-free", "health": { "message_count": 122, "inbound_outbound_ratio": 0.43, "success_ratio": 0.94, "spam_ratio": 0.06 }, "eligible_messaging_products": [ "A2P" ], "traffic_type": "A2P", "messaging_product": "A2P", "features": { "sms": { "domestic_two_way": true, "international_inbound": true, "international_outbound": true }, "mms": null } }, "properties": { "record_type": { "type": "string", "example": "messaging_settings", "enum": [ "messaging_phone_number", "messaging_settings" ], "description": "Identifies the type of the resource.", "readOnly": true }, "id": { "type": "string", "description": "Identifies the type of resource.", "readOnly": true }, "phone_number": { "type": "string", "format": "e164", "description": "+E.164 formatted phone number.", "readOnly": true }, "messaging_profile_id": { "type": "string", "nullable": true, "description": "Unique identifier for a messaging profile." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "readOnly": true }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code.", "pattern": "^[A-Z]{2}$", "example": "US", "readOnly": true }, "type": { "type": "string", "description": "The type of the phone number", "enum": [ "long-code", "toll-free", "short-code", "longcode", "tollfree", "shortcode" ], "readOnly": true }, "health": { "$ref": "#/components/schemas/NumberHealthMetrics" }, "eligible_messaging_products": { "type": "array", "description": "The messaging products that this number can be registered to use", "readOnly": true, "items": { "type": "string" } }, "traffic_type": { "type": "string", "description": "The messaging traffic or use case for which the number is currently configured.", "example": "P2P", "readOnly": true }, "messaging_product": { "type": "string", "description": "The messaging product that the number is registered to use", "example": "P2P" }, "features": { "type": "object", "readOnly": true, "properties": { "sms": { "$ref": "#/components/schemas/MessagingFeatureSet" }, "mms": { "$ref": "#/components/schemas/MessagingFeatureSet" } } } } }, "PhoneNumberWithVoiceSettings": { "type": "object", "properties": { "id": { "type": "string", "example": "1293384261075731499", "description": "Identifies the type of resource.", "readOnly": true }, "record_type": { "type": "string", "example": "voice_settings", "description": "Identifies the type of the resource.", "readOnly": true }, "phone_number": { "type": "string", "example": "+13035551234", "description": "The phone number in +E164 format.", "readOnly": true }, "connection_id": { "type": "string", "example": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b", "description": "Identifies the connection associated with this phone number." }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "tech_prefix_enabled": { "type": "boolean", "default": false, "example": false, "description": "Controls whether a tech prefix is enabled for this phone number." }, "translated_number": { "type": "string", "example": "+13035559999", "default": "", "description": "This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed." }, "call_forwarding": { "$ref": "#/components/schemas/CallForwarding" }, "cnam_listing": { "$ref": "#/components/schemas/CnamListing" }, "emergency": { "$ref": "#/components/schemas/EmergencySettings" }, "usage_payment_method": { "type": "string", "enum": [ "pay-per-minute", "channel" ], "default": "pay-per-minute", "example": "pay-per-minute", "description": "Controls whether a number is billed per minute or uses your concurrent channels." }, "media_features": { "$ref": "#/components/schemas/MediaFeatures" }, "call_recording": { "$ref": "#/components/schemas/CallRecording" }, "inbound_call_screening": { "type": "string", "enum": [ "disabled", "reject_calls", "flag_calls" ], "default": "disabled", "description": "The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it." } }, "example": { "id": "1293384261075731499", "record_type": "voice_settings", "connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b", "customer_reference": "customer-reference", "tech_prefix_enabled": false, "translated_number": "+13035559999", "call_forwarding": { "call_forwarding_enabled": true, "forwards_to": "+13035559123", "forwarding_type": "always" }, "cnam_listing": { "cnam_listing_enabled": true, "cnam_listing_details": "example" }, "emergency": { "emergency_enabled": true, "emergency_address_id": "1315261609962112019" }, "usage_payment_method": "pay-per-minute", "media_features": { "rtp_auto_adjust_enabled": true, "accept_any_rtp_packets_enabled": true, "t38_fax_gateway_enabled": true }, "call_recording": { "inbound_call_recording_enabled": true, "inbound_call_recording_format": "wav", "inbound_call_recording_channels": "single" }, "inbound_call_screening": "disabled" } }, "PhoneNumbersBulkUpdateError": { "properties": { "phone_number": { "type": "string", "description": "The phone number in e164 format.", "format": "e164" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "PhoneNumbersJob": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "description": "Identifies the resource.", "readOnly": true }, "record_type": { "type": "string", "example": "phone_numbers_job", "description": "Identifies the type of the resource.", "readOnly": true }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "failed", "expired" ], "default": "pending", "example": "pending", "description": "Indicates the completion status of the background update.", "readOnly": true }, "type": { "type": "string", "enum": [ "update_emergency_settings", "delete_phone_numbers", "update_phone_numbers" ], "example": "update_emergency_settings", "description": "Identifies the type of the background job.", "readOnly": true }, "etc": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the estimated time of completion of the background job.", "readOnly": true }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "readOnly": true }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "readOnly": true }, "phone_numbers": { "type": "array", "items": { "description": "The unique phone numbers given as arguments in the job creation.", "$ref": "#/components/schemas/PhoneNumbersJobPhoneNumber" } }, "successful_operations": { "type": "array", "items": { "description": "The phone numbers successfully updated.", "$ref": "#/components/schemas/PhoneNumbersJobSuccessfulOperation" }, "readOnly": true }, "pending_operations": { "type": "array", "items": { "description": "The phone numbers pending confirmation on update results. Entries in this list are transient, and will be moved to either successful_operations or failed_operations once the processing is done.", "$ref": "#/components/schemas/PhoneNumbersJobPendingOperation" }, "readOnly": true }, "failed_operations": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumbersJobFailedOperation" }, "readOnly": true } }, "example": { "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7", "record_type": "phone_numbers_job", "status": "pending", "type": "update_emergency_settings", "etc": "2020-10-30T18:10:00.000Z", "created_at": "2020-10-23T18:10:00.000Z", "updated_at": "2020-10-23T18:10:01.000Z", "phone_numbers": [ { "id": "2637816387126861836" }, { "phone_number": "+19715555098" }, { "phone_number": "+19705555099" }, { "id": "3388768018273" } ], "successful_operations": [ { "id": "2637816387126861836", "phone_number": "+19705555098" }, { "id": "33081887126861836", "phone_number": "+19715555098" } ], "pending_operations": [ { "id": "2637816387126861837", "phone_number": "+19705555099" } ], "failed_operations": [ { "id": "3388768018273", "phone_number": "+19705551234", "errors": [ { "code": "10015", "title": "Bad Request", "detail": "The field is invalid.", "source": "/emergency_address_id" } ] } ] } }, "PhoneNumbersJobDeletePhoneNumbersRequest": { "type": "object", "required": [ "phone_numbers" ], "properties": { "phone_numbers": { "type": "array", "items": { "description": "Array of phone number ids and/or phone numbers in E164 format to update", "type": "string" } } }, "example": { "phone_numbers": [ "+19705555098", "+19715555098", "32873127836" ] } }, "PhoneNumbersJobFailedOperation": { "properties": { "phone_number": { "type": "string", "description": "The phone number in e164 format.", "format": "e164" }, "id": { "type": "string", "format": "int64", "description": "The phone number's ID" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "PhoneNumbersJobPendingOperation": { "properties": { "phone_number": { "type": "string", "description": "The phone number in e164 format.", "format": "e164" }, "id": { "type": "string", "format": "int64", "description": "The phone number's ID" } } }, "PhoneNumbersJobPhoneNumber": { "properties": { "phone_number": { "type": "string", "description": "The phone number in e164 format.", "format": "e164", "example": "+19705555000" }, "id": { "type": "string", "format": "int64", "description": "The phone number's ID" } } }, "PhoneNumbersJobSuccessfulOperation": { "properties": { "phone_number": { "type": "string", "description": "The phone number in e164 format.", "format": "e164" }, "id": { "type": "string", "format": "int64", "description": "The phone number's ID" } } }, "PhoneNumbersJobUpdateEmergencySettingsRequest": { "type": "object", "required": [ "emergency_enabled", "emergency_address_id", "phone_numbers" ], "properties": { "phone_numbers": { "type": "array", "items": { "description": "Array of phone number ids and/or phone numbers in E164 format to update", "type": "string" } }, "emergency_enabled": { "type": "boolean", "description": "Indicates whether to enable emergency services on this number." }, "emergency_address_id": { "type": "string", "format": "int64", "description": "Identifies the address to be used with emergency services." } }, "example": { "emergency_enabled": true, "emergency_address_id": "53829456729313", "phone_numbers": [ "+19705555098", "+19715555098", "32873127836" ] } }, "PhoneNumbersJobUpdatePhoneNumbersRequest": { "type": "object", "required": [ "phone_numbers" ], "properties": { "phone_numbers": { "type": "array", "description": "Array of phone number ids and/or phone numbers in E164 format to update", "items": { "type": "string" } }, "tags": { "type": "array", "description": "A list of user-assigned tags to help organize phone numbers.", "items": { "type": "string" } }, "external_pin": { "type": "string", "description": "If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism." }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "connection_id": { "type": "string", "description": "Identifies the connection associated with the phone number." }, "billing_group_id": { "type": "string", "description": "Identifies the billing group associated with the phone number." }, "voice": { "$ref": "#/components/schemas/UpdatePhoneNumberVoiceSettingsRequest" } }, "example": { "phone_numbers": [ "1583466971586889004", "+13127367254" ], "tags": [ "tag" ], "external_pin": "123456", "customer_reference": "customer-reference", "connection_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "billing_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "voice": { "call_forwarding": { "call_forwarding_enabled": true, "forwards_to": "+13035559123", "forwarding_type": "always" } } } }, "PlayAudioUrlRequest": { "type": "object", "title": "Play Audio URL Request", "properties": { "audio_url": { "type": "string", "example": "http://example.com/message.wav", "description": "The URL of a file to be played back on the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played back on the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file." }, "loop": { "description": "The number of times the audio file should be played. If supplied, the value must be an integer between 1 and 100, or the special string `infinity` for an endless loop.", "$ref": "#/components/schemas/Loopcount", "example": "infinity", "default": 1 }, "overlay": { "description": "When enabled, audio will be mixed on top of any other audio that is actively being played back. Note that `overlay: true` will only work if there is another audio file already being played on the call.", "type": "boolean", "example": true, "default": false }, "stop": { "description": "When specified, it stops the current audio being played. Specify `current` to stop the current audio being played, and to play the next file in the queue. Specify `all` to stop the current audio file being played and to also clear all audio files from the queue.", "type": "string", "example": "current" }, "target_legs": { "description": "Specifies the leg or legs on which audio will be played. If supplied, the value must be either `self`, `opposite` or `both`.", "type": "string", "default": "self", "example": "self" }, "cache_audio": { "description": "Caches the audio file. Useful when playing the same audio file multiple times during the call.", "type": "boolean", "default": true, "example": true }, "audio_type": { "description": "Specifies the type of audio provided in `audio_url` or `playback_content`.", "type": "string", "enum": [ "mp3", "wav" ], "default": "mp3", "example": "wav" }, "playback_content": { "description": "Allows a user to provide base64 encoded mp3 or wav. Note: when using this parameter, `media_url` and `media_name` in the `playback_started` and `playback_ended` webhooks will be empty", "type": "string", "example": "SUQzAwAAAAADf1..." }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "audio_url": "http://www.example.com/sounds/greeting.wav", "loop": "infinity", "overlay": true, "stop": "current", "target_legs": "self", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "PlaybackStopRequest": { "type": "object", "title": "Playback Stop Request", "properties": { "overlay": { "description": "When enabled, it stops the audio being played in the overlay queue.", "type": "boolean", "example": true, "default": false }, "stop": { "description": "Use `current` to stop the current audio being played. Use `all` to stop the current audio file being played and clear all audio files from the queue.", "type": "string", "example": "current", "default": "all" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "overlay": false, "stop": "all", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "PortOutSupportingDocument": { "required": [ "id", "record_type", "type", "portout_id", "document_id", "created_at", "updated_at" ], "properties": { "id": { "type": "string", "format": "uuid", "example": "5a16902a-2ee9-4882-a247-420fc6627b62" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "supporting_document" }, "type": { "type": "string", "enum": [ "loa", "invoice" ], "description": "Identifies the type of the document", "readOnly": true, "example": "loa" }, "portout_id": { "type": "string", "format": "uuid", "description": "Identifies the associated port request", "readOnly": true, "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "document_id": { "format": "uuid", "type": "string", "description": "Identifies the associated document", "example": "f1c5e079-9d82-4f50-95bc-ae2f6b8d84d7" }, "created_at": { "type": "string", "description": "Supporting document creation timestamp in ISO 8601 format", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "Supporting document last changed timestamp in ISO 8601 format", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "id": "5a16902a-2ee9-4882-a247-420fc6627b62", "record_type": "supporting_document", "type": "loa", "portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "document_id": "f1c5e079-9d82-4f50-95bc-ae2f6b8d84d7", "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z" } }, "Portability": { "type": "object", "properties": { "lrn": { "type": "string", "description": "Local Routing Number, if assigned to the requested phone number", "example": "2245701999" }, "ported_status": { "type": "string", "description": "Indicates whether or not the requested phone number has been ported", "enum": [ "Y", "N", "" ], "example": "Y" }, "ported_date": { "type": "string", "description": "ISO-formatted date when the requested phone number has been ported", "example": "2017-10-20" }, "ocn": { "type": "string", "description": "Operating Company Name (OCN) as per the Local Exchange Routing Guide (LERG) database", "example": "073H" }, "line_type": { "type": "string", "description": "Type of number", "example": "voip" }, "spid": { "type": "string", "description": "SPID (Service Provider ID)", "example": "073H" }, "spid_carrier_name": { "type": "string", "description": "Service provider name", "example": "Telnyx/4" }, "spid_carrier_type": { "type": "string", "description": "Service provider type", "example": "3" }, "altspid": { "type": "string", "description": "Alternative SPID (Service Provider ID). Often used when a carrier is using a number from another carrier", "example": "073H" }, "altspid_carrier_name": { "type": "string", "description": "Alternative service provider name", "example": "Telnyx/4" }, "altspid_carrier_type": { "type": "string", "description": "Alternative service provider type", "example": "3" }, "city": { "type": "string", "description": "City name extracted from the locality in the Local Exchange Routing Guide (LERG) database", "example": "WAUKEGAN" }, "state": { "type": "string", "example": "Illinois" } } }, "PortabilityCheckDetails": { "type": "object", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "portability_check_result" }, "fast_portable": { "type": "boolean", "description": "Indicates whether this phone number is FastPort eligible", "example": true, "readOnly": true }, "not_portable_reason": { "type": "string", "description": "If this phone number is not portable, explains why. Empty string if the number is portable.", "example": "No coverage", "readOnly": true }, "phone_number": { "type": "string", "description": "The +E.164 formatted phone number this result is about", "example": "+13125550123", "readOnly": true }, "portable": { "type": "boolean", "description": "Indicates whether this phone number is portable", "example": true, "readOnly": true } } }, "PortabilityStatus": { "type": "string", "description": "Specifies whether Telnyx is able to confirm portability this number in the United States & Canada. International phone numbers are provisional by default.", "enum": [ "pending", "confirmed", "provisional" ], "example": "confirmed" }, "PortingAdditionalDocument": { "type": "object", "properties": { "id": { "type": "string", "description": "Uniquely identifies this additional document", "format": "uuid", "example": "eef3340b-8903-4466-b445-89b697315a3a" }, "document_type": { "type": "string", "description": "Identifies the type of additional document", "enum": [ "loa", "invoice", "csr", "other" ], "example": "loa" }, "document_id": { "type": "string", "format": "uuid", "description": "Identifies the associated document", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "filename": { "type": "string", "description": "The filename of the related document.", "example": "file.txt" }, "content_type": { "type": "string", "description": "The content type of the related document.", "example": "text/plain" }, "porting_order_id": { "type": "string", "format": "uuid", "description": "Identifies the associated porting order", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "record_type": { "type": "string", "example": "porting_additional_document", "description": "Identifies the type of the resource.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527000Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2021-03-19T10:07:15.527000Z" } } }, "PortingLOAConfiguration": { "type": "object", "properties": { "id": { "type": "string", "description": "Uniquely identifies the LOA configuration.", "format": "uuid", "example": "eef3340b-8903-4466-b445-89b697315a3a" }, "company_name": { "type": "string", "description": "The name of the company", "example": "Telnyx" }, "organization_id": { "type": "string", "description": "The organization that owns the LOA configuration", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "name": { "type": "string", "description": "The name of the LOA configuration", "example": "My LOA Configuration" }, "logo": { "type": "object", "description": "The logo to be used in the LOA.", "properties": { "document_id": { "type": "string", "format": "uuid", "description": "Identifies the document that contains the logo.", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "content_type": { "type": "string", "description": "The content type of the logo.", "enum": [ "image/png" ], "example": "image/png" } } }, "address": { "type": "object", "description": "The address of the company.", "properties": { "street_address": { "type": "string", "description": "The street address of the company", "example": "311 W. Superior St" }, "extended_address": { "type": "string", "description": "The extended address of the company", "example": "Suite 504" }, "city": { "type": "string", "description": "The locality of the company", "example": "Chicago" }, "state": { "type": "string", "description": "The administrative area of the company", "example": "IL", "pattern": "^[A-Z]{2}$" }, "zip_code": { "type": "string", "description": "The postal code of the company", "example": "60654", "pattern": "^[0-9]{5}(?:-[0-9]{4})?$" }, "country_code": { "type": "string", "description": "The country code of the company", "example": "US", "pattern": "^[A-Z]{2}$" } } }, "contact": { "type": "object", "description": "The contact information of the company.", "properties": { "email": { "type": "string", "description": "The email address of the contact", "example": "testing@telnyx.com", "format": "email" }, "phone_number": { "type": "string", "description": "The phone number of the contact", "example": "+12003270001", "pattern": "^\\+\\d{11,15}$" } } }, "record_type": { "type": "string", "example": "porting_loa_configuration", "description": "Identifies the type of the resource.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527000Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2021-03-19T10:07:15.527000Z" } } }, "PortingOrder": { "type": "object", "properties": { "id": { "description": "Uniquely identifies this porting order", "type": "string", "format": "uuid", "example": "f1486bae-f067-460c-ad43-73a92848f902", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer-specified reference number for customer bookkeeping purposes", "example": "Acct 123abc" }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527Z", "readOnly": true }, "status": { "$ref": "#/components/schemas/PortingOrderStatus" }, "support_key": { "type": "string", "description": "A key to reference this porting order when contacting Telnyx customer support. This information is not available in draft porting orders.", "example": "sr_123abc", "readOnly": true }, "parent_support_key": { "type": "string", "description": "A key to reference for the porting order group when contacting Telnyx customer support. This information is not available for porting orders in `draft` state", "example": "pr_123abc", "readOnly": true }, "porting_phone_numbers_count": { "type": "integer", "description": "Count of phone numbers associated with this porting order", "example": 1, "readOnly": true }, "old_service_provider_ocn": { "type": "string", "description": "Identifies the old service provider", "example": "Unreal Communications", "readOnly": true }, "documents": { "$ref": "#/components/schemas/PortingOrderDocuments" }, "misc": { "$ref": "#/components/schemas/PortingOrderMisc" }, "end_user": { "$ref": "#/components/schemas/PortingOrderEndUser" }, "activation_settings": { "$ref": "#/components/schemas/PortingOrderActivationSettings" }, "phone_number_configuration": { "$ref": "#/components/schemas/PortingOrderPhoneNumberConfiguration" }, "phone_number_type": { "type": "string", "description": "The type of the phone number", "example": "local", "enum": [ "landline", "local", "mobile", "national", "shared_cost", "toll_free" ] }, "description": { "type": "string", "description": "A description of the porting order", "example": "FP Telnyx", "readOnly": true }, "requirements": { "type": "array", "description": "List of documentation requirements for porting numbers.", "items": { "$ref": "#/components/schemas/PortingOrderRequirement" } }, "requirements_met": { "type": "boolean", "description": "Is true when the required documentation is met", "example": false }, "user_feedback": { "$ref": "#/components/schemas/PortingOrderUserFeedback" }, "user_id": { "type": "string", "format": "uuid", "description": "Identifies the user (or organization) who requested the porting order", "example": "40d68ba2-0847-4df2-be9c-b0e0cb673e75" }, "webhook_url": { "type": "string", "format": "uri", "example": "https://example.com/porting_webhooks" }, "record_type": { "type": "string", "example": "porting_order", "description": "Identifies the type of the resource.", "readOnly": true } } }, "PortingOrderActivationSettings": { "type": "object", "properties": { "foc_datetime_requested": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted Date/Time requested for the FOC date", "example": "2021-03-19T10:07:15.527Z" }, "foc_datetime_actual": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted Date/Time of the FOC date", "example": "2021-03-19T10:07:15.527Z" }, "fast_port_eligible": { "type": "boolean", "readOnly": true, "description": "Indicates whether this porting order is eligible for FastPort", "example": true }, "activation_status": { "$ref": "#/components/schemas/PortingOrderActivationStatus" } } }, "PortingOrderActivationStatus": { "type": "string", "description": "Activation status", "enum": [ "New", "Pending", "Conflict", "Cancel Pending", "Failed", "Concurred", "Activate RDY", "Disconnect Pending", "Concurrence Sent", "Old", "Sending", "Active", "Canceled" ], "example": "Active" }, "PortingOrderDocuments": { "type": "object", "properties": { "loa": { "type": "string", "format": "uuid", "description": "Returned ID of the submitted LOA via the Documents endpoint", "example": "64ffb720-04c7-455b-92d6-20fcca92e935" }, "invoice": { "type": "string", "format": "uuid", "description": "Returned ID of the submitted Invoice via the Documents endpoint", "example": "ce74b771-d23d-4960-81ec-8741b3862146" } } }, "PortingOrderEndUser": { "type": "object", "properties": { "admin": { "$ref": "#/components/schemas/PortingOrderEndUserAdmin" }, "location": { "$ref": "#/components/schemas/PortingOrderEndUserLocation" } } }, "PortingOrderEndUserAdmin": { "type": "object", "properties": { "entity_name": { "type": "string", "description": "Person Name or Company name requesting the port", "example": "Porter McPortersen" }, "auth_person_name": { "type": "string", "description": "Name of person authorizing the porting order", "example": "Porter McPortersen II" }, "billing_phone_number": { "type": "string", "description": "Billing phone number associated with these phone numbers", "example": 13035551234 }, "account_number": { "type": "string", "description": "The authorized person's account number with the current service provider", "example": "123abc" }, "tax_identifier": { "type": "string", "description": "European tax identification number. Applicable only in the European Union", "example": "1234abcd" }, "pin_passcode": { "type": "string", "description": "PIN/passcode possibly required by the old service provider for extra verification", "example": 1234 }, "business_identifier": { "type": "string", "description": "European business identification number. Applicable only in the European Union", "example": "abc123" } } }, "PortingOrderEndUserLocation": { "type": "object", "properties": { "street_address": { "type": "string", "description": "First line of billing address", "example": "311 W. Superior St" }, "extended_address": { "type": "string", "description": "Second line of billing address", "example": "Suite 504" }, "locality": { "type": "string", "description": "City or municipality of billing address", "example": "Chicago" }, "administrative_area": { "type": "string", "description": "State, province, or similar of billing address", "example": "IL" }, "postal_code": { "type": "string", "description": "Postal Code of billing address", "example": "60654" }, "country_code": { "type": "string", "description": "ISO3166-1 alpha-2 country code of billing address", "example": "US" } } }, "PortingOrderMisc": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PortingOrderType" }, "remaining_numbers_action": { "type": "string", "description": "Remaining numbers can be either kept with their current service provider or disconnected. 'new_billing_telephone_number' is required when 'remaining_numbers_action' is 'keep'.", "enum": [ "keep", "disconnect" ], "example": "disconnect" }, "new_billing_phone_number": { "type": "string", "description": "New billing phone number for the remaining numbers. Used in case the current billing phone number is being ported to Telnyx. This will be set on your account with your current service provider and should be one of the numbers remaining on that account." } } }, "PortingOrderPhoneNumberConfiguration": { "type": "object", "properties": { "billing_group_id": { "type": "string", "description": "identifies the billing group to set on the numbers when ported", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "connection_id": { "type": "string", "description": "identifies the connection to set on the numbers when ported", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "messaging_profile_id": { "type": "string", "description": "identifies the messaging profile to set on the numbers when ported", "example": "f1486bae-f067-460c-ad43-73a92848f901" }, "emergency_address_id": { "type": "string", "description": "identifies the emergency address to set on the numbers when ported", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "tags": { "type": "array", "items": { "type": "string", "description": "Tag to set on the numbers when ported" }, "example": [ "abc", "123" ] } } }, "PortingOrderRequirement": { "type": "object", "properties": { "field_type": { "type": "string", "description": "Type of value expected on field_value field", "enum": [ "document" ], "example": "document" }, "field_value": { "type": "string", "description": "identifies the document that satisfies this requirement", "example": "9787fb5f-cbe5-4de4-b765-3303774ee9fe" }, "requirement_type_id": { "type": "string", "description": "Identifies the requirement type that meets this requirement", "example": "59b0762a-b274-4f76-ac32-4d5cf0272e66" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "porting_requirement" } } }, "PortingOrderRequirementDetail": { "type": "object", "properties": { "field_type": { "type": "string", "description": "Type of value expected on field_value field", "enum": [ "document", "textual" ], "example": "document" }, "field_value": { "type": "string", "description": "Identifies the document that satisfies this requirement", "example": "9787fb5f-cbe5-4de4-b765-3303774ee9fe" }, "requirement_type": { "type": "object", "description": "Identifies the requirement type that meets this requirement", "properties": { "acceptance_criteria": { "type": "object", "description": "The acceptance criteria for the requirement type", "example": { "acceptable_values": [] } }, "description": { "type": "string", "description": "A description of the requirement type", "example": "A copy of the latest phone bill from the current provider" }, "example": { "type": "string", "description": "An example of the requirement type", "example": "Most recent phone bill" }, "id": { "type": "string", "description": "Identifies the requirement type", "example": "53970723-fbff-4f46-a975-f62be6c1a585" }, "name": { "type": "string", "description": "The name of the requirement type", "example": "Latest Invoice" }, "type": { "type": "string", "description": "The type of the requirement type", "example": "document" } } }, "requirement_status": { "type": "string", "description": "Status of the requirement", "example": "approved" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "porting_requirement" } } }, "PortingOrderSharingToken": { "type": "object", "properties": { "id": { "type": "string", "description": "Uniquely identifies this sharing token", "format": "uuid", "example": "0a4b78a0-d416-4761-94f7-46c72ec56547" }, "porting_order_id": { "type": "string", "format": "uuid", "description": "Identifies the porting order resource being shared", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "expires_in_seconds": { "type": "integer", "minimum": 1, "description": "The number of seconds until the sharing token expires", "example": 3600 }, "permissions": { "type": "array", "description": "The permissions granted to the sharing token", "items": { "type": "string", "enum": [ "porting_order.document.read", "porting_order.document.update" ] }, "example": [ "porting_order.document.read", "porting_order.document.update" ] }, "token": { "type": "string", "description": "A signed JWT token that can be used to access the shared resource", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2ODk4OTQ2NzcsImlzdCI6MTY4OTg5MTA3NywicGVybWlzc2lvbnMiOlsicG9ydGluZ19vcmRlci5kb2N1bWVudC5yZWFkIl0sInBvcnRpbmdfb3JkZXJfaWQiOiJmZDRiODZjOC00OTdkLTRjNmQtOTYwOS1hNzg5ZTRlMTRjZmUifQ.CT0HRF6OLj7VPZ8p5Y_0S8rOL8SEUznwJJkR-YReKwc" }, "expires_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the sharing token expires.", "example": "2021-03-19T10:07:15.527000Z" }, "record_type": { "type": "string", "example": "porting_order_sharing_token", "description": "Identifies the type of the resource.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527000Z" } } }, "PortingOrderStatus": { "type": "object", "description": "Porting order status", "properties": { "details": { "type": "array", "items": { "$ref": "#/components/schemas/PortingOrdersExceptionType" }, "description": "A list of 0 or more details about this porting order's status" }, "value": { "type": "string", "description": "The current status of the porting order", "example": "ported", "enum": [ "draft", "in-process", "submitted", "exception", "foc-date-confirmed", "ported", "canceled", "cancel-pending" ] } } }, "PortingOrderType": { "type": "string", "description": "A port can be either 'full' or 'partial'. When type is 'full' the other attributes should be omitted.", "enum": [ "full", "partial" ], "example": "full" }, "PortingOrderUserFeedback": { "type": "object", "properties": { "user_rating": { "type": "integer", "description": "Once an order is ported, cancellation is requested or the request is canceled, the user may rate their experience", "example": 5 }, "user_comment": { "type": "string", "description": "A comment related to the customer rating.", "example": "I loved my experience porting numbers with Telnyx" } } }, "PortingOrdersActivationJob": { "type": "object", "properties": { "id": { "description": "Uniquely identifies this activation job", "type": "string", "format": "uuid", "example": "f1486bae-f067-460c-ad43-73a92848f902", "readOnly": true }, "status": { "type": "string", "description": "Specifies the status of this activation job", "enum": [ "created", "in-process", "completed", "failed" ] }, "activation_type": { "type": "string", "description": "Specifies the type of this activation job", "enum": [ "scheduled", "on-demand" ] }, "activate_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the activation job should be executed. This time should be between some activation window.", "example": "2021-03-19T10:07:15.527Z" }, "activation_windows": { "type": "array", "description": "List of allowed activation windows for this activation job", "items": { "type": "object", "properties": { "start_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the activation window starts", "example": "2021-03-19T10:07:15.527Z" }, "end_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the activation window ends", "example": "2021-03-19T10:07:15.527Z" } } } }, "record_type": { "type": "string", "example": "porting_activation_job", "description": "Identifies the type of the resource.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527Z", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527Z", "readOnly": true } } }, "PortingOrdersAllowedFocWindow": { "type": "object", "title": "PortingOrdersAllowedFocWindow", "properties": { "started_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating the start of the range of foc window.", "example": "2021-03-19T10:07:15.527Z", "readOnly": true }, "ended_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating the end of the range of foc window", "example": "2021-03-19T10:07:15.527Z", "readOnly": true }, "record_type": { "type": "string", "example": "porting_order", "description": "Identifies the type of the resource.", "readOnly": true } } }, "PortingOrdersComment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "body": { "type": "string", "description": "Body of comment", "example": "Great experience so far" }, "porting_order_id": { "type": "string", "format": "uuid", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "user_type": { "type": "string", "description": "Indicates whether this comment was created by a Telnyx Admin, user, or system", "enum": [ "admin", "user", "system" ], "example": "user" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "porting_comment" }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527Z" } } }, "PortingOrdersExceptionType": { "type": "object", "properties": { "code": { "type": "string", "description": "Identifier of an exception type", "enum": [ "ACCOUNT_NUMBER_MISMATCH", "AUTH_PERSON_MISMATCH", "BTN_ATN_MISMATCH", "ENTITY_NAME_MISMATCH", "FOC_EXPIRED", "FOC_REJECTED", "LOCATION_MISMATCH", "LSR_PENDING", "MAIN_BTN_PORTING", "OSP_IRRESPONSIVE", "OTHER", "PASSCODE_PIN_INVALID", "PHONE_NUMBER_HAS_SPECIAL_FEATURE", "PHONE_NUMBER_MISMATCH", "PHONE_NUMBER_NOT_PORTABLE", "PORT_TYPE_INCORRECT", "PORTING_ORDER_SPLIT_REQUIRED", "PORTING_ORDER_SPLIT_REQUIRED", "POSTAL_CODE_MISMATCH", "RATE_CENTER_NOT_PORTABLE", "SV_CONFLICT", "SV_UNKNOWN_FAILURE" ], "example": "ENTITY_NAME_MISMATCH" }, "description": { "type": "string", "description": "Description of an exception type", "example": "Entity name does not match that on the CSR" } } }, "PortingPhoneNumber": { "type": "object", "properties": { "porting_order_status": { "type": "string", "description": "The current status of the porting order", "enum": [ "draft", "in-process", "submitted", "exception", "foc-date-confirmed", "cancel-pending", "ported", "cancelled" ], "example": "in-process" }, "phone_number_type": { "type": "string", "description": "The type of the phone number", "enum": [ "landline", "local", "mobile", "national", "shared_cost", "toll_free" ], "example": "local" }, "phone_number": { "type": "string", "description": "E164 formatted phone number", "example": 13035550987 }, "porting_order_id": { "type": "string", "format": "uuid", "description": "Identifies the associated port request", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "support_key": { "type": "string", "description": "A key to reference this porting order when contacting Telnyx customer support", "example": "sr_a12345" }, "activation_status": { "$ref": "#/components/schemas/PortingOrderActivationStatus" }, "portability_status": { "$ref": "#/components/schemas/PortabilityStatus" }, "requirements_status": { "type": "string", "description": "The current status of the requirements in a INTL porting order", "enum": [ "requirement-info-pending", "requirement-info-under-review", "requirement-info-exception", "approved" ], "example": "approved" }, "record_type": { "type": "string", "example": "porting_phone_number", "description": "Identifies the type of the resource.", "readOnly": true } } }, "PortingPhoneNumberConfiguration": { "type": "object", "properties": { "id": { "type": "string", "description": "Uniquely identifies this phone number configuration", "format": "uuid", "example": "eef3340b-8903-4466-b445-89b697315a3a" }, "user_bundle_id": { "type": "string", "format": "uuid", "description": "Identifies the associated user bundle", "example": "daa4308e-742f-4867-97f2-3073db13319a" }, "porting_phone_number_id": { "type": "string", "format": "uuid", "description": "Identifies the associated porting phone number", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "record_type": { "type": "string", "example": "porting_phone_number_configuration", "description": "Identifies the type of the resource.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527000Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2021-03-19T10:07:15.527000Z" } } }, "PortingReport": { "type": "object", "properties": { "id": { "type": "string", "description": "Uniquely identifies the report.", "format": "uuid", "example": "eef3340b-8903-4466-b445-89b697315a3a" }, "report_type": { "type": "string", "description": "Identifies the type of report", "enum": [ "export_porting_orders_csv" ], "example": "export_porting_orders_csv" }, "status": { "type": "string", "description": "The current status of the report generation.", "enum": [ "pending", "completed" ], "example": "completed" }, "params": { "oneOf": [ { "$ref": "#/components/schemas/ExportPortingOrdersCSVReport" } ] }, "document_id": { "type": "string", "format": "uuid", "description": "Identifies the document that was uploaded when report was generated. This field is only populated when the report is under completed status.", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "record_type": { "type": "string", "example": "porting_report", "description": "Identifies the type of the resource.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527000Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2021-03-19T10:07:15.527000Z" } } }, "PortingVerificationCode": { "type": "object", "properties": { "id": { "type": "string", "description": "Uniquely identifies this porting verification code", "format": "uuid", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "phone_number": { "type": "string", "description": "E164 formatted phone number", "example": "+13035550987" }, "verified": { "type": "boolean", "description": "Indicates whether the verification code has been verified", "example": true }, "porting_order_id": { "type": "string", "format": "uuid", "description": "Identifies the associated porting order", "example": "f1486bae-f067-460c-ad43-73a92848f902" }, "record_type": { "type": "string", "example": "porting_verification_code", "description": "Identifies the type of the resource.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2021-03-19T10:07:15.527000Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2021-03-19T10:07:15.527000Z" } } }, "PortoutComment": { "required": [ "id", "body", "user_id", "created_at" ], "properties": { "id": { "type": "string", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "portout" }, "body": { "type": "string", "description": "Comment body", "example": "This is a comment" }, "portout_id": { "type": "string", "description": "Identifies the associated port request", "default": null, "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "user_id": { "type": "string", "description": "Identifies the user who created the comment. Will be null if created by Telnyx Admin", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "created_at": { "type": "string", "description": "Comment creation timestamp in ISO 8601 format", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "record_type": "portout", "body": "This is a comment", "portout_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "user_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "created_at": "2018-02-02T22:25:27.521Z" } }, "PortoutDetails": { "type": "object", "properties": { "id": { "type": "string", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "portout" }, "phone_numbers": { "description": "Phone numbers associated with this portout", "type": "array", "items": { "type": "string", "description": "E164 formatted phone number" }, "example": [ "+35312345678" ] }, "authorized_name": { "type": "string", "description": "Name of person authorizing the porting order", "example": "McPortersen" }, "carrier_name": { "type": "string", "description": "Carrier the number will be ported out to", "example": "test" }, "current_carrier": { "type": "string", "description": "The current carrier", "example": "telnyx" }, "end_user_name": { "type": "string", "description": "Person name or company name requesting the port", "example": "McPortersen" }, "city": { "type": "string", "description": "City or municipality of billing address", "example": "Chicago" }, "state": { "type": "string", "description": "State, province, or similar of billing address", "example": "IL" }, "zip": { "type": "string", "description": "Postal Code of billing address", "example": "00000" }, "lsr": { "type": "array", "description": "The Local Service Request", "items": { "type": "string", "format": "uri", "description": "A link to the Local Service Request" }, "example": [ "https://example.com/files/lsr.pdf" ] }, "pon": { "type": "string", "description": "Port order number assigned by the carrier the number will be ported out to", "example": "00000000" }, "reason": { "type": "string", "description": "The reason why the order is being rejected by the user. If the order is authorized, this field can be left null", "example": null }, "service_address": { "type": "string", "description": "First line of billing address (street address)", "example": "000 Example Street" }, "foc_date": { "type": "string", "description": "ISO 8601 formatted Date/Time of the FOC date", "example": "2018-02-02T22:25:27.521Z" }, "requested_foc_date": { "type": "string", "description": "ISO 8601 formatted Date/Time of the user requested FOC date", "example": "2018-02-02T22:25:27.521Z" }, "spid": { "type": "string", "description": "New service provider spid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "support_key": { "type": "string", "description": "A key to reference this port out request when contacting Telnyx customer support", "example": "PO_764725" }, "status": { "type": "string", "description": "Status of portout request", "enum": [ "pending", "authorized", "ported", "rejected", "rejected-pending", "canceled" ], "example": "rejected" }, "already_ported": { "type": "boolean", "description": "Is true when the number is already ported", "example": false }, "user_id": { "type": "string", "format": "uuid", "description": "Identifies the user (or organization) who requested the port out", "example": "7865816a-ee85-4e50-b19e-52983dcc6d4a" }, "vendor": { "type": "string", "description": "Telnyx partner providing network coverage", "format": "uuid", "example": "0e66ed3b-37e6-4fed-93d6-a30ce2493661" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the portout was created", "example": "2018-02-02T22:25:27.521Z" }, "inserted_at": { "type": "string", "description": "ISO 8601 formatted date of when the portout was created", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the portout was last updated", "example": "2018-02-02T22:25:27.521Z" } } }, "PresignedObjectUrl": { "type": "object", "properties": { "content": { "type": "object", "properties": { "token": { "type": "string", "description": "The token for the object" }, "presigned_url": { "type": "string", "description": "The presigned URL for the object" }, "expires_at": { "type": "string", "description": "The expiration time of the token", "format": "date-time" } } } } }, "PresignedObjectUrlParams": { "type": "object", "properties": { "ttl": { "type": "integer", "description": "The time to live of the token in minutes", "example": 60, "minimum": 1, "maximum": 720 } } }, "PrivateWirelessGateway": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "network_id": { "type": "string", "format": "uuid", "description": "The identification of the related network resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "readOnly": true, "example": "private_wireless_gateway" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "name": { "description": "The private wireless gateway name.", "type": "string", "example": "My private wireless gateway" }, "region_code": { "description": "The geographical region where the Private Wireless Gateway is deployed to.", "type": "string", "example": "ashburn-va", "default": "ashburn-va" }, "status": { "$ref": "#/components/schemas/PrivateWirelessGatewayStatus" }, "ip_range": { "type": "string", "description": "IP block used to assign IPs to the SIM cards in the Private Wireless Gateway.", "example": "100.64.1.0/24", "readOnly": true, "default": null }, "assigned_resources": { "type": "array", "description": "A list of the resources that have been assigned to the Private Wireless Gateway", "items": { "$ref": "#/components/schemas/PWGAssignedResourcesSummary" } } } }, "PrivateWirelessGatewayRequest": { "type": "object", "properties": { "network_id": { "description": "The identification of the related network resource.", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "format": "uuid" }, "name": { "description": "The private wireless gateway name.", "type": "string", "example": "My private wireless gateway" } }, "example": { "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "name": "My private wireless gateway" } }, "PrivateWirelessGatewayStatus": { "type": "object", "description": "The current status or failure details of the Private Wireless Gateway.", "properties": { "value": { "type": "string", "description": "The current status or failure details of the Private Wireless Gateway.
    \n
  • provisioning - the Private Wireless Gateway is being provisioned.
    • \n
  • provisioned - the Private Wireless Gateway was provisioned and able to receive connections.
    • \n
  • failed - the provisioning had failed for a reason and it requires an intervention.
    • \n
  • decommissioning - the Private Wireless Gateway is being removed from the network.
    • \n
\n Transitioning between the provisioning and provisioned states may take some time.", "enum": [ "provisioning", "provisioned", "failed", "decommissioning" ], "readOnly": true, "default": "provisioning", "example": "provisioned" }, "error_description": { "type": "string", "description": "This attribute provides a human-readable explanation of why a failure happened.", "readOnly": true, "default": null, "example": null }, "error_code": { "type": "string", "description": "This attribute is an error code related to the failure reason.", "readOnly": true, "default": null, "example": null } } }, "ProfileAssignmentPhoneNumbers": { "title": "ProfileAssignmentPhoneNumbers", "required": [ "taskId", "phoneNumber", "status" ], "type": "object", "properties": { "taskId": { "title": "Taskid", "type": "string", "description": "The ID of the task associated with the phone number.", "example": "667a80f8-b0a9-49d0-b9ab-a7a1bcc45086" }, "phoneNumber": { "title": "Phonenumber", "type": "string", "description": "The phone number that the status is being checked for.", "example": "+12024567890" }, "status": { "title": "Status", "type": "string", "description": "The status of the associated phone number assignment.", "example": "pending" } } }, "PublicCompany": { "title": "PublicCompany", "type": "object", "properties": { "symbol": { "title": "Symbol", "type": "string" }, "exchange": { "$ref": "#/components/schemas/Exchange" }, "iso2": { "title": "Iso2", "type": "string" }, "isin": { "title": "Isin", "type": "string" }, "displayName": { "title": "Displayname", "type": "string" } } }, "PublicCompanyRecordSet": { "title": "PublicCompanyRecordSet", "type": "object", "properties": { "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/PublicCompany" } }, "page": { "title": "Page", "type": "integer" }, "totalRecords": { "title": "Totalrecords", "type": "integer" } } }, "PublicInternetGateway": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "$ref": "#/components/schemas/Interface" }, { "type": "object", "title": "PublicInternetGateway", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "public_internet_gateway" }, "public_ip": { "description": "The publically accessible ip for this interface.", "type": "string", "example": "127.0.0.1", "readOnly": true } } } ] }, "PublicInternetGatewayCreate": { "allOf": [ { "$ref": "#/components/schemas/PublicInternetGateway" }, { "$ref": "#/components/schemas/RegionIn" }, { "type": "object", "title": "PublicInternetGatewayCreate", "required": [ "network_id", "region" ] } ] }, "PublicInternetGatewayRead": { "allOf": [ { "$ref": "#/components/schemas/PublicInternetGateway" }, { "$ref": "#/components/schemas/RegionOut" } ] }, "PushCredential": { "type": "object", "title": "Successful response with details about a push credential", "required": [ "id", "certificate", "private_key", "server_key", "alias", "type", "record_type", "created_at", "updated_at" ], "properties": { "id": { "description": "Unique identifier of a push credential", "type": "string", "example": "0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7" }, "certificate": { "description": "Apple certificate for sending push notifications. For iOS only", "type": "string", "example": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----" }, "private_key": { "description": "Apple private key for a given certificate for sending push notifications. For iOS only", "type": "string", "example": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----" }, "server_key": { "description": "Google server key for sending push notifications. For Android only", "type": "string", "example": "" }, "alias": { "description": "Alias to uniquely identify a credential", "type": "string", "example": "LucyCredential" }, "type": { "description": "Type of mobile push credential. Either ios or android", "type": "string", "example": "ios" }, "record_type": { "type": "string", "example": "push_credential", "readOnly": true }, "created_at": { "description": "ISO 8601 timestamp when the room was created", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "updated_at": { "description": "ISO 8601 timestamp when the room was updated.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" } } }, "Quality": { "description": "The quality of the fax. The `ultra` settings provides the highest quality available, but also present longer fax processing times. `ultra_light` is best suited for images, wihle `ultra_dark` is best suited for text.", "type": "string", "example": "high", "default": "high", "enum": [ "normal", "high", "very_high", "ultra_light", "ultra_dark" ] }, "Queue": { "type": "object", "title": "Queue", "required": [ "record_type", "id", "name", "current_size", "max_size", "average_wait_time_secs", "created_at", "updated_at" ], "properties": { "record_type": { "type": "string", "enum": [ "queue" ], "example": "queue" }, "id": { "type": "string", "description": "Uniquely identifies the queue", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "name": { "type": "string", "description": "Name of the queue", "example": "support" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the queue was created", "example": "2019-01-23T18:10:02.574Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the queue was last updated", "example": "2019-01-23T18:10:02.574Z" }, "current_size": { "type": "integer", "description": "The number of calls currently in the queue", "example": 20 }, "max_size": { "type": "integer", "description": "The maximum number of calls allowed in the queue", "example": 50 }, "average_wait_time_secs": { "type": "integer", "description": "The average time that the calls currently in the queue have spent waiting, given in seconds.", "example": 175 } }, "example": { "record_type": "queue", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "support", "created_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z", "current_size": 20, "max_size": 50, "average_wait_time_secs": 175 } }, "QueueCall": { "type": "object", "title": "QueueCall", "required": [ "call_control_id", "call_leg_id", "call_session_id", "is_alive", "record_type", "connection_id", "from", "to", "enqueued_at", "wait_time_secs", "queue_position", "queue_id" ], "example": { "call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768", "call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768", "record_type": "queue_call", "connection_id": "7267xxxxxxxxxxxxxx", "from": "+18005550101", "to": "+18005550102", "enqueued_at": "2019-01-23T18:10:02.574Z", "wait_time_secs": 145, "queue_position": 3, "queue_id": "ae1626cc-6f42-11ea-becd-02420a0f8b69" }, "properties": { "record_type": { "type": "string", "enum": [ "queue_call" ], "example": "queue_call" }, "call_session_id": { "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call", "type": "string", "example": "428c31b6-7af4-4bcb-b68e-5013ef9657c1" }, "call_leg_id": { "description": "ID that is unique to the call and can be used to correlate webhook events", "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1" }, "call_control_id": { "description": "Unique identifier and token for controlling the call.", "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "from": { "type": "string", "example": "+35319605860", "description": "Number or SIP URI placing the call." }, "to": { "type": "string", "example": "+13129457420", "description": "Destination number or SIP URI of the call." }, "enqueued_at": { "type": "string", "description": "ISO 8601 formatted date of when the call was put in the queue", "example": "2019-01-23T18:10:02.574Z" }, "wait_time_secs": { "type": "integer", "description": "The time the call has been waiting in the queue, given in seconds", "example": 272 }, "queue_position": { "type": "integer", "description": "Current position of the call in the queue", "example": 3 }, "queue_id": { "type": "string", "description": "Unique identifier of the queue the call is in.", "example": "ae1626cc-6f42-11ea-becd-02420a0f8b69" } } }, "ReadComment": { "allOf": [ { "$ref": "#/components/schemas/Comment" }, { "type": "object", "properties": { "read_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the comment was read.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true } } } ] }, "Record": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "sample_record_type" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "RecordType": { "type": "string", "description": "Identifies record type.", "pattern": "custom_storage_credentials" }, "Recording": { "type": "object", "title": "Recording", "required": [ "record_type", "id", "created_at", "updated_at", "recording_started_at", "recording_ended_at", "duration_millis", "status", "channels", "source", "download_urls" ], "properties": { "record_type": { "type": "string", "enum": [ "recording" ], "example": "recording" }, "id": { "type": "string", "description": "Uniquely identifies the recording", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date of when the recording was created", "example": "2019-01-23T18:10:02.574Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date of when the recording was last updated", "example": "2019-01-23T18:10:02.574Z" }, "recording_started_at": { "type": "string", "description": "ISO 8601 formatted date of when the recording started", "example": "2019-01-23T18:10:02.574Z" }, "recording_ended_at": { "type": "string", "description": "ISO 8601 formatted date of when the recording ended", "example": "2019-01-23T18:10:02.574Z" }, "duration_millis": { "description": "The duration of the recording in milliseconds", "type": "integer", "format": "int32", "example": 60000 }, "status": { "type": "string", "enum": [ "completed" ], "description": "The status of the recording. Only resources for `completed` recordings are currently supported", "example": "completed" }, "channels": { "type": "string", "enum": [ "single", "dual" ], "description": "When `dual`, final audio file has the first leg on channel A, and the rest on channel B.", "example": "single" }, "source": { "type": "string", "enum": [ "conference", "call" ], "description": "The kind of event that led to this recording being created", "example": "conference" }, "conference_id": { "type": "string", "description": "If a conference recording, uniquely identifies the recorded conference", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "call_leg_id": { "type": "string", "description": "If a call recording, uniquely identifies the recorded call leg", "example": "11111111-5717-4562-b3fc-2c963f66afa6" }, "call_session_id": { "type": "string", "description": "If a call recording, uniquely identifies the recorded call session", "example": "22222222-5717-4562-b3fc-2c963f66afa6" }, "download_urls": { "type": "object", "description": "The links to download the recording files", "properties": { "mp3": { "type": "string", "description": "Link to download the recording in mp3 format" }, "wav": { "type": "string", "description": "Link to download the recording in wav format" } } } }, "example": { "record_type": "recording", "id": "dfadada7-af74-47bc-83a4-554275f55f5c", "created_at": "2019-03-29T13:10:00Z", "updated_at": "2019-03-29T14:10:00Z", "recording_started_at": "2019-03-29T11:10:00Z", "recording_ended_at": "2019-03-29T12:10:00Z", "duration_millis": 50000, "status": "completed", "channels": "single", "source": "conference", "conference_id": "41b9acd4-f4da-4ff5-a85c-e07e90b53f46", "call_leg_id": "11111111-5717-4562-b3fc-2c963f66afa6", "call_session_id": "22222222-5717-4562-b3fc-2c963f66afa6", "download_urls": { "mp3": "https://s3.amazonaws.com/some/path" } } }, "RecordingCompleted": { "type": "object", "title": "Recording Completed", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "An identifier for the type of the resource." }, "event_type": { "type": "string", "example": "video.room.recording.completed", "enum": [ "video.room.recording.completed" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Uniquely identify the event." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Session ID associated with the recording." }, "room_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Room ID associated with the recording." }, "participant_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Participant ID associated with the recording." }, "recording_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Recording ID that identifies the recording." }, "type": { "type": "string", "example": "audio", "enum": [ "audio", "video" ], "description": "Type of the recording." }, "size_mb": { "description": "Recording size in MB.", "type": "number", "format": "float", "example": 10.5 }, "download_url": { "description": "Url to download the recording.", "type": "string", "example": "https://www.example.com" }, "codec": { "description": "Codec used for the recording.", "type": "string", "example": "opus" }, "duration_secs": { "description": "Recording duration in seconds.", "type": "integer", "example": 67 } } } }, "example": { "record_type": "event", "event_type": "video.room.recording.started", "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "room_id": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "participant_id": "5ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "recording_id": "1ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "type": "audio", "download_url": "https://www.example.com", "duration_secs": 3660, "size_mb": 5.6, "codec": "opus" } } }, "RecordingCompletedEvent": { "type": "object", "title": "Recording Completed Event", "properties": { "data": { "$ref": "#/components/schemas/RecordingCompleted" } } }, "RecordingResponse": { "type": "object", "title": "RecordingResponse", "properties": { "data": { "$ref": "#/components/schemas/RecordingResponseData" } } }, "RecordingResponseData": { "type": "object", "title": "RecordingResponseData", "properties": { "call_control_id": { "type": "string", "example": "v3:e-31OnvjEM7Y4wvxr3TKNk8M3QyLcGZPiUIzCGtwQtOtEjY-B0urkw", "description": "Unique identifier and token for controlling the call." }, "call_leg_id": { "type": "string", "example": "84a97d76-e40f-11ed-9074-02420a0daa69", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "84a97d76-e40f-11ed-9074-02420a0daa69", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "channels": { "type": "string", "enum": [ "single", "dual" ], "description": "When `dual`, final audio file has the first leg on channel A, and the rest on channel B.", "example": "dual" }, "conference_id": { "type": "string", "example": "84a97d76-e40f-11ed-9074-02420a0daa69", "description": "Uniquely identifies the conference." }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "download_urls": { "type": "object", "description": "The links to download the recording files.", "properties": { "mp3": { "type": "string", "description": "Link to download the recording in mp3 format." }, "wav": { "type": "string", "description": "Link to download the recording in wav format." } } }, "duration_millis": { "description": "The duration of the recording in milliseconds.", "type": "integer", "format": "int32", "example": 60000 }, "id": { "type": "string", "description": "Uniquely identifies the recording.", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "record_type": { "type": "string", "enum": [ "recording" ], "example": "recording" }, "recording_started_at": { "type": "string", "description": "ISO 8601 formatted date of when the recording started.", "example": "2019-01-23T18:10:02.574Z" }, "recording_ended_at": { "type": "string", "description": "ISO 8601 formatted date of when the recording ended.", "example": "2019-01-23T18:10:02.574Z" }, "source": { "type": "string", "enum": [ "conference", "call" ], "description": "The kind of event that led to this recording being created.", "example": "conference" }, "status": { "type": "string", "enum": [ "completed" ], "description": "The status of the recording. Only resources for `completed` recordings are currently supported.", "example": "completed" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" } } }, "RecordingSource": { "type": "string", "description": "Defines how the recording was created.", "enum": [ "StartCallRecordingAPI", "StartConferenceRecordingAPI", "OutboundAPI", "DialVerb", "Conference", "RecordVerb", "Trunking" ] }, "RecordingStarted": { "type": "object", "title": "Recording Started", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "An identifier for the type of the resource." }, "event_type": { "type": "string", "example": "video.room.recording.started", "enum": [ "video.room.recording.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Uniquely identify the event." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Session ID associated with the recording." }, "room_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Room ID associated with the recording." }, "participant_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Participant ID associated with the recording." }, "recording_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Recording ID associated with the recording." }, "type": { "type": "string", "example": "audio", "enum": [ "audio", "video" ], "description": "Type of the recording." } } } }, "example": { "record_type": "event", "event_type": "video.room.recording.started", "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "room_id": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "participant_id": "5ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "recording_id": "1ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "type": "audio" } } }, "RecordingStartedEvent": { "type": "object", "title": "Recording Started Event", "properties": { "data": { "$ref": "#/components/schemas/RecordingStarted" } } }, "RecordingStatusCallbackEvent": { "description": "The changes to the recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`.", "example": "in-progress completed absent", "type": "string" }, "RecordingTrack": { "description": "The audio track to record for the call. The default is `both`.", "example": "inbound", "type": "string", "enum": [ "inbound", "outbound", "both" ] }, "ReferRequest": { "type": "object", "title": "Refer request", "required": [ "sip_address" ], "properties": { "sip_address": { "description": "The SIP URI to which the call will be referred to.", "type": "string", "example": "sip:username@sip.non-telnyx-address.com" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "type": "string" }, "command_id": { "description": "Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same `command_id` as one that has already been executed.", "example": "891510ac-f3e4-11e8-af5b-de00688a4901", "type": "string" }, "custom_headers": { "description": "Custom headers to be added to the SIP INVITE.", "type": "array", "example": [ { "name": "head_1", "value": "val_1" }, { "name": "head_2", "value": "val_2" } ], "items": { "$ref": "#/components/schemas/CustomSipHeader" } }, "sip_auth_username": { "description": "SIP Authentication username used for SIP challenges.", "type": "string" }, "sip_auth_password": { "description": "SIP Authentication password used for SIP challenges.", "type": "string" }, "sip_headers": { "description": "SIP headers to be added to the request. Currently only User-to-User header is supported.", "type": "array", "example": [ { "name": "User-to-User", "value": "value" } ], "items": { "$ref": "#/components/schemas/SipHeader" } } }, "example": { "sip_address": "sip:username@sip.non-telnyx-address.com" } }, "RefreshRoomClientTokenRequest": { "type": "object", "properties": { "token_ttl_secs": { "description": "The time to live in seconds of the Client Token, after that time the Client Token is invalid and can't be used to join a Room.", "type": "integer", "example": 600, "default": 600, "minimum": 10, "maximum": 3600 }, "refresh_token": { "type": "string", "format": "jwt", "example": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ" } }, "required": [ "refresh_token" ] }, "Region": { "description": "Region where the bucket is located.", "type": "string", "example": "us-east-1" }, "RegionIn": { "type": "object", "properties": { "region_code": { "description": "The region the interface should be deployed to.", "type": "string", "example": "ashburn-va" } } }, "RegionInformation": { "properties": { "region_type": { "type": "string", "example": "country_code", "enum": [ "country_code", "rate_center", "state", "location" ] }, "region_name": { "type": "string", "example": "US" } }, "example": { "region_type": "country_code", "region_name": "US" } }, "RegionOut": { "type": "object", "properties": { "region_code": { "description": "The region interface is deployed to.", "type": "string", "example": "ashburn-va" }, "region": { "type": "object", "properties": { "code": { "description": "Region code of the interface.", "type": "string", "example": "ashburn-va" }, "name": { "description": "Region name of the interface.", "type": "string", "example": "Ashburn" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "region" } } } } }, "RegisterCallRequest": { "type": "object", "title": "RegisterCallRequest", "required": [ "from", "to", "reason" ], "properties": { "from": { "description": "The DID that you will dial out from.", "type": "string", "example": "+15001340938" }, "to": { "description": "The DID that you will dial out to.", "type": "string", "example": "+18005550100" }, "reason": { "description": "The reason for call (this will be displayed on call recipient's device).", "type": "string", "example": "Confirm the Doctor appointment." } }, "example": { "to": "+18005550100", "from": "+15001340938", "reason": "Confirm the Doctor appointment." } }, "RegulatoryRequirements": { "properties": { "phone_number": { "type": "string", "example": "+41215471644", "readOnly": true }, "phone_number_type": { "type": "string", "example": "local", "readOnly": true }, "region_information": { "type": "array", "items": { "type": "object", "properties": { "region_name": { "type": "string", "example": "CH" }, "region_type": { "type": "string", "example": "country_code" } } } }, "record_type": { "type": "string", "example": "phone_number_regulatory_requirements", "readOnly": true }, "regulatory_requirements": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "example": "Address matching the DID area code (street, building number, postal code, city and country)", "readOnly": true }, "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "example": { "type": "string", "example": "311 W Superior St, Chicago, IL 60654", "readOnly": true }, "label": { "type": "string", "example": "Address matching the DID area code" }, "field_type": { "type": "string", "example": "address_id" }, "acceptance_criteria": { "type": "object", "properties": { "locality_limit": { "type": "string", "example": "Identical locality as the numbers desired" }, "field_value": { "type": "string", "example": "45f45a04-b4be-4592-95b1-9306b9db2b21" }, "field_type": { "type": "string", "example": "address" } } }, "record_type": { "type": "string", "example": "regulatory_requirement", "readOnly": true } } } } } }, "RejectRequest": { "type": "object", "title": "Reject Request", "required": [ "cause" ], "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "cause": { "description": "Cause for call rejection.", "type": "string", "enum": [ "CALL_REJECTED", "USER_BUSY" ], "example": "USER_BUSY" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "cause": "USER_BUSY" } }, "Release": { "type": "object", "title": "Phone Number Release", "properties": { "ticket_id": { "$ref": "#/components/schemas/UUID" }, "tenant_id": { "type": "string", "format": "uuid", "example": "ea175aba-f47c-4702-9400-efaa42688048" }, "status": { "type": "string", "enum": [ "pending_upload", "pending", "in_progress", "complete", "failed", "expired", "unknown" ], "description": "Represents the status of the release on Microsoft Teams.", "example": "pending", "default": "pending_upload" }, "error_message": { "type": "string", "description": "A message set if there is an error with the upload process." }, "telephone_numbers": { "type": "array", "items": { "$ref": "#/components/schemas/TnReleaseEntry" } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" } } }, "ReplacedLinkClick": { "type": "object", "properties": { "record_type": { "type": "string", "example": "link_clicked", "description": "Identifies the type of the resource." }, "url": { "type": "string", "example": "link_clicked", "description": "The original link that was sent in the message." }, "to": { "type": "string", "format": "address", "description": "Sending address (+E.164 formatted phone number, alphanumeric sender ID, or short code)." }, "message_id": { "type": "string", "format": "uuid", "description": "The message ID associated with the clicked link." }, "time_clicked": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the message request was received." } }, "example": { "record_type": "link_clicked", "url": "https://telnyx.com", "to": "18445550001", "message_id": "7ee4241c-f127-47e5-9c34-3aac291f8058", "time_clicked": "2019-04-01T14:45:45.450Z" } }, "ReplacedLinkClickEvent": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ReplacedLinkClick" } } }, "ReservedPhoneNumber": { "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "reserved_phone_number", "readOnly": true }, "phone_number": { "type": "string", "format": "e164_phone_number", "example": "+19705555098" }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the phone number's reservation.", "example": "success", "readOnly": true }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the individual number reservation was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the the individual number reservation was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "expired_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the individual number reservation is going to expire", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true } }, "example": { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "record_type": "reserved_phone_number", "phone_number": "+19705555098", "status": "pending", "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z", "expired_at": "2018-01-01T00:00:00.000000Z" } }, "ResourceNotFoundError": { "allOf": [ { "$ref": "#/components/schemas/GenericError" }, { "properties": { "code": { "example": "10005" }, "title": { "example": "Resource not found" }, "detail": { "example": "The requested resource or URL could not be found." }, "meta": { "type": "object", "properties": { "url": { "type": "string", "example": "https://developers.telnyx.com/docs/overview/errors/10005" } } } } } ] }, "ResumeConferenceRecordingRequest": { "type": "object", "title": "Pause Recording Request", "properties": { "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "recording_id": { "description": "Use this field to resume specific recording.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } } }, "ResumeRecordingRequest": { "type": "object", "title": "Pause Recording Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } } }, "RetrieveVerificationResponse": { "title": "RetrieveVerificationResponse", "required": [ "data" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Verification" } } }, "Room": { "type": "object", "properties": { "id": { "description": "A unique identifier for the room.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "max_participants": { "description": "Maximum participants allowed in the room.", "type": "integer", "example": 50 }, "unique_name": { "description": "The unique (within the Telnyx account scope) name of the room.", "type": "string", "example": "My room" }, "created_at": { "description": "ISO 8601 timestamp when the room was created.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "updated_at": { "description": "ISO 8601 timestamp when the room was updated.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "active_session_id": { "description": "The identifier of the active room session if any.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/RoomSession" } }, "enable_recording": { "description": "Enable or disable recording for that room.", "type": "boolean", "example": true, "default": false }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this room will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "record_type": { "type": "string", "example": "room", "readOnly": true } }, "example": { "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "max_participants": 50, "unique_name": "My Room", "created_at": "2021-04-16T09:46:20.954863Z", "updated_at": "2021-04-16T10:24:55.962200Z", "active_session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e74", "enable_recording": true, "webhook_event_failover_url": "https://failover.example.com", "webhook_timeout_secs": 25, "webhook_event_url": "https://www.example.com", "sessions": [ { "id": "7b61621f-62e0-4aad-ab11-9fd19e272e74", "room_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "active": true, "created_at": "2021-04-16T09:46:20.954863Z", "updated_at": "2021-04-16T10:24:55.962200Z", "participants": [], "record_type": "room_session" } ], "record_type": "room" } }, "RoomComposition": { "type": "object", "properties": { "id": { "description": "A unique identifier for the room composition.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "room_id": { "description": "Identify the room associated with the room composition.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0" }, "session_id": { "description": "Identify the room session associated with the room composition.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0" }, "user_id": { "description": "Identify the user associated with the room composition.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0" }, "status": { "description": "Shows the room composition status.", "type": "string", "example": "completed", "enum": [ "completed", "enqueued", "processing" ] }, "size_mb": { "description": "Shows the room composition size in MB.", "type": "number", "format": "float", "example": 10.5 }, "download_url": { "description": "Url to download the composition.", "type": "string", "example": "https://www.example.com" }, "duration_secs": { "description": "Shows the room composition duration in seconds.", "type": "integer", "example": 67 }, "format": { "description": "Shows format of the room composition.", "type": "string", "example": "mp4", "enum": [ "mp4" ] }, "created_at": { "description": "ISO 8601 timestamp when the room composition was created.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "updated_at": { "description": "ISO 8601 timestamp when the room composition was updated.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "ended_at": { "description": "ISO 8601 timestamp when the room composition has ended.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "started_at": { "description": "ISO 8601 timestamp when the room composition has stated.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "completed_at": { "description": "ISO 8601 timestamp when the room composition has completed.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "video_layout": { "description": "Describes the video layout of the room composition in terms of regions. Limited to 2 regions.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/VideoRegion" } }, "webhook_event_url": { "description": "The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.", "type": "string", "format": "url", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this room composition will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "record_type": { "type": "string", "example": "room_composition", "readOnly": true } }, "example": { "completed_at": "2022-02-25T05:39:56.377426Z", "download_url": null, "duration_secs": 84, "ended_at": "2022-02-24T23:22:24.577677Z", "format": "mp4", "id": "7103dc53-ee59-4b54-a58b-c77d99ceb037", "record_type": "composition", "resolution": "1280x720", "room_id": "f981dbb3-228a-44e9-ac54-e87f0e2658b0", "session_id": "8f728d7b-00e2-4c59-8c27-f564b828df87", "size_mb": 6, "started_at": "2022-02-24T23:21:00.077209Z", "status": "enqueued", "user_id": "12a04ec9-0f91-4a91-9f3a-a19d9931182e", "video_layout": { "first": { "height": 720, "video_sources": [ "*" ], "width": 1280, "x_pos": 0, "y_pos": 0, "z_pos": 0 } }, "webhook_event_url": "https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02" } }, "RoomParticipant": { "type": "object", "properties": { "id": { "description": "A unique identifier for the room participant.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "session_id": { "description": "Identify the room session that participant is part of.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0" }, "context": { "description": "Context provided to the given participant through the client SDK", "type": "string", "example": "Alice" }, "joined_at": { "description": "ISO 8601 timestamp when the participant joined the session.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "updated_at": { "description": "ISO 8601 timestamp when the participant was updated.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "left_at": { "description": "ISO 8601 timestamp when the participant left the session.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "record_type": { "type": "string", "example": "room_participant", "readOnly": true } }, "example": { "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "session_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73", "context": "Alice", "joined_at": "2021-04-16T09:46:20.954863Z", "updated_at": "2021-04-16T10:24:55.962200Z", "left_at": "2021-04-16T10:24:55.962200Z", "record_type": "room_participant" } }, "RoomRecording": { "type": "object", "properties": { "id": { "description": "A unique identifier for the room recording.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "room_id": { "description": "Identify the room associated with the room recording.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0" }, "session_id": { "description": "Identify the room session associated with the room recording.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0" }, "participant_id": { "description": "Identify the room participant associated with the room recording.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0" }, "status": { "description": "Shows the room recording status.", "type": "string", "example": "completed", "enum": [ "completed", "processing" ] }, "type": { "description": "Shows the room recording type.", "type": "string", "example": "audio", "enum": [ "audio", "video" ] }, "size_mb": { "description": "Shows the room recording size in MB.", "type": "number", "format": "float", "example": 10.5 }, "download_url": { "description": "Url to download the recording.", "type": "string", "example": "https://www.example.com" }, "codec": { "description": "Shows the codec used for the room recording.", "type": "string", "example": "opus" }, "duration_secs": { "description": "Shows the room recording duration in seconds.", "type": "integer", "example": 67 }, "created_at": { "description": "ISO 8601 timestamp when the room recording was created.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "updated_at": { "description": "ISO 8601 timestamp when the room recording was updated.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "ended_at": { "description": "ISO 8601 timestamp when the room recording has ended.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "started_at": { "description": "ISO 8601 timestamp when the room recording has stated.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "completed_at": { "description": "ISO 8601 timestamp when the room recording has completed.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "record_type": { "type": "string", "example": "room_recording", "readOnly": true } }, "example": { "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73", "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73", "session_id": "8b61621f-5fe4-4aad-ab11-9fd19e272e73", "participant_id": "9b61621f-5fe4-4aad-ab11-9fd19e272e73", "status": "completed", "download_url": "https://www.example.com", "type": "audio", "duration_secs": 3660, "size_mb": 5.6, "codec": "opus", "created_at": "2021-04-16T09:46:20.954863Z", "updated_at": "2021-04-16T10:24:55.962200Z", "started_at": "2021-04-16T09:24:55.962200Z", "ended_at": "2021-04-16T10:24:55.962200Z", "completed_at": "2021-04-16T10:25:55.962200Z", "record_type": "room_session" } }, "RoomSession": { "type": "object", "properties": { "id": { "description": "A unique identifier for the room session.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "room_id": { "description": "Identify the room hosting that room session.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0" }, "active": { "description": "Shows if the room session is active or not.", "type": "boolean", "example": false }, "created_at": { "description": "ISO 8601 timestamp when the room session was created.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "updated_at": { "description": "ISO 8601 timestamp when the room session was updated.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "ended_at": { "description": "ISO 8601 timestamp when the room session has ended.", "type": "string", "format": "datetime", "example": "2021-03-26T17:51:59.588408Z" }, "participants": { "type": "array", "items": { "$ref": "#/components/schemas/RoomParticipant" } }, "record_type": { "type": "string", "example": "room_session", "readOnly": true } }, "example": { "id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "room_id": "7b61621f-5fe4-4aad-ab11-9fd19e272e73", "active": false, "created_at": "2021-04-16T09:46:20.954863Z", "updated_at": "2021-04-16T10:24:55.962200Z", "ended_at": "2021-04-16T10:24:55.962200Z", "participants": [], "record_type": "room_session" } }, "S3ConfigurationData": { "type": "object", "title": "AWS S3 Storage Configuration Data", "properties": { "bucket": { "$ref": "#/components/schemas/Bucket" }, "region": { "$ref": "#/components/schemas/Region" }, "aws_access_key_id": { "$ref": "#/components/schemas/AwsAccessKeyId" }, "aws_secret_access_key": { "$ref": "#/components/schemas/AwsSecretAccessKey" } } }, "SIMCard": { "type": "object", "title": "SIMCard", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "example": "sim_card", "readOnly": true }, "status": { "$ref": "#/components/schemas/SIMCardStatus" }, "type": { "type": "string", "description": "The type of SIM card", "readOnly": true, "example": "physical", "enum": [ "physical", "esim" ] }, "iccid": { "type": "string", "description": "The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.\n", "readOnly": true, "example": "89310410106543789301" }, "imsi": { "type": "string", "description": "SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI).
\nMobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home Location Register (HLR) or the Visitor Location Register (VLR).\n", "readOnly": true, "example": "081932214823362973" }, "msisdn": { "type": "string", "description": "Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
\nMSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.\n", "readOnly": true, "example": "+13109976224" }, "sim_card_group_id": { "type": "string", "format": "uuid", "description": "The group SIMCardGroup identification. This attribute can be null when it's present in an associated resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "tags": { "type": "array", "description": "Searchable tags associated with the SIM card", "items": { "type": "string" }, "example": [ "personal", "customers", "active-customers" ] }, "authorized_imeis": { "type": "array", "description": "List of IMEIs authorized to use a given SIM card.", "items": { "type": "string", "format": "int64" }, "example": [ "106516771852751", "534051870479563", "508821468377961" ] }, "current_imei": { "type": "string", "format": "int64", "description": "IMEI of the device where a given SIM card is currently being used.", "readOnly": true, "example": "457032284023794" }, "data_limit": { "type": "object", "description": "The SIM card individual data limit configuration.", "properties": { "amount": { "type": "string", "format": "decimal", "example": "2048.1" }, "unit": { "type": "string", "example": "MB", "enum": [ "MB", "GB" ] } } }, "current_billing_period_consumed_data": { "type": "object", "description": "The SIM card consumption so far in the current billing cycle.", "readOnly": true, "properties": { "amount": { "type": "string", "format": "decimal", "example": "2049.0" }, "unit": { "type": "string", "example": "MB", "default": "MB" } } }, "actions_in_progress": { "type": "boolean", "description": "Indicate whether the SIM card has any pending (in-progress) actions.", "readOnly": true, "example": true, "default": false }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "ipv4": { "type": "string", "description": "The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.\n", "readOnly": true, "example": "192.168.0.0" }, "ipv6": { "type": "string", "description": "The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.\n", "readOnly": true, "example": "2001:cdba:0000:0000:0000:0000:3257:9652" }, "current_device_location": { "type": "object", "description": "Current physical location data of a given SIM card. Accuracy is given in meters.", "readOnly": true, "properties": { "latitude": { "type": "string", "format": "float", "example": "41.143" }, "longitude": { "type": "string", "format": "float", "example": "-8.605" }, "accuracy": { "type": "integer", "example": 1250 }, "accuracy_unit": { "type": "string", "example": "m", "default": "m" } } }, "current_mnc": { "type": "string", "readOnly": true, "description": "Mobile Network Code of the current network to which the SIM card is connected. It's a two to three decimal digits that identify a network.

\n This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.", "example": "260" }, "current_mcc": { "type": "string", "readOnly": true, "description": "Mobile Country Code of the current network to which the SIM card is connected. It's a three decimal digit that identifies a country.

\nThis code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.", "example": "410" }, "live_data_session": { "type": "string", "enum": [ "connected", "disconnected", "unknown" ], "readOnly": true, "description": "Indicates whether the device is actively connected to a network and able to run data.", "example": "connected" } } }, "SIMCardAction": { "type": "object", "title": "SIMCardAction", "description": "This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.", "properties": { "id": { "$ref": "#/components/schemas/Id" }, "record_type": { "type": "string", "example": "sim_card_action", "readOnly": true }, "sim_card_id": { "type": "string", "format": "uuid", "description": "The related SIM card identifier.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "action_type": { "type": "string", "description": "The operation type. It can be one of the following:
\n
    \n
  • enable - move the SIM card to the enabled status
    • \n
  • enable_standby_sim_card - move a SIM card previously on the standby status to the enabled status after it consumes data.
    • \n
  • disable - move the SIM card to the disabled status
    • \n
  • set_standby - move the SIM card to the standby status
    • \n
", "enum": [ "enable", "enable_standby_sim_card", "disable", "set_standby" ], "readOnly": true, "example": "enable" }, "status": { "type": "object", "properties": { "value": { "type": "string", "description": "The current status of the SIM card action.", "enum": [ "in-progress", "completed", "failed", "interrupted" ], "readOnly": true, "example": "completed" }, "reason": { "type": "string", "description": "It describes why the SIM card action is in the current status. This will be null for self-explanatory statuses, such as in-progress and completed but will include further information on statuses like interrupted and failed.", "readOnly": true, "example": "The data limit was exceeded." } } }, "settings": { "type": "object", "description": "A JSON object representation of the action params.", "example": {}, "nullable": true, "readOnly": true }, "created_at": { "$ref": "#/components/schemas/CreatedAt" }, "updated_at": { "$ref": "#/components/schemas/UpdatedAt" } } }, "SIMCardActionsSummary": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "in-progress", "completed", "failed", "interrupted" ], "example": "in-progress" }, "count": { "type": "integer" } } }, "SIMCardActivationCode": { "type": "object", "title": "SIMCardActivationCode", "properties": { "record_type": { "type": "string", "example": "sim_card_activation_code", "readOnly": true }, "activation_code": { "type": "string", "description": "Contents of the eSIM activation QR code.", "example": "LPA:1$....", "readOnly": true } } }, "SIMCardDeviceDetails": { "type": "object", "title": "SIMCardDeviceDetails", "properties": { "record_type": { "type": "string", "example": "device_details", "readOnly": true }, "imei": { "type": "string", "description": "IMEI of the device where the SIM card is being used in.", "format": "int64", "example": "457032284023794", "readOnly": true }, "model_name": { "type": "string", "description": "Brand of the device where the SIM card is being used in.", "example": "iPad Pro 11 2020 Cellular", "readOnly": true }, "brand_name": { "type": "string", "description": "Brand of the device where the SIM card is being used in.", "example": "Apple", "readOnly": true }, "device_type": { "type": "string", "description": "Type of the device where the SIM card is being used in.", "example": "Tablet", "readOnly": true }, "operating_system": { "type": "string", "description": "Operating system of the device where the SIM card is being used in.", "example": "iOS 12", "readOnly": true } } }, "SIMCardGroup": { "title": "SIMCardGroup", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "sim_card_group" }, "default": { "description": "Indicates whether the SIM card group is the users default group.
The default group is created for the user and can not be removed.", "type": "boolean", "example": true, "readOnly": true }, "name": { "description": "A user friendly name for the SIM card group.", "type": "string", "example": "My Test Group" }, "data_limit": { "type": "object", "description": "Upper limit on the amount of data the SIM cards, within the group, can use.", "properties": { "amount": { "type": "string", "format": "decimal", "example": "2048.1" }, "unit": { "type": "string", "example": "MB" } } }, "consumed_data": { "$ref": "#/components/schemas/ConsumedData" }, "private_wireless_gateway_id": { "description": "The identification of the related Private Wireless Gateway resource.", "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "default": null }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SIMCardGroupAction": { "type": "object", "title": "SIMCardGroupAction", "description": "This object represents a SIM card group action request. It allows tracking the current status of an operation that impacts the SIM card group and SIM card in it.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "example": "sim_card_group_action", "readOnly": true }, "sim_card_group_id": { "type": "string", "format": "uuid", "description": "The SIM card group identification.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "type": { "type": "string", "description": "Represents the type of the operation requested.", "enum": [ "set_private_wireless_gateway", "remove_private_wireless_gateway" ], "example": "set_private_wireless_gateway" }, "status": { "type": "string", "enum": [ "in-progress", "completed", "failed" ], "example": "in-progress" }, "settings": { "type": "object", "description": "A JSON object representation of the action params.", "properties": { "private_wireless_gateway_id": { "description": "The identification of the related Private Wireless Gateway resource.", "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" } } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SIMCardGroupCreate": { "title": "SIMCardGroupCreate", "type": "object", "properties": { "name": { "description": "A user friendly name for the SIM card group.", "type": "string", "example": "My Test Group" }, "data_limit": { "type": "object", "description": "Upper limit on the amount of data the SIM cards, within the group, can use.", "properties": { "amount": { "type": "string", "format": "decimal", "example": "2048.1" }, "unit": { "type": "string", "example": "MB" } } } }, "required": [ "name" ] }, "SIMCardGroupPatch": { "title": "SIMCardGroupPatch", "type": "object", "properties": { "name": { "description": "A user friendly name for the SIM card group.", "type": "string", "example": "My Test Group" }, "data_limit": { "type": "object", "description": "Upper limit on the amount of data the SIM cards, within the group, can use.", "properties": { "amount": { "type": "string", "format": "decimal", "example": "2048.1" }, "unit": { "type": "string", "example": "MB" } } } } }, "SIMCardNetworkPreference": { "type": "object", "title": "SIMCardNetworkPreference", "properties": { "record_type": { "type": "string", "example": "sim_card_network_preferences", "readOnly": true }, "sim_card_id": { "type": "string", "format": "uuid", "example": "6b14e151-8493-4fa1-8664-1cc4e6d14158" }, "mobile_network_operators_preferences": { "$ref": "#/components/schemas/MobileNetworkOperatorsPreferencesResponse" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SIMCardNetworkPreferenceWithOTAUpdates": { "type": "object", "title": "SIMCardNetworkPreferenceWithOTAUpdates", "properties": { "record_type": { "type": "string", "example": "sim_card_network_preferences", "readOnly": true }, "sim_card_id": { "type": "string", "format": "uuid", "example": "6b14e151-8493-4fa1-8664-1cc4e6d14158" }, "mobile_network_operators_preferences": { "$ref": "#/components/schemas/MobileNetworkOperatorsPreferencesResponse" }, "ota_updates": { "type": "array", "items": { "$ref": "#/components/schemas/CompleteOTAUpdate" } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SIMCardOrder": { "title": "SIMCardOrder", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "sim_card_order" }, "quantity": { "type": "integer", "minimum": 1, "description": "The amount of SIM cards requested in the SIM card order.", "example": 21 }, "cost": { "type": "object", "description": "An object representing the total cost of the order.", "properties": { "amount": { "type": "string", "description": "A string representing the cost amount.", "example": "2.32" }, "currency": { "type": "string", "format": "currency", "description": "Filter by ISO 4217 currency string.", "example": "USD" } }, "example": { "amount": "2.52", "currency": "USD" } }, "order_address": { "type": "object", "properties": { "id": { "type": "string", "description": "Uniquely identifies the address for the order.", "format": "int64", "example": "1293384261075731499" }, "first_name": { "type": "string", "description": "The first name of the shipping recipient.", "example": "John" }, "last_name": { "type": "string", "description": "The last name of the shipping recipient.", "example": "Smith" }, "business_name": { "type": "string", "description": "The name of the business where the address is located.", "example": "Telnyx LLC" }, "street_address": { "type": "string", "description": "The name of the street where the address is located.", "example": "311 W Superior St" }, "extended_address": { "type": "string", "description": "Supplemental field for address information.", "example": "Suite 504" }, "locality": { "type": "string", "description": "The name of the city where the address is located.", "example": "Chicago" }, "administrative_area": { "type": "string", "description": "State or province where the address is located.", "example": "IL" }, "country_code": { "type": "string", "description": "The mobile operator two-character (ISO 3166-1 alpha-2) origin country code.", "example": "US" }, "postal_code": { "type": "string", "description": "Postal code for the address.", "example": "60654" } }, "description": "An object representing the address information from when the order was submitted.", "readOnly": true, "example": { "id": "1293384261075731499", "street_address": "311 W Superior St", "extended_address": "Suite 504", "locality": "Chicago", "administrative_area": "IL", "country_code": "US", "postal_code": "60654" } }, "tracking_url": { "type": "string", "format": "url", "description": "The URL used to get tracking information about the order.", "example": "http://www.example.com/" }, "status": { "type": "string", "description": "The current status of the SIM Card order.
  • pending - the order is waiting to be processed.
  • processing - the order is currently being processed.
  • ready_to_ship - the order is ready to be shipped to the specified address.
  • shipped - the order was shipped and is on its way to be delivered to the specified address.
  • delivered - the order was delivered to the specified address.
  • canceled - the order was canceled.
", "enum": [ "pending", "processing", "ready_to_ship", "shipped", "delivered", "canceled" ], "example": "pending" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was last created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was last updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SIMCardOrderPreview": { "title": "SIMCardOrderPreview", "type": "object", "properties": { "total_cost": { "type": "object", "properties": { "amount": { "type": "string", "description": "A string representing the cost amount.", "example": "2.32" }, "currency": { "type": "string", "format": "currency", "description": "ISO 4217 currency string.", "example": "USD" } } }, "shipping_cost": { "type": "object", "properties": { "amount": { "type": "string", "description": "A string representing the cost amount.", "example": "2.32" }, "currency": { "type": "string", "format": "currency", "description": "ISO 4217 currency string.", "example": "USD" } } }, "sim_cards_cost": { "type": "object", "properties": { "amount": { "type": "string", "description": "A string representing the cost amount.", "example": "2.32" }, "currency": { "type": "string", "format": "currency", "description": "ISO 4217 currency string.", "example": "USD" } } }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "sim_card_order_preview", "readOnly": true }, "quantity": { "type": "integer", "description": "The amount of SIM cards requested in the SIM card order.", "example": 21 } } }, "SIMCardPublicIP": { "type": "object", "title": "SIMCardPublicIP", "properties": { "record_type": { "type": "string", "example": "sim_card_public_ip", "readOnly": true }, "sim_card_id": { "type": "string", "format": "uuid", "example": "6b14e151-8493-4fa1-8664-1cc4e6d14158" }, "type": { "type": "string", "enum": [ "ipv4" ], "default": "ipv4", "example": "ipv4", "readOnly": true }, "ip": { "type": "string", "description": "The provisioned IP address. This attribute will only be available when underlying resource status is in a \"provisioned\" status.", "example": "192.168.0.0", "readOnly": true, "default": null }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SIMCardRegistration": { "title": "SIMCardRegistration", "type": "object", "properties": { "sim_card_group_id": { "type": "string", "format": "uuid", "description": "The group SIMCardGroup identification. This attribute can be null when it's present in an associated resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "tags": { "type": "array", "description": "Searchable tags associated with the SIM card", "items": { "type": "string" }, "example": [ "personal", "customers", "active-customers" ] }, "registration_codes": { "type": "array", "items": { "type": "string" }, "example": [ "0000000001", "0000000002", "0000000003" ] }, "status": { "type": "string", "description": "Status on which the SIM card will be set after being successful registered.", "enum": [ "enabled", "disabled", "standby" ], "example": "standby", "default": "enabled" } }, "required": [ "registration_codes" ] }, "SIMCardRegistrationCodeValidation": { "type": "object", "properties": { "record_type": { "type": "string", "example": "sim_card_registration_code_validation" }, "registration_code": { "type": "string", "description": "The 10-digit SIM card registration code", "example": "0123456789" }, "valid": { "type": "boolean", "description": "The attribute that denotes whether the code is valid or not", "example": false }, "invalid_detail": { "type": "string", "nullable": true, "description": "The validation message", "example": "This code has already been used." } } }, "SIMCardRegistrationCodeValidations": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SIMCardRegistrationCodeValidation" } } } }, "SIMCardStatus": { "type": "object", "properties": { "value": { "type": "string", "enum": [ "registering", "enabling", "enabled", "disabling", "disabled", "data_limit_exceeded", "setting_standby", "standby" ], "description": "The current status of the SIM card. It will be one of the following:
\n
    \n
  • registering - the card is being registered
    • \n
  • enabling - the card is being enabled
    • \n
  • enabled - the card is enabled and ready for use
    • \n
  • disabling - the card is being disabled
    • \n
  • disabled - the card has been disabled and cannot be used
    • \n
  • data_limit_exceeded - the card has exceeded its data consumption limit
    • \n
  • setting_standby - the process to set the card in stand by is in progress
    • \n
  • standby - the card is in stand by
    • \n
\nTransitioning between the enabled and disabled states may take a period of time.\n", "readOnly": true, "example": "enabled" }, "reason": { "type": "string", "description": "It describes why the SIM card is in the current status.", "readOnly": true, "example": "The SIM card is active, ready to connect to networks and consume data." } } }, "SSLCertificate": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the SSL certificate" }, "issued_to": { "type": "object", "properties": { "common_name": { "type": "string", "description": "The common name of the entity the certificate was issued to" }, "organization": { "type": "string", "description": "The organization the certificate was issued to" }, "organization_unit": { "type": "string", "description": "The organizational unit the certificate was issued to" } } }, "issued_by": { "type": "object", "properties": { "common_name": { "type": "string", "description": "The common name of the entity the certificate was issued by" }, "organization": { "type": "string", "description": "The organization the certificate was issued by" }, "organization_unit": { "type": "string", "description": "The organizational unit the certificate was issued by" } } }, "valid_from": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time the certificate is valid from" }, "valid_to": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "The time the certificate is valid to" }, "created_at": { "type": "string", "format": "date-time", "example": "2020-01-01T00:00:00Z", "description": "Time when SSL certificate was uploaded" } } }, "SearchedSIMCardGroup": { "title": "SIMCardGroup", "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "sim_card_group" }, "default": { "description": "Indicates whether the SIM card group is the users default group.
The default group is created for the user and can not be removed.", "type": "boolean", "example": true, "readOnly": true }, "name": { "description": "A user friendly name for the SIM card group.", "type": "string", "example": "My Test Group" }, "data_limit": { "type": "object", "description": "Upper limit on the amount of data the SIM cards, within the group, can use.", "properties": { "amount": { "type": "string", "format": "decimal", "example": "2048.1" }, "unit": { "type": "string", "example": "MB" } } }, "consumed_data": { "$ref": "#/components/schemas/ConsumedData" }, "sim_card_count": { "description": "The number of SIM cards associated with the group.", "type": "integer", "example": 10, "default": 0 }, "private_wireless_gateway_id": { "description": "The identification of the related Private Wireless Gateway resource.", "format": "uuid", "type": "string", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "default": null }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SendDTMFRequest": { "type": "object", "title": "Send DTMF Request", "required": [ "digits" ], "properties": { "digits": { "description": "DTMF digits to send. Valid digits are 0-9, A-D, *, and #. Pauses can be added using w (0.5s) and W (1s).", "type": "string", "example": "1www2WABCDw9" }, "duration_millis": { "description": "Specifies for how many milliseconds each digit will be played in the audio stream. Ranges from 100 to 500ms", "type": "integer", "format": "int32", "example": 500, "default": 250 }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "digits": "1www2WABCDw9", "duration_millis": 500, "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "SendFaxMultipartRequest": { "type": "object", "title": "Send fax multipart request", "required": [ "connection_id", "contents", "from", "to" ], "properties": { "connection_id": { "$ref": "#/components/schemas/ConnectionId" }, "contents": { "description": "The file you want to upload. The maximum allowed size is 20 MB. contents and media_name/media_url can't be submitted together.", "type": "string", "format": "binary" }, "to": { "$ref": "#/components/schemas/To" }, "from": { "$ref": "#/components/schemas/From" }, "quality": { "$ref": "#/components/schemas/Quality" }, "t38_enabled": { "$ref": "#/components/schemas/T38Enabled" }, "monochrome": { "$ref": "#/components/schemas/Monochrome" }, "store_media": { "$ref": "#/components/schemas/StoreMedia" } } }, "SendFaxRequest": { "type": "object", "title": "Send fax request", "required": [ "connection_id", "from", "to" ], "properties": { "connection_id": { "description": "The connection ID to send the fax with.", "type": "string", "example": "234423" }, "media_url": { "$ref": "#/components/schemas/MediaUrl" }, "media_name": { "$ref": "#/components/schemas/MediaName" }, "to": { "$ref": "#/components/schemas/To" }, "from": { "$ref": "#/components/schemas/From" }, "from_display_name": { "description": "The `from_display_name` string to be used as the caller id name (SIP From Display Name) presented to the destination (`to` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the `from` field.", "type": "string", "example": "Company Name" }, "quality": { "$ref": "#/components/schemas/Quality" }, "t38_enabled": { "description": "The flag to disable the T.38 protocol.", "type": "boolean", "default": true }, "monochrome": { "description": "The flag to enable monochrome, true black and white fax results.", "type": "boolean", "default": false }, "store_media": { "description": "Should fax media be stored on temporary URL. It does not support media_name, they can't be submitted together.", "type": "boolean", "default": false }, "webhook_url": { "description": "Use this field to override the URL to which Telnyx will send subsequent webhooks for this fax.", "type": "string", "example": "https://www.example.com/server-b/" } } }, "ServicePlan": { "type": "string", "description": "Indicates the coverage of the termination regions. International and Global are the same but International may only be used for high volume/short duration Outbound Voice Profiles.", "enum": [ "us", "international", "global" ], "example": "global", "default": "global" }, "SessionEnded": { "type": "object", "title": "Session Ended", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "An identifier for the type of the resource." }, "event_type": { "type": "string", "example": "video.room.session.ended", "enum": [ "video.room.session.ended" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Uniquely identify the event." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Session ID that identifies the session that ended." }, "room_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Room ID that identifies the room where the session ended." }, "duration_secs": { "type": "integer", "example": 245, "description": "The duration in seconds of the session" }, "ended_reason": { "type": "string", "example": "stale", "description": "The reason why the session ended" } } } }, "example": { "record_type": "event", "event_type": "video.room.session.ended", "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "room_id": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "duration_secs": 235, "ended_reason": "stale" } } }, "SessionEndedEvent": { "type": "object", "title": "Session Ended Event", "properties": { "data": { "$ref": "#/components/schemas/SessionEnded" } } }, "SessionStarted": { "type": "object", "title": "Session Started", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "An identifier for the type of the resource." }, "event_type": { "type": "string", "example": "video.room.session.started", "enum": [ "video.room.session.started" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Uniquely identify the event." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "session_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Session ID that identifies the session that started." }, "room_id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0", "description": "Room ID that identifies the room where the session started." } } } }, "example": { "record_type": "event", "event_type": "video.room.session.started", "id": "6b61621f-62e0-4aad-ab11-9fd19e272e73", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "session_id": "7b61621f-62e0-4aad-ab11-9fd19e272e73", "room_id": "0ccc7b54-4df3-4bca-a65a-35a1ecc777f0" } } }, "SessionStartedEvent": { "type": "object", "title": "Session Started Event", "properties": { "data": { "$ref": "#/components/schemas/SessionStarted" } } }, "SettingsDataErrorMessage": { "title": "SettingsDataErrorMessage", "required": [ "message" ], "type": "object", "properties": { "message": { "title": "Message", "type": "string" } } }, "SharedCampaign": { "title": "SharedCampaign", "required": [ "brandId", "campaignId", "usecase" ], "type": "object", "properties": { "brandId": { "title": "Brandid", "type": "string", "description": "Alphanumeric identifier of the brand associated with this campaign." }, "campaignId": { "title": "Campaignid", "type": "string", "description": "Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC." }, "createDate": { "title": "Createdate", "type": "string", "description": "Unix timestamp when campaign was created." }, "status": { "title": "Status", "type": "string", "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. " }, "usecase": { "title": "Usecase", "type": "string", "description": "Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand." } }, "description": "Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service. Most attributes of campaignare immutable, including **usecase**, **vertical**, **brandId** and **cspId**." }, "SharedCampaignRecordSet": { "title": "SharedCampaignRecordSet", "type": "object", "properties": { "page": { "title": "Page", "type": "integer" }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/SharedCampaign" } }, "totalRecords": { "title": "Totalrecords", "type": "integer" } } }, "ShortCode": { "type": "object", "required": [ "messaging_profile_id" ], "example": { "record_type": "short_code", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "short_code": "12345", "country_code": "US", "messaging_profile_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "created_at": "2019-01-23T18:10:02.574Z", "updated_at": "2019-01-23T18:10:02.574Z" }, "properties": { "record_type": { "type": "string", "example": "short_code", "enum": [ "short_code" ], "description": "Identifies the type of the resource.", "readOnly": true }, "id": { "type": "string", "format": "uuid", "description": "Identifies the type of resource.", "readOnly": true }, "short_code": { "type": "string", "description": "Short digit sequence used to address messages.", "readOnly": true }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code.", "pattern": "^[A-Z]{2}$", "example": "US", "readOnly": true }, "messaging_profile_id": { "type": "string", "nullable": true, "description": "Unique identifier for a messaging profile." }, "created_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was created.", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted date indicating when the resource was updated.", "readOnly": true } } }, "SimCardDataUsageNotification": { "type": "object", "description": "The SIM card individual data usage notification information.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "79228acc-3f08-4e70-ac68-cb5aae8b537a" }, "sim_card_id": { "type": "string", "format": "uuid", "description": "The identification UUID of the related SIM card resource.", "example": "b34c1683-cd85-4493-b9a5-315eb4bc5e19" }, "record_type": { "type": "string", "example": "sim_card_data_usage_notification", "readOnly": true }, "threshold": { "type": "object", "description": "Data usage threshold that will trigger the notification.", "properties": { "amount": { "type": "string", "format": "decimal", "example": "2048.1" }, "unit": { "type": "string", "example": "MB", "enum": [ "MB", "GB" ] } } }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } }, "example": { "id": "79228acc-3f08-4e70-ac68-cb5aae8b537a", "sim_card_id": "b34c1683-cd85-4493-b9a5-315eb4bc5e19", "threshold": { "amount": "2048.0", "unit": "MB" }, "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z" } }, "SimCardOrderCreate": { "title": "SimCardOrderCreate", "type": "object", "properties": { "address_id": { "type": "string", "description": "Uniquely identifies the address for the order.", "format": "int64", "example": "1293384261075731499" }, "quantity": { "description": "The amount of SIM cards to order.", "type": "integer", "minimum": 1, "example": 23 } }, "required": [ "address_id", "quantity" ] }, "SimCardUsageDetailRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for this SIM Card Usage", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320", "format": "uuid" }, "created_at": { "type": "string", "description": "Event creation time", "format": "date-time", "example": "2020-07-01T00:00:00Z" }, "closed_at": { "type": "string", "description": "Event close time", "format": "date-time", "example": "2020-07-01T00:00:00Z" }, "ip_address": { "type": "string", "description": "Ip address that generated the event", "example": "100.64.1.2" }, "downlink_data": { "type": "number", "description": "Number of megabytes downloaded", "example": "0.1240" }, "imsi": { "type": "string", "description": "International Mobile Subscriber Identity", "example": "311210393720093" }, "mcc": { "type": "string", "description": "Mobile country code", "example": "204" }, "mnc": { "type": "string", "description": "Mobile network code", "example": "69" }, "currency": { "type": "string", "description": "Telnyx account currency used to describe monetary values, including billing cost", "example": "USD" }, "data_unit": { "type": "string", "description": "Unit of wireless link consumption", "example": "MB" }, "data_rate": { "type": "string", "format": "monetary_value", "description": "Currency amount per billing unit used to calculate the Telnyx billing cost", "example": "0.06000" }, "sim_group_name": { "type": "string", "description": "Sim group name for sim card", "example": "SIMBillingInfo test - otheraccount" }, "sim_card_id": { "type": "string", "description": "Unique identifier for SIM card", "example": "7aa66686-b39f-456d-8edc-5b6cffb1432a" }, "sim_group_id": { "type": "string", "description": "Unique identifier for SIM group", "example": "6c07e2e9-cbc0-49ba-ac0d-c59b59646bb1" }, "sim_card_tags": { "type": "string", "description": "User-provided tags", "example": "mytag" }, "phone_number": { "type": "string", "description": "Telephone number associated to SIM card", "example": "+15188490209" }, "uplink_data": { "type": "number", "description": "Number of megabytes uploaded", "example": "0.7653" }, "data_cost": { "type": "number", "description": "Data cost", "example": "0.0292830" }, "record_type": { "type": "string", "example": "sim_card_usage", "default": "sim_card_usage" } }, "required": [ "record_type" ] }, "SimpleSIMCard": { "type": "object", "title": "SIMCard", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "example": "sim_card", "readOnly": true }, "status": { "$ref": "#/components/schemas/SIMCardStatus" }, "type": { "type": "string", "description": "The type of SIM card", "readOnly": true, "example": "physical", "enum": [ "physical", "esim" ] }, "iccid": { "type": "string", "description": "The ICCID is the identifier of the specific SIM card/chip. Each SIM is internationally identified by its integrated circuit card identifier (ICCID). ICCIDs are stored in the SIM card's memory and are also engraved or printed on the SIM card body during a process called personalization.\n", "readOnly": true, "example": "89310410106543789301" }, "imsi": { "type": "string", "description": "SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI).
\nMobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home Location Register (HLR) or the Visitor Location Register (VLR).\n", "readOnly": true, "example": "081932214823362973" }, "msisdn": { "type": "string", "description": "Mobile Station International Subscriber Directory Number (MSISDN) is a number used to identify a mobile phone number internationally.
\nMSISDN is defined by the E.164 numbering plan. It includes a country code and a National Destination Code which identifies the subscriber's operator.\n", "readOnly": true, "example": "+13109976224" }, "sim_card_group_id": { "type": "string", "format": "uuid", "description": "The group SIMCardGroup identification. This attribute can be null when it's present in an associated resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "tags": { "type": "array", "description": "Searchable tags associated with the SIM card", "items": { "type": "string" }, "example": [ "personal", "customers", "active-customers" ] }, "data_limit": { "type": "object", "description": "The SIM card individual data limit configuration.", "readOnly": true, "properties": { "amount": { "type": "string", "format": "decimal", "example": "2048.0" }, "unit": { "type": "string", "example": "MB", "enum": [ "MB", "GB" ] } } }, "current_billing_period_consumed_data": { "type": "object", "description": "The SIM card consumption so far in the current billing cycle.", "readOnly": true, "properties": { "amount": { "type": "string", "format": "decimal", "example": "2049.0" }, "unit": { "type": "string", "example": "MB", "default": "MB" } } }, "actions_in_progress": { "type": "boolean", "description": "Indicate whether the SIM card has any pending (in-progress) actions.", "readOnly": true, "example": true, "default": false }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SimplifiedOTAUpdate": { "type": "object", "title": "OTAUpdate", "description": "This object represents an Over the Air (OTA) update request. It allows tracking the current status of a operation that apply settings in a particular SIM card.

", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "example": "ota_update", "readOnly": true }, "sim_card_id": { "type": "string", "format": "uuid", "description": "The identification UUID of the related SIM card resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "type": { "type": "string", "description": "Represents the type of the operation requested. This will relate directly to the source of the request.", "enum": [ "sim_card_network_preferences" ], "example": "sim_card_network_preferences" }, "status": { "type": "string", "enum": [ "in-progress", "completed", "failed" ], "example": "in-progress" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" } } }, "SingleManagedAccountGlobalOutboundChannels": { "title": "Global Outbound Channels Details for a Managed Account", "properties": { "channel_limit": { "type": "integer", "description": "Integer value that indicates the number of allocatable global outbound channels that are allocated to the managed account. If the value is 0 then the account will have no usable channels and will not be able to perform outbound calling.", "example": 30 }, "email": { "type": "string", "description": "The email of the managed account.", "example": "customer@example.org" }, "id": { "type": "string", "description": "The user ID of the managed account.", "example": "096abcde-1122-3344-ab77-ff0123456789" }, "manager_account_id": { "type": "string", "description": "The user ID of the manager of the account.", "example": "beeabcde-1122-3344-ab77-ff0123456789" }, "record_type": { "type": "string", "description": "The name of the type of data in the response.", "example": "managed_account_global_outbound_settings" } }, "example": { "channel_limit": 30, "email": "allocate_demo@customer.com", "id": "096abcde-1122-3344-ab77-ff0123456789", "manager_account_id": "beeabcde-1122-3344-ab77-ff0123456789", "record_type": "managed_account_global_outbound_settings" } }, "SipHeader": { "type": "object", "title": "SIP Header", "required": [ "name", "value" ], "properties": { "name": { "description": "The name of the header to add.", "type": "string", "enum": [ "User-to-User" ], "example": "User-to-User" }, "value": { "description": "The value of the header.", "type": "string", "example": "value" } }, "example": { "name": "User-to-User", "value": "value" } }, "SoleProprietorData": { "properties": { "city": { "description": "City name", "example": "New York", "maxLength": 100, "title": "City", "type": "string" }, "companyName": { "description": "(Required for Non-profit/private/public) Legal company name.", "example": "ABC Inc.", "maxLength": 100, "title": "Companyname", "type": "string" }, "country": { "description": "ISO2 2 characters country code. Example: US - United States", "example": "US", "maxLength": 2, "title": "Country", "type": "string" }, "description": { "description": "A brief description about the campaign.", "example": "This campaign belongs to Brand X and will be used for marketing.", "title": "Description", "type": "string" }, "displayName": { "description": "Display name, marketing name, or DBA name of the brand.", "example": "ABC Mobile", "maxLength": 100, "title": "Displayname", "type": "string" }, "email": { "description": "Valid email address of brand support contact.", "maxLength": 100, "title": "Email", "type": "string" }, "entityType": { "allOf": [ { "$ref": "#/components/schemas/EntityType" } ], "description": "Entity type behind the brand. This is the form of business establishment.", "example": "SMALL_BUSINESS" }, "firstName": { "description": "First name of business contact.", "example": "John", "maxLength": 100, "title": "Firstname", "type": "string" }, "lastName": { "description": "Last name of business contact.", "example": "Smith", "maxLength": 100, "title": "Lastname", "type": "string" }, "phone": { "description": "Valid phone number in e.164 international format.", "example": "+12024567890", "maxLength": 20, "title": "Phone", "type": "string" }, "phoneNumbers": { "description": "The phone numbers that will be assigned to the Sole Proprietor's campaign (Max of 5).", "example": [ "+12193849584", "+13129872456" ], "items": { "type": "string" }, "title": "Phonenumbers", "type": "array" }, "postalCode": { "description": "Postal codes. Use 5 digit zipcode for United States", "example": "10001", "maxLength": 10, "title": "Postalcode", "type": "string" }, "referenceId": { "description": "A user generated unique identifier that keeps track of sole proprietor brand/campaign combinations submitted during bulk creation.", "example": "4q90017a-2f50-4c90-c9e6-5f67304cbde9", "title": "Referenceid", "type": "string" }, "sampleMessages": { "description": "The sample_messages that will be assigned to the Sole Proprietor's campaign (Max of 5).", "example": [ "Sample message 1", "Sample message 2" ], "items": { "type": "string" }, "title": "Samplemessages", "type": "array" }, "state": { "description": "State. Must be 2 letters code for United States.", "example": "NY", "maxLength": 20, "title": "State", "type": "string" }, "street": { "description": "Street number and name.", "example": "123", "maxLength": 100, "title": "Street", "type": "string" }, "subUsecases": { "description": "The sub use cases that will be assigned to the Sole Proprietor's campaign (Max of 5).", "example": [ "MARKETING", "2FA" ], "items": { "$ref": "#/components/schemas/Usecase" }, "type": "array" }, "vertical": { "allOf": [ { "$ref": "#/components/schemas/Vertical" } ], "description": "Vertical or industry segment of the brand." }, "website": { "description": "Brand website URL.", "example": "http://www.abcmobile.com", "maxLength": 100, "title": "Website", "type": "string" } }, "required": [ "entityType", "displayName", "country", "email", "vertical", "phoneNumbers", "subUsecases", "sampleMessages", "description", "referenceId" ], "title": "SoleProprietorData", "type": "object" }, "SoundModifications": { "type": "object", "title": "Sound modifications", "description": "Use this field to modify sound effects, for example adjust the pitch.", "properties": { "pitch": { "description": "Set the pitch directly, value should be > 0, default 1 (lower = lower tone)", "type": "number", "format": "double", "example": 0.8 }, "semitone": { "description": "Adjust the pitch in semitones, values should be between -14 and 14, default 0", "type": "number", "format": "double", "example": -10 }, "octaves": { "description": "Adjust the pitch in octaves, values should be between -1 and 1, default 0", "type": "number", "format": "double", "example": -0.5 }, "track": { "description": "The track to which the sound modifications will be applied. Accepted values are `inbound` or `outbound`", "type": "string", "example": "inbound", "default": "outbound" } }, "example": { "pitch": "0.8", "semitone": -2, "octaves": 0.1, "track": "both" } }, "SpeakRequest": { "type": "object", "title": "Speak Request", "required": [ "payload", "voice" ], "properties": { "payload": { "description": "The text or SSML to be converted into speech. There is a 3,000 character limit.", "type": "string", "example": "Say this on the call" }, "payload_type": { "description": "The type of the provided payload. The payload can either be plain text, or Speech Synthesis Markup Language (SSML).", "default": "text", "type": "string", "enum": [ "text", "ssml" ], "example": "ssml" }, "service_level": { "description": "This parameter impacts speech quality, language options and payload types. When using `basic`, only the `en-US` language and payload type `text` are allowed.", "default": "premium", "type": "string", "enum": [ "basic", "premium" ], "example": "premium" }, "stop": { "description": "When specified, it stops the current audio being played. Specify `current` to stop the current audio being played, and to play the next file in the queue. Specify `all` to stop the current audio file being played and to also clear all audio files from the queue.", "type": "string", "example": "current" }, "voice": { "description": "The gender of the voice used to speak back the text or the specific Amazon Polly voice to be used in the form of `Polly.`, e.g. `Polly.Brian`. All standard Amazon Polly voices are supported.", "type": "string", "enum": [ "male", "female" ], "example": "female" }, "language": { "description": "The language you want spoken. This parameter is ignored when a `Polly.*` voice is specified.", "type": "string", "enum": [ "arb", "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "hi-IN", "is-IS", "it-IT", "ja-JP", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR" ], "example": "en-US" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "payload": "Say this on the call", "payload_type": "text", "service_level": "basic", "stop": "current", "voice": "female", "language": "arb", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "StartConferenceRecordingRequest": { "type": "object", "title": "Start Conference Recording Request", "required": [ "format" ], "properties": { "format": { "description": "The audio file format used when storing the conference recording. Can be either `mp3` or `wav`.", "type": "string", "enum": [ "wav", "mp3" ], "example": "mp3" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `conference_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "play_beep": { "description": "If enabled, a beep sound will be played at the start of a recording.", "type": "boolean", "example": true }, "trim": { "description": "When set to `trim-silence`, silence will be removed from the beginning and end of the recording.", "enum": [ "trim-silence" ], "type": "string", "example": "trim-silence" }, "custom_file_name": { "description": "The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix.", "type": "string", "min_length": 1, "max_length": 40, "example": "my_recording_file_name" } }, "example": { "format": "wav", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "play_beep": true } }, "StartForkingRequest": { "type": "object", "title": "Start Forking Request", "properties": { "target": { "description": "The network target, , where the call's RTP media packets should be forwarded. Both incoming and outgoing media packets will be delivered to the specified target, and information about the stream will be included in the encapsulation protocol header, including the direction (0 = inbound; 1 = outbound), leg (0 = A-leg; 1 = B-leg), and call_leg_id.", "type": "string", "example": "udp:192.0.2.1:9000" }, "rx": { "description": "The network target, , where the call's incoming RTP media packets should be forwarded.", "type": "string", "example": "udp:192.0.2.1:9000" }, "stream_type": { "description": "Optionally specify a media type to stream. If `decrypted` selected, Telnyx will decrypt incoming SIP media before forking to the target. `rx` and `tx` are required fields if `decrypted` selected.", "type": "string", "enum": [ "raw", "decrypted" ], "default": "raw", "example": "decrypted" }, "tx": { "description": "The network target, , where the call's outgoing RTP media packets should be forwarded.", "type": "string", "example": "udp:192.0.2.1:9001" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "target": "udp:192.0.2.1:9000", "rx": "udp:192.0.2.1:9000", "tx": "udp:192.0.2.1:9001", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "StartRecordingRequest": { "type": "object", "title": "Start Recording Request", "required": [ "format", "channels" ], "properties": { "format": { "description": "The audio file format used when storing the call recording. Can be either `mp3` or `wav`.", "type": "string", "enum": [ "wav", "mp3" ], "example": "mp3" }, "channels": { "description": "When `dual`, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.", "enum": [ "single", "dual" ], "type": "string", "example": "single" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "play_beep": { "description": "If enabled, a beep sound will be played at the start of a recording.", "type": "boolean", "example": true }, "max_length": { "description": "Defines the maximum length for the recording in seconds. The minimum value is 0. The maximum value is 14400. The default value is 0 (infinite)", "type": "integer", "example": 100, "default": 0, "format": "int32" }, "timeout_secs": { "description": "The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that call transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite)", "type": "integer", "example": 100, "default": 0, "format": "int32" }, "recording_track": { "description": "The audio track to be recorded. Can be either `both`, `inbound` or `outbound`. If only single track is specified (`inbound`, `outbound`), `channels` configuration is ignored and it will be recorded as mono (single channel).", "type": "string", "example": "outbound", "default": "both", "enum": [ "both", "inbound", "outbound" ] }, "trim": { "description": "When set to `trim-silence`, silence will be removed from the beginning and end of the recording.", "enum": [ "trim-silence" ], "type": "string", "example": "trim-silence" }, "custom_file_name": { "description": "The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix.", "type": "string", "min_length": 1, "max_length": 40, "example": "my_recording_file_name" } }, "example": { "format": "wav", "channels": "single", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "play_beep": true, "max_length": 0, "timeout_secs": 0 } }, "StartStreamingRequest": { "type": "object", "title": "Start Streaming Request", "properties": { "stream_url": { "description": "The destination WebSocket address where the stream is going to be delivered.", "type": "string", "example": "wss://www.example.com/websocket" }, "stream_track": { "description": "Specifies which track should be streamed.", "type": "string", "enum": [ "inbound_track", "outbound_track", "both_tracks" ], "default": "inbound_track", "example": "both_tracks" }, "enable_dialogflow": { "description": "Enables Dialogflow for the current call. The default value is false.", "type": "boolean", "default": false, "example": true }, "dialogflow_config": { "$ref": "#/components/schemas/DialogflowConfig" }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "stream_url": "wss://www.example.com/websocket", "stream_track": "both_tracks", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "enable_dialogflow": false, "dialogflow_config": { "analyze_sentiment": false, "partial_automated_agent_reply": false } } }, "Status": { "title": "Status", "enum": [ "ACTIVE", "EXPIRED" ], "description": "An enumeration." }, "StockExchange": { "title": "StockExchange", "enum": [ "NONE", "NASDAQ", "NYSE", "AMEX", "AMX", "ASX", "B3", "BME", "BSE", "FRA", "ICEX", "JPX", "JSE", "KRX", "LON", "NSE", "OMX", "SEHK", "SSE", "STO", "SWX", "SZSE", "TSX", "TWSE", "VSE" ], "description": "(Required for public company) stock exchange.", "example": "NASDAQ" }, "StopForkingRequest": { "type": "object", "title": "Stop Forking Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "stream_type": { "description": "Optionally specify a `stream_type`. This should match the `stream_type` that was used in `fork_start` command to properly stop the fork.", "type": "string", "enum": [ "raw", "decrypted" ], "default": "raw", "example": "decrypted" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "StopGatherRequest": { "type": "object", "title": "Stop Gather Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "StopRecordingRequest": { "type": "object", "title": "Stop Recording Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "StopStreamingRequest": { "type": "object", "title": "Stop Streaming Request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "StoreMedia": { "description": "Should fax media be stored on temporary URL. It does not support media_name, they can't be submitted together.", "type": "boolean", "default": false }, "StoredMedia": { "description": "Should fax media be stored on temporary URL. It does not support media_name, they can't be submitted together.", "type": "boolean", "default": false }, "SubNumberOrder": { "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "order_request_id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c293", "readOnly": true }, "country_code": { "type": "string", "example": "US", "readOnly": true }, "phone_number_type": { "type": "string", "example": "local", "enum": [ "local", "toll_free", "mobile", "national", "shared_cost", "landline" ] }, "user_id": { "type": "string", "format": "uuid", "example": "d70873cd-7c98-401a-81b6-b1ae08246995" }, "regulatory_requirements": { "type": "array", "items": { "$ref": "#/components/schemas/SubNumberOrderRegulatoryRequirement" } }, "record_type": { "type": "string", "example": "sub_number_order", "readOnly": true }, "phone_numbers_count": { "type": "integer", "description": "The count of phone numbers in the number order.", "example": 1, "readOnly": true }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number order was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for every phone number, false otherwise.", "example": true, "readOnly": true } } }, "SubNumberOrderRegulatoryRequirement": { "properties": { "record_type": { "type": "string", "example": "phone_number_regulatory_requirement", "readOnly": true }, "requirement_id": { "type": "string", "format": "uuid", "description": "Unique id for a requirement.", "example": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" }, "field_type": { "type": "string", "enum": [ "textual", "datetime", "address", "document" ], "example": "address", "readOnly": true } } }, "SubNumberOrderRegulatoryRequirementWithValue": { "properties": { "record_type": { "type": "string", "example": "phone_number_regulatory_requirement", "readOnly": true }, "requirement_id": { "type": "string", "format": "uuid", "description": "Unique id for a requirement.", "example": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" }, "field_type": { "type": "string", "enum": [ "textual", "datetime", "address", "document" ], "example": "address", "readOnly": true }, "field_value": { "type": "string", "description": "The value of the requirement, this could be an id to a resource or a string value.", "example": "45f45a04-b4be-4592-95b1-9306b9db2b21" } } }, "SummaryRequest": { "properties": { "bucket": { "type": "string", "title": "Bucket" }, "filename": { "type": "string", "title": "Filename" } }, "type": "object", "required": [ "bucket" ], "title": "SummaryRequest" }, "SummaryResponse": { "properties": { "summary": { "type": "string", "title": "Summary" } }, "type": "object", "required": [ "summary" ], "title": "SummaryResponse" }, "SummaryResponseData": { "properties": { "data": { "$ref": "#/components/schemas/SummaryResponse" } }, "type": "object", "required": [ "data" ], "title": "SummaryResponseData" }, "SupportedEmbeddingLoaders": { "type": "string", "enum": [ "default", "intercom" ], "title": "SupportedEmbeddingLoaders", "description": "Supported types of custom document loaders for embeddings." }, "SupportedEmbeddingModels": { "type": "string", "enum": [ "thenlper/gte-large", "intfloat/multilingual-e5-large", "sentence-transformers/all-mpnet-base-v2" ], "title": "SupportedEmbeddingModels", "description": "Supported models to vectorize and embed documents." }, "T38Enabled": { "description": "The flag to disable the T.38 protocol.", "type": "boolean", "default": true }, "TFPhoneNumber": { "title": "PhoneNumber", "required": [ "phoneNumber" ], "type": "object", "properties": { "phoneNumber": { "title": "Phonenumber", "type": "string" } }, "description": "A phone number" }, "TFVerificationRequest": { "title": "VerificationRequest", "required": [ "businessName", "corporateWebsite", "businessAddr1", "businessCity", "businessState", "businessZip", "businessContactFirstName", "businessContactLastName", "businessContactEmail", "businessContactPhone", "messageVolume", "phoneNumbers", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "optInWorkflowImageURLs", "additionalInformation", "isvReseller" ], "type": "object", "properties": { "businessName": { "title": "Businessname", "type": "string", "example": "Telnyx LLC" }, "corporateWebsite": { "title": "Corporatewebsite", "type": "string", "example": "http://example.com" }, "businessAddr1": { "title": "Businessaddr1", "type": "string", "example": "311 W Superior St" }, "businessAddr2": { "title": "Businessaddr2", "type": "string", "example": "121 W Superior St" }, "businessCity": { "title": "Businesscity", "type": "string", "example": "Chicago" }, "businessState": { "title": "Businessstate", "type": "string", "example": "Illinois" }, "businessZip": { "title": "Businesszip", "type": "string", "example": "60654" }, "businessContactFirstName": { "title": "Businesscontactfirstname", "type": "string", "example": "John" }, "businessContactLastName": { "title": "Businesscontactlastname", "type": "string", "example": "Doe" }, "businessContactEmail": { "title": "Businesscontactemail", "type": "string", "example": "email@example.com" }, "businessContactPhone": { "title": "Businesscontactphone", "type": "string", "example": "+18005550100" }, "messageVolume": { "allOf": [ { "$ref": "#/components/schemas/Volume" } ], "description": "One of the following exact values: 10; 100; 1,000; 10,000; 100,000; 250,000; 500,000; 750,000; 1,000,000; 5,000,000; 10,000,000+", "example": "100,000" }, "phoneNumbers": { "title": "Phonenumbers", "type": "array", "items": { "$ref": "#/components/schemas/TFPhoneNumber" }, "example": [ { "phoneNumber": "+18773554398" }, { "phoneNumber": "+18773554399" } ] }, "useCase": { "allOf": [ { "$ref": "#/components/schemas/UseCaseCategories" } ], "example": "2FA" }, "useCaseSummary": { "title": "Usecasesummary", "type": "string", "example": "This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal" }, "productionMessageContent": { "title": "Productionmessagecontent", "type": "string", "example": "Your Telnyx OTP is XXXX" }, "optInWorkflow": { "title": "Optinworkflow", "type": "string", "example": "User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset" }, "optInWorkflowImageURLs": { "title": "Optinworkflowimageurls", "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/Url" }, "example": [ { "url": "https://telnyx.com/sign-up" }, { "url": "https://telnyx.com/company/data-privacy" } ] }, "additionalInformation": { "title": "Additionalinformation", "type": "string", "example": "This is for security purposes, blah blah blah" }, "isvReseller": { "title": "Isvreseller", "type": "string", "example": "Yes" }, "webhookUrl": { "title": "Webhookurl", "type": "string", "example": "http://example-webhook.com" } }, "description": "The body of a tollfree verification request" }, "TFVerificationStatus": { "title": "VerificationStatus", "enum": [ "Verified", "Rejected", "Waiting For Vendor", "Waiting For Customer", "In Progress" ], "type": "string", "description": "Tollfree verification status" }, "TaskStatus": { "title": "TaskStatus", "enum": [ "pending", "processing", "completed", "failed" ], "type": "string", "description": "An enumeration." }, "TaskStatusResponse": { "properties": { "data": { "type": "object", "properties": { "task_id": { "type": "string", "format": "uuid", "title": "Task ID" }, "task_name": { "type": "string", "title": "Task Name" }, "status": { "type": "string", "title": "Status" }, "created_at": { "type": "string", "title": "Created At" }, "finished_at": { "type": "string", "title": "Finished At" } } } }, "type": "object", "required": [ "data" ], "title": "TaskStatusResponse" }, "TelephonyCredential": { "type": "object", "title": "On-demand Credential", "properties": { "id": { "type": "string", "format": "string", "description": "Identifies the resource.", "example": "c215ade3-0d39-418e-94be-c5f780760199" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "credential" }, "name": { "type": "string" }, "resource_id": { "type": "string", "description": "Identifies the resource this credential is associated with.", "example": "connection:1234567890" }, "expired": { "type": "boolean", "description": "Defaults to false" }, "sip_username": { "type": "string", "description": "The randomly generated SIP username for the credential.", "example": "gencrednCvHU5IYpSBPPsXI2iQsDX" }, "sip_password": { "type": "string", "description": "The randomly generated SIP password for the credential.", "example": "a92dbcfb60184a8cb330b0acb2f7617b" }, "created_at": { "type": "string", "description": "ISO-8601 formatted date indicating when the resource was created.", "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO-8601 formatted date indicating when the resource was updated.", "example": "2018-02-02T22:25:27.521Z" }, "expires_at": { "type": "string", "description": "ISO-8601 formatted date indicating when the resource will expire.", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "id": "c215ade3-0d39-418e-94be-c5f780760199", "record_type": "credential", "name": "2020-06-18 21:32:38.917732Z", "expired": "false", "user_id": "user-id", "resource_id": "connection:804252963366242252", "sip_password": "a92dbcfb60184a8cb330b0acb2f7617b", "sip_username": "gencrednCvHU5IYpSBPPsXI2iQsDX", "created_at": "2020-06-18T21:32:38", "expires_at": "2042-06-18T21:32:38", "updated_at": "2020-06-18T21:32:38.000Z" } }, "TelephonyCredentialCreateRequest": { "type": "object", "title": "TelephonyCredentialCreateRequest", "required": [ "connection_id" ], "properties": { "name": { "type": "string" }, "tag": { "type": "string", "description": "Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials.", "example": "some_tag" }, "connection_id": { "type": "string", "description": "Identifies the Credential Connection this credential is associated with.", "example": "1234567890" }, "expires_at": { "type": "string", "description": "ISO-8601 formatted date indicating when the credential will expire.", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "name": "My-new-credential", "connection_id": "1234567890" } }, "TelephonyCredentialUpdateRequest": { "type": "object", "title": "TelephonyCredentialUpdateRequest", "properties": { "name": { "type": "string" }, "tag": { "type": "string", "description": "Tags a credential to filter for bulk operations. A single tag can hold at maximum 1000 credentials.", "example": "some_tag" }, "connection_id": { "type": "string", "description": "Identifies the Credential Connection this credential is associated with.", "example": "987654321" }, "expires_at": { "type": "string", "description": "ISO-8601 formatted date indicating when the credential will expire.", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "name": "My-new-updated-credential", "connection_id": "987654321" } }, "TelnyxBrand": { "title": "TelnyxBrand", "required": [ "entityType", "displayName", "country", "email", "brandRelationship", "vertical" ], "type": "object", "properties": { "entityType": { "allOf": [ { "$ref": "#/components/schemas/EntityType" } ], "description": "Entity type behind the brand. This is the form of business establishment." }, "cspId": { "title": "Cspid", "type": "string", "description": "Unique identifier assigned to the csp by the registry." }, "brandId": { "title": "Brandid", "type": "string", "description": "Unique identifier assigned to the brand by the registry." }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display or marketing name of the brand.", "example": "ABC Mobile" }, "companyName": { "title": "Companyname", "maxLength": 100, "type": "string", "description": "(Required for Non-profit/private/public) Legal company name.", "example": "ABC Inc." }, "firstName": { "title": "Firstname", "maxLength": 100, "type": "string", "description": "First name of business contact.", "example": "John" }, "lastName": { "title": "Lastname", "maxLength": 100, "type": "string", "description": "Last name of business contact.", "example": "Smith" }, "ein": { "title": "Ein", "maxLength": 20, "type": "string", "description": "(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.", "example": "111111111" }, "phone": { "title": "Phone", "maxLength": 20, "type": "string", "description": "Valid phone number in e.164 international format.", "example": "+12024567890" }, "street": { "title": "Street", "maxLength": 100, "type": "string", "description": "Street number and name.", "example": "123" }, "city": { "title": "City", "maxLength": 100, "type": "string", "description": "City name", "example": "New York" }, "state": { "title": "State", "maxLength": 20, "type": "string", "description": "State. Must be 2 letters code for United States.", "example": "NY" }, "postalCode": { "title": "Postalcode", "maxLength": 10, "type": "string", "description": "Postal codes. Use 5 digit zipcode for United States", "example": "10001" }, "country": { "title": "Country", "maxLength": 2, "type": "string", "description": "ISO2 2 characters country code. Example: US - United States", "example": "US" }, "email": { "title": "Email", "maxLength": 100, "type": "string", "description": "Valid email address of brand support contact." }, "stockSymbol": { "title": "Stocksymbol", "maxLength": 10, "type": "string", "description": "(Required for public company) stock symbol.", "example": "ABC" }, "stockExchange": { "allOf": [ { "$ref": "#/components/schemas/StockExchange" } ], "description": "(Required for public company) stock exchange.", "example": "NASDAQ" }, "ipAddress": { "title": "Ipaddress", "maxLength": 50, "type": "string", "description": "IP address of the browser requesting to create brand identity." }, "website": { "title": "Website", "maxLength": 100, "type": "string", "description": "Brand website URL.", "example": "http://www.abcmobile.com" }, "brandRelationship": { "allOf": [ { "$ref": "#/components/schemas/BrandRelationship" } ], "description": "Brand relationship to the CSP" }, "vertical": { "title": "Vertical", "maxLength": 50, "type": "string", "description": "Vertical or industry segment of the brand." }, "altBusinessId": { "title": "Altbusinessid", "maxLength": 50, "type": "string", "description": "Alternate business identifier such as DUNS, LEI, or GIIN" }, "altBusinessIdType": { "$ref": "#/components/schemas/AltBusinessIdType" }, "universalEin": { "title": "Universalein", "type": "string", "description": "Universal EIN of Brand, Read Only." }, "referenceId": { "title": "Referenceid", "type": "string", "description": "Unique identifier Telnyx assigned to the brand - the brandId" }, "identityStatus": { "$ref": "#/components/schemas/BrandIdentityStatus" }, "optionalAttributes": { "$ref": "#/components/schemas/BrandOptionalAttributes" }, "mock": { "title": "Mock", "type": "boolean", "description": "Mock brand for testing purposes", "default": false }, "mobilePhone": { "title": "Mobilephone", "maxLength": 20, "type": "string", "description": "Valid mobile phone number in e.164 international format.", "example": "+12024567890" }, "isReseller": { "title": "Isreseller", "type": "boolean", "description": "Indicates whether this brand is known to be a reseller", "default": false } }, "description": "Telnyx-specific extensions to The Campaign Registry's `Brand` type" }, "TexmlApplication": { "type": "object", "title": "Texml Application", "properties": { "id": { "$ref": "#/components/schemas/IntId" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "texml_application" }, "friendly_name": { "$ref": "#/components/schemas/ApplicationName" }, "active": { "$ref": "#/components/schemas/ConnectionActive" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "first_command_timeout": { "$ref": "#/components/schemas/FirstCommandTimeout" }, "first_command_timeout_secs": { "$ref": "#/components/schemas/FirstCommandTimeoutSecs" }, "voice_url": { "type": "string", "description": "URL to which Telnyx will deliver your XML Translator webhooks.", "format": "url", "example": "https://example.com" }, "voice_fallback_url": { "type": "string", "description": "URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.", "default": null, "format": "url", "example": "https://fallback.example.com" }, "voice_method": { "type": "string", "description": "HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.", "enum": [ "get", "post" ], "default": "post", "example": "get" }, "status_callback": { "type": "string", "description": "URL for Telnyx to send requests to containing information about call progress events.", "default": null, "format": "url", "example": "https://example.com" }, "status_callback_method": { "type": "string", "description": "HTTP request method Telnyx should use when requesting the status_callback URL.", "enum": [ "get", "post" ], "default": "post", "example": "get" }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "shaken_stir_enabled": { "type": "boolean", "description": "When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.", "default": false, "example": false }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.", "default": null, "example": "example" }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ], "default": "from_anyone", "example": "only_my_connections" } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } }, "created_at": { "$ref": "#/components/schemas/CreatedAt" }, "updated_at": { "$ref": "#/components/schemas/UpdatedAt" } }, "example": { "id": "1293384261075731499", "record_type": "texml_application", "active": false, "friendly_name": "call-router", "anchorsite_override": "Amsterdam, Netherlands", "dtmf_type": "Inband", "first_command_timeout": true, "first_command_timeout_secs": 10, "voice_url": "https://example.com", "voice_fallback_url": "https://fallback.example.com", "voice_method": "get", "status_callback": "https://example.com", "status_callback_method": "get", "inbound": { "channel_limit": 10, "shaken_stir_enabled": true, "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" }, "created_at": "2020-02-02T22:25:27.521Z", "updated_at": "2020-02-03T22:25:27.521Z" } }, "TexmlCreateCallRecordingRequestBody": { "type": "object", "title": "Texml Create Call Recording Request Body", "properties": { "RecordingStatusCallbackEvent": { "$ref": "#/components/schemas/RecordingStatusCallbackEvent" }, "RecordingStatusCallback": { "$ref": "#/components/schemas/TexmlStatusCallback" }, "RecordingStatusCallbackMethod": { "$ref": "#/components/schemas/TexmlStatusCallbackMethod" }, "RecordingChannels": { "$ref": "#/components/schemas/TexmlRecordingChannels" }, "RecordingTrack": { "$ref": "#/components/schemas/RecordingTrack" } } }, "TexmlCreateCallRecordingResponseBody": { "type": "object", "title": "Texml Create Call Recording Response Body", "properties": { "account_sid": { "$ref": "#/components/schemas/AccountSid" }, "call_sid": { "$ref": "#/components/schemas/CallControlId" }, "conference_sid": { "$ref": "#/components/schemas/ConferenceSid" }, "channels": { "$ref": "#/components/schemas/TwimlRecordingChannels" }, "date_created": { "$ref": "#/components/schemas/DateTimeRFC2822" }, "date_updated": { "$ref": "#/components/schemas/DateTimeRFC2822" }, "start_time": { "$ref": "#/components/schemas/DateTimeRFC2822" }, "price": { "$ref": "#/components/schemas/TexmlRecordingPrice" }, "price_unit": { "$ref": "#/components/schemas/TexmlPriceUnit" }, "duration": { "$ref": "#/components/schemas/TexmlRecordingDuration" }, "sid": { "$ref": "#/components/schemas/TexmlSid" }, "source": { "$ref": "#/components/schemas/RecordingSource" }, "error_code": { "$ref": "#/components/schemas/TexmlErrorCode" }, "track": { "$ref": "#/components/schemas/RecordingTrack" }, "uri": { "type": "string", "description": "The relative URI for this recording resource.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json" } } }, "TexmlErrorCode": { "type": "string", "nullable": true, "example": null }, "TexmlGetCallRecordingResponseBody": { "type": "object", "title": "Texml Get Call Recording Response Body", "properties": { "account_sid": { "$ref": "#/components/schemas/AccountSid" }, "call_sid": { "$ref": "#/components/schemas/CallControlId" }, "conference_sid": { "$ref": "#/components/schemas/ConferenceSid" }, "channels": { "$ref": "#/components/schemas/TwimlRecordingChannels" }, "date_created": { "$ref": "#/components/schemas/DateTimeRFC2822" }, "date_updated": { "$ref": "#/components/schemas/DateTimeRFC2822" }, "start_time": { "$ref": "#/components/schemas/DateTimeRFC2822" }, "duration": { "$ref": "#/components/schemas/TexmlRecordingDuration" }, "sid": { "$ref": "#/components/schemas/TexmlSid" }, "source": { "$ref": "#/components/schemas/RecordingSource" }, "status": { "$ref": "#/components/schemas/TexmlRecordingStatus" }, "error_code": { "$ref": "#/components/schemas/TexmlErrorCode" }, "subresources_uris": { "$ref": "#/components/schemas/TexmlRecordingSubresourcesUris" }, "uri": { "type": "string", "description": "The relative URI for this recording resource.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json" }, "media_url": { "$ref": "#/components/schemas/TexmlRecordingMediaUrl" } } }, "TexmlGetCallRecordingsResponseBody": { "type": "object", "title": "Multiple recording resources", "properties": { "recordings": { "type": "array", "items": { "$ref": "#/components/schemas/TexmlGetCallRecordingResponseBody" } }, "end": { "type": "integer", "description": "The number of the last element on the page, zero-indexed.", "example": 19 }, "first_page_uri": { "type": "string", "format": "uri", "description": "Relative uri to the first page of the query results", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1" }, "previous_page_uri": { "type": "string", "format": "uri", "description": "Relative uri to the previous page of the query results", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1" }, "next_page_uri": { "type": "string", "description": "Relative uri to the next page of the query results", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1" }, "page": { "type": "integer", "description": "Current page number, zero-indexed.", "example": 0 }, "page_size": { "type": "integer", "description": "The number of items on the page", "example": 20 }, "start": { "type": "integer", "description": "The number of the first element on the page, zero-indexed.", "example": 0 }, "uri": { "type": "string", "description": "The URI of the current page.", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1" } } }, "TexmlPriceUnit": { "type": "string", "description": "The unit in which the price is given.", "example": "USD", "nullable": true }, "TexmlRecordingChannels": { "type": "string", "enum": [ "mono", "dual" ], "description": "When `dual`, final audio file has the first leg on channel A, and the rest on channel B. `mono` mixes both tracks into a single channel.", "example": "mono", "default": "dual" }, "TexmlRecordingDuration": { "type": "string", "description": "The duration of this recording, given in seconds.", "example": "12", "nullable": true }, "TexmlRecordingMediaUrl": { "type": "string", "format": "uri", "example": "http://recordings.com/mp3/filename.mp3" }, "TexmlRecordingPrice": { "type": "string", "description": "The price of this recording, the currency is specified in the price_unit field. ", "example": "0.10", "nullable": true }, "TexmlRecordingStatus": { "type": "string", "enum": [ "in-progress", "completed", "paused", "stopped" ], "example": "paused" }, "TexmlRecordingSubresourcesUris": { "type": "object", "title": "Texml recording subresources uris", "description": "Subresources details for a recording if available.", "properties": { "transcriptions": { "type": "string", "format": "uri", "example": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac/Transcriptions.json", "nullable": true } } }, "TexmlSid": { "type": "string", "description": "Identifier of a resource.", "example": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0" }, "TexmlStatusCallback": { "description": "Url where status callbacks will be sent.", "example": "http://webhook.com/callback", "type": "string", "format": "uri" }, "TexmlStatusCallbackMethod": { "description": "HTTP method used to send status callbacks.", "example": "GET", "type": "string", "default": "POST", "enum": [ "GET", "POST" ] }, "TexmlUpdateCallRecordingRequestBody": { "type": "object", "title": "Texml Create Call Recording Request Body", "properties": { "Status": { "type": "string", "enum": [ "in-progress", "paused", "stopped" ], "example": "paused" } } }, "TnReleaseEntry": { "type": "object", "title": "TnReleaseEntry", "properties": { "phone_number": { "type": "string", "description": "Phone number in E164 format." }, "number_id": { "type": "string", "description": "Phone number ID from the Telnyx API." } } }, "TnUploadEntry": { "type": "object", "title": "TnUploadEntry", "properties": { "number_id": { "$ref": "#/components/schemas/UUID" }, "phone_number": { "type": "string", "description": "Phone number in E164 format." }, "status": { "type": "string", "enum": [ "pending_upload", "pending", "in_progress", "success", "error" ], "description": "Represents the status of the phone number entry upload on Microsoft Teams.", "example": "error", "default": "pending_upload" }, "error_code": { "type": "string", "enum": [ "internal_error", "unable_to_retrieve_default_location", "unknown_country_code", "unable_to_retrieve_location", "unable_to_retrieve_partner_info", "unable_to_match_geography_entry" ], "description": "A code returned by Microsoft Teams if there is an error with the phone number entry upload.", "example": "internal_error" }, "error_message": { "type": "string", "description": "A message returned by Microsoft Teams if there is an error with the upload process." }, "civic_address_id": { "type": "string", "format": "uuid", "description": "Identifies the civic address assigned to the phone number entry." }, "location_id": { "type": "string", "format": "uuid", "description": "Identifies the location assigned to the phone number entry." }, "internal_status": { "type": "string", "enum": [ "pending_assignment", "in_progress", "all_internal_jobs_completed", "release_requested", "release_completed", "error" ], "description": "Represents the status of the phone number entry upload on Telnyx.", "example": "error", "default": "pending_assignment" } } }, "To": { "description": "The phone number, in E.164 format, the fax will be sent to or SIP URI", "type": "string", "example": "+13127367276" }, "ToNumber": { "type": "string", "format": "address", "description": "Receiving address (+E.164 formatted phone number or short code).", "example": "+E.164" }, "TrafficType": { "type": "string", "description": "Specifies the type of traffic allowed in this profile.", "enum": [ "conversational", "short_duration" ], "example": "conversational", "default": "conversational" }, "Transcription": { "type": "object", "title": "Transcription", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.transcription", "enum": [ "call.transcription" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "description": "Unique identifier and token for controlling the call.", "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg" }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "transcription_data": { "type": "object", "properties": { "confidence": { "type": "number", "format": "double", "example": 0.977219, "description": "Speech recognition confidence level." }, "is_final": { "type": "boolean", "example": true, "description": "When false, it means that this is an interim result." }, "transcript": { "type": "string", "example": "hello this is a test speech", "description": "Recognized text." } } } } } }, "example": { "record_type": "event", "event_type": "call.transcription", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "call_control_id": "v2:7subYr8fLrXmaAXm8egeAMpoSJ72J3SGPUuome81-hQuaKRf9b7hKA", "call_leg_id": "5ca81340-5beb-11eb-ae45-02420a0f8b69", "call_session_id": "5ca81eee-5beb-11eb-ba6c-02420a0f8b69", "client_state": null, "connection_id": "1240401930086254526", "transcription_data": { "confidence": 0.977219, "is_final": true, "transcript": "hello this is a test speech" } } } }, "TranscriptionEvent": { "type": "object", "title": "Transcription Event", "properties": { "data": { "$ref": "#/components/schemas/Transcription" } } }, "TranscriptionStartRequest": { "type": "object", "title": "Transcription start request", "properties": { "transcription_engine": { "description": "Engine to use for speech recognition. `A` - `google`, `B` - `telnyx`.", "type": "string", "enum": [ "A", "B" ], "default": "A", "example": "A" }, "language": { "description": "Language to use for speech recognition", "type": "string", "enum": [ "de", "en", "es", "fr", "it", "pl" ], "default": "en", "example": "en" }, "interim_results": { "type": "boolean", "description": "Whether to send also interim results. If set to false, only final results will be sent. Applies to `google` engine only.", "default": false, "example": true }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "transcription_tracks": { "description": "Indicates which leg of the call will be transcribed. Use `inbound` for the leg that requested the transcription, `outbound` for the other leg, and `both` for both legs of the call. Will default to `inbound`.", "type": "string", "example": "both", "default": "inbound" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "language": "en", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "TranscriptionStopRequest": { "type": "object", "title": "Transcription stop request", "properties": { "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "example": { "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901" } }, "TransferCallRequest": { "type": "object", "title": "Transfer Call Request", "required": [ "to" ], "example": { "to": "+18005550100 or sip:username@sip.telnyx.com", "from": "+18005550101", "from_display_name": "Company Name", "audio_url": "http://www.example.com/sounds/greeting.wav", "timeout_secs": 60, "timeout_limit_secs": 60, "webhook_url": "https://www.example.com/server-b/", "webhook_url_method": "POST", "answering_machine_detection": "detect", "answering_machine_detection_config": { "total_analysis_time_millis": 5000, "after_greeting_silence_millis": 1000, "between_words_silence_millis": 1000, "greeting_duration_millis": 1000, "initial_silence_millis": 1000, "maximum_number_of_words": 1000, "maximum_word_length_millis": 2000, "silence_threshold": 512, "greeting_total_analysis_time_millis": 50000, "greeting_silence_duration_millis": 2000 }, "custom_headers": [ { "name": "head_1", "value": "val_1" }, { "name": "head_2", "value": "val_2" } ], "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901", "media_encryption": "SRTP", "sip_auth_username": "username", "sip_auth_password": "password", "sip_headers": [ { "name": "User-to-User", "value": "value" } ], "sip_transport_protocol": "TLS", "stream_url": "wss://www.example.com/websocket", "stream_track": "both_tracks" }, "properties": { "to": { "description": "The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided using an array of strings", "oneOf": [ { "type": "string", "example": "+18005550100 or sip:username@sip.telnyx.com" }, { "type": "array", "items": { "type": "string" }, "example": "[\"+18005550100\", \"sip:username@sip.telnyx.com\"]" } ] }, "from": { "description": "The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format. This attribute will default to the `to` number of the original call if omitted.", "type": "string", "example": "+18005550101" }, "from_display_name": { "description": "The `from_display_name` string to be used as the caller id name (SIP From Display Name) presented to the destination (`to` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the `from` field.", "type": "string", "example": "Company Name" }, "audio_url": { "type": "string", "example": "http://example.com/message.wav", "description": "The URL of a file to be played back when the transfer destination answers before bridging the call. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request." }, "media_name": { "type": "string", "example": "my_media_uploaded_to_media_storage_api", "description": "The media_name of a file to be played back when the transfer destination answers before bridging the call. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file." }, "timeout_secs": { "description": "The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being transferred. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds.", "default": 30, "type": "integer", "example": 60, "format": "int32" }, "time_limit_secs": { "description": "Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length.", "default": 14400, "type": "integer", "example": 600, "format": "int32", "minimum": 30, "maximum": 14400 }, "answering_machine_detection": { "description": "Enables Answering Machine Detection. When a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If 'greeting_end' or 'detect_words' is used and a 'machine' is detected, you will receive another 'call.machine.greeting.ended' webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive 'call.machine.greeting.ended' if a beep is detected.", "default": "disabled", "type": "string", "enum": [ "premium", "detect", "detect_beep", "detect_words", "greeting_end", "disabled" ] }, "answering_machine_detection_config": { "description": "Optional configuration parameters to modify 'answering_machine_detection' performance.", "type": "object", "properties": { "total_analysis_time_millis": { "description": "Maximum timeout threshold for overall detection.", "default": 3500, "type": "integer", "example": 5000, "format": "int32" }, "after_greeting_silence_millis": { "description": "Silence duration threshold after a greeting message or voice for it be considered human.", "default": 800, "type": "integer", "example": 1000, "format": "int32" }, "between_words_silence_millis": { "description": "Maximum threshold for silence between words.", "default": 50, "type": "integer", "example": 100, "format": "int32" }, "greeting_duration_millis": { "description": "Maximum threshold of a human greeting. If greeting longer than this value, considered machine.", "default": 3500, "type": "integer", "example": 1500, "format": "int32" }, "initial_silence_millis": { "description": "If initial silence duration is greater than this value, consider it a machine.", "default": 3500, "type": "integer", "example": 1800, "format": "int32" }, "maximum_number_of_words": { "description": "If number of detected words is greater than this value, consder it a machine.", "default": 5, "type": "integer", "example": 3, "format": "int32" }, "maximum_word_length_millis": { "description": "If a single word lasts longer than this threshold, consider it a machine.", "default": 3500, "type": "integer", "example": 2000, "format": "int32" }, "silence_threshold": { "description": "Minimum noise threshold for any analysis.", "default": 256, "type": "integer", "example": 512, "format": "int32" }, "greeting_total_analysis_time_millis": { "description": "If machine already detected, maximum timeout threshold to determine the end of the machine greeting.", "default": 5000, "type": "integer", "example": 7500, "format": "int32" }, "greeting_silence_duration_millis": { "description": "If machine already detected, maximum threshold for silence between words. If exceeded, the greeting is considered ended.", "default": 1500, "type": "integer", "example": 2000, "format": "int32" } } }, "custom_headers": { "description": "Custom headers to be added to the SIP INVITE.", "type": "array", "example": [ { "name": "head_1", "value": "val_1" }, { "name": "head_2", "value": "val_2" } ], "items": { "$ref": "#/components/schemas/CustomSipHeader" } }, "client_state": { "description": "Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "target_leg_client_state": { "description": "Use this field to add state to every subsequent webhook for the new leg. It must be a valid Base-64 encoded string.", "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d" }, "command_id": { "description": "Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`.", "type": "string", "example": "891510ac-f3e4-11e8-af5b-de00688a4901" }, "media_encryption": { "description": "Defines whether media should be encrypted on the new call leg.", "default": "disabled", "type": "string", "enum": [ "disabled", "SRTP" ] }, "sip_auth_username": { "description": "SIP Authentication username used for SIP challenges.", "type": "string", "example": "username" }, "sip_auth_password": { "description": "SIP Authentication password used for SIP challenges.", "type": "string", "example": "password" }, "sip_headers": { "description": "SIP headers to be added to the SIP INVITE. Currently only User-to-User header is supported.", "type": "array", "example": [ { "name": "User-to-User", "value": "value" } ], "items": { "$ref": "#/components/schemas/SipHeader" } }, "sip_transport_protocol": { "description": "Defines SIP transport protocol to be used on the call.", "default": "UDP", "type": "string", "enum": [ "UDP", "TCP", "TLS" ] }, "sound_modifications": { "$ref": "#/components/schemas/SoundModifications" }, "webhook_url": { "description": "Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call.", "type": "string", "example": "https://www.example.com/server-b/" }, "webhook_url_method": { "description": "HTTP request type used for `webhook_url`.", "default": "POST", "type": "string", "enum": [ "POST", "GET" ], "example": "GET" } } }, "TwimlRecordingChannels": { "type": "integer", "enum": [ 1, 2 ], "default": 2, "example": 1 }, "UUID": { "title": "UUID", "type": "string", "format": "uuid", "description": "Uniquely identifies the resource.", "example": "542c3bca-d247-42bc-8fe7-e01d16ecd761" }, "UnauthorizedError": { "allOf": [ { "$ref": "#/components/schemas/GenericError" }, { "properties": { "code": { "example": "10009" }, "title": { "example": "Authentication failed" }, "detail": { "example": "The required authentication headers were either invalid or not included in the request." }, "meta": { "type": "object", "properties": { "url": { "type": "string", "example": "https://developers.telnyx.com/docs/overview/errors/10009" } } } } } ] }, "UnexpectedError": { "allOf": [ { "$ref": "#/components/schemas/GenericError" }, { "properties": { "code": { "example": "10007" }, "title": { "example": "Unexpected error" }, "detail": { "example": "An unexpected error occurred." }, "meta": { "type": "object", "properties": { "url": { "type": "string", "example": "https://developers.telnyx.com/docs/overview/errors/10007" } } } } } ] }, "UnprocessableEntityError": { "allOf": [ { "$ref": "#/components/schemas/GenericError" }, { "properties": { "code": { "example": "10002" }, "title": { "example": "Invalid phone number" }, "detail": { "example": "The phone number is invalid." }, "source": { "type": "object", "properties": { "pointer": { "type": "string", "example": "/phone_numbers" } } }, "meta": { "type": "object", "properties": { "url": { "type": "string", "example": "https://developers.telnyx.com/docs/overview/errors/10002" } } } } } ] }, "UpdateAuthenticationProviderRequest": { "type": "object", "title": "Update Authentication Provider Request", "properties": { "name": { "$ref": "#/components/schemas/name" }, "short_name": { "$ref": "#/components/schemas/short_name" }, "active": { "$ref": "#/components/schemas/active" }, "settings": { "$ref": "#/components/schemas/settings" }, "settings_url": { "$ref": "#/components/schemas/settings_url" } }, "example": { "name": "Okta", "short_name": "myorg", "active": true, "settings": { "idp_entity_id": "https://myorg.myidp.com/saml/metadata", "idp_sso_target_url": "https://myorg.myidp.com/trust/saml2/http-post/sso", "idp_cert_fingerprint": "13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7", "idp_cert_fingerprint_algorithm": "sha1" } } }, "UpdateBillingGroup": { "properties": { "name": { "type": "string", "description": "A name for the billing group" } }, "example": { "name": "string" } }, "UpdateBrand": { "title": "UpdateBrand", "required": [ "entityType", "displayName", "country", "email", "vertical" ], "type": "object", "properties": { "entityType": { "allOf": [ { "$ref": "#/components/schemas/EntityType" } ], "description": "Entity type behind the brand. This is the form of business establishment." }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display or marketing name of the brand.", "example": "ABC Mobile" }, "companyName": { "title": "Companyname", "maxLength": 100, "type": "string", "description": "(Required for Non-profit/private/public) Legal company name.", "example": "ABC Inc." }, "firstName": { "title": "Firstname", "maxLength": 100, "type": "string", "description": "First name of business contact.", "example": "John" }, "lastName": { "title": "Lastname", "maxLength": 100, "type": "string", "description": "Last name of business contact.", "example": "Smith" }, "ein": { "title": "Ein", "maxLength": 20, "type": "string", "description": "(Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S.", "example": "111111111" }, "phone": { "title": "Phone", "maxLength": 20, "type": "string", "description": "Valid phone number in e.164 international format.", "example": "+12024567890" }, "street": { "title": "Street", "maxLength": 100, "type": "string", "description": "Street number and name.", "example": "123" }, "city": { "title": "City", "maxLength": 100, "type": "string", "description": "City name", "example": "New York" }, "state": { "title": "State", "maxLength": 20, "type": "string", "description": "State. Must be 2 letters code for United States.", "example": "NY" }, "postalCode": { "title": "Postalcode", "maxLength": 10, "type": "string", "description": "Postal codes. Use 5 digit zipcode for United States", "example": "10001" }, "country": { "title": "Country", "maxLength": 2, "type": "string", "description": "ISO2 2 characters country code. Example: US - United States", "example": "US" }, "email": { "title": "Email", "maxLength": 100, "type": "string", "description": "Valid email address of brand support contact." }, "stockSymbol": { "title": "Stocksymbol", "maxLength": 10, "type": "string", "description": "(Required for public company) stock symbol.", "example": "ABC" }, "stockExchange": { "allOf": [ { "$ref": "#/components/schemas/StockExchange" } ], "description": "(Required for public company) stock exchange.", "example": "NASDAQ" }, "ipAddress": { "title": "Ipaddress", "maxLength": 50, "type": "string", "description": "IP address of the browser requesting to create brand identity." }, "website": { "title": "Website", "maxLength": 100, "type": "string", "description": "Brand website URL.", "example": "http://www.abcmobile.com" }, "vertical": { "allOf": [ { "$ref": "#/components/schemas/Vertical" } ], "description": "Vertical or industry segment of the brand." }, "altBusiness_id": { "title": "Altbusiness Id", "maxLength": 50, "type": "string", "description": "Alternate business identifier such as DUNS, LEI, or GIIN" }, "altBusinessIdType": { "$ref": "#/components/schemas/AltBusinessIdType" }, "isReseller": { "title": "Isreseller", "type": "boolean" }, "identityStatus": { "$ref": "#/components/schemas/BrandIdentityStatus" } } }, "UpdateBrandRequest": { "title": "UpdateBrand", "required": [ "entityType", "displayName", "country", "email", "vertical" ], "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/EntityType" }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display or marketing name of the brand.", "example": "Example Company Updated" }, "companyName": { "title": "Companyname", "maxLength": 100, "type": "string", "description": "(Required for Non-profit/private/public) Legal company name.", "example": "Example Company Inc." }, "ein": { "title": "Ein", "maxLength": 20, "type": "string", "description": "(Required for Non-profit/private/public) Government assigned corporate tax ID. EIN is 9-digits in U.S. The only entity type which does not require an EIN is a Sole Proprietor.", "example": "142536893" }, "phone": { "title": "Phone", "maxLength": 20, "type": "string", "description": "Valid phone number in e.164 international format.", "example": "+13259390512" }, "street": { "title": "Street", "maxLength": 100, "type": "string", "description": "Street number and name.", "example": "123 Example St." }, "city": { "title": "City", "maxLength": 100, "type": "string", "description": "City name", "example": "San Francisco" }, "state": { "title": "State", "maxLength": 20, "type": "string", "description": "State. Must be 2 letters code for United States.", "example": "CA" }, "postalCode": { "title": "Postalcode", "maxLength": 10, "type": "string", "description": "Postal codes. Use 5 digit zipcode for United States", "example": "94016" }, "country": { "title": "Country", "maxLength": 2, "type": "string", "description": "ISO2 2 characters country code. Example: US - United States", "example": "US" }, "email": { "title": "Email", "maxLength": 100, "type": "string", "description": "Valid email address of brand support contact.", "example": "examplename@examplecompanyupdated.com" }, "stockSymbol": { "title": "Stocksymbol", "maxLength": 10, "type": "string", "description": "(Required for public company) stock symbol.", "example": "EXCOUP" }, "stockExchange": { "$ref": "#/components/schemas/StockExchange" }, "ipAddress": { "title": "Ipaddress", "maxLength": 50, "type": "string", "description": "IP address of the browser requesting to create brand identity." }, "website": { "title": "Website", "maxLength": 100, "type": "string", "description": "Brand website URL.", "example": "www.examplecompanyupdated.com" }, "vertical": { "$ref": "#/components/schemas/Vertical" }, "altBusinessId": { "title": "Altbusinessid", "maxLength": 50, "type": "string", "description": "Alternate business identifier such as DUNS, LEI, or GIIN" }, "altBusinessIdType": { "$ref": "#/components/schemas/AltBusinessIdType" } } }, "UpdateBrandResponse": { "title": "UpdateBrand", "required": [ "entityType", "displayName", "country", "email", "brandRelationship", "vertical" ], "type": "object", "properties": { "entityType": { "$ref": "#/components/schemas/EntityType" }, "displayName": { "title": "Displayname", "maxLength": 100, "type": "string", "description": "Display or marketing name of the brand.", "example": "Example Company Updated" }, "companyName": { "title": "Companyname", "maxLength": 100, "type": "string", "description": "(Required for Non-profit/private/public) Legal company name.", "example": "Example Company Inc." }, "ein": { "title": "Ein", "maxLength": 20, "type": "string", "description": "(Required for Non-profit/private/public) Government assigned corporate tax ID. EIN is 9-digits in U.S. The only entity type which does not require an EIN is a Sole Proprietor.", "example": "142536893" }, "phone": { "title": "Phone", "maxLength": 20, "type": "string", "description": "Valid phone number in e.164 international format.", "example": "+13259390512" }, "street": { "title": "Street", "maxLength": 100, "type": "string", "description": "Street number and name.", "example": "123 Example St." }, "city": { "title": "City", "maxLength": 100, "type": "string", "description": "City name", "example": "San Francisco" }, "state": { "title": "State", "maxLength": 20, "type": "string", "description": "State. Must be 2 letters code for United States.", "example": "CA" }, "postalCode": { "title": "Postalcode", "maxLength": 10, "type": "string", "description": "Postal codes. Use 5 digit zipcode for United States", "example": "94016" }, "country": { "title": "Country", "maxLength": 2, "type": "string", "description": "ISO2 2 characters country code. Example: US - United States", "example": "US" }, "email": { "title": "Email", "maxLength": 100, "type": "string", "description": "Valid email address of brand support contact.", "example": "examplename@examplecompanyupdated.com" }, "stockSymbol": { "title": "Stocksymbol", "maxLength": 10, "type": "string", "description": "(Required for public company) stock symbol.", "example": "EXCOUP" }, "stockExchange": { "$ref": "#/components/schemas/StockExchange" }, "ipAddress": { "title": "Ipaddress", "maxLength": 50, "type": "string", "description": "IP address of the browser requesting to create brand identity." }, "website": { "title": "Website", "maxLength": 100, "type": "string", "description": "Brand website URL.", "example": "www.examplecompanyupdated.com" }, "brandRelationship": { "$ref": "#/components/schemas/BrandRelationship" }, "vertical": { "$ref": "#/components/schemas/Vertical" }, "altBusinessId": { "title": "Altbusinessid", "maxLength": 50, "type": "string", "description": "Alternate business identifier such as DUNS, LEI, or GIIN" }, "altBusinessIdType": { "$ref": "#/components/schemas/AltBusinessIdType" }, "identityStatus": { "title": "identityStatus", "description": "TCR assessment of the brand identification status.", "type": "string", "example": "VERIFIED" } } }, "UpdateCallControlApplicationRequest": { "type": "object", "title": "Update Call Control Application Request", "required": [ "application_name", "webhook_event_url" ], "properties": { "application_name": { "type": "string", "description": "A user-assigned name to help manage the application.", "example": "call-router" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "active": { "type": "boolean", "description": "Specifies whether the connection can be used.", "default": true }, "anchorsite_override": { "type": "string", "description": "Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.\n", "enum": [ "\"Latency\"", "\"Chicago, IL\"", "\"Ashburn, VA\"", "\"San Jose, CA\"" ], "example": "\"Amsterdam, Netherlands\"", "default": "\"Latency\"" }, "dtmf_type": { "type": "string", "description": "Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.", "enum": [ "RFC 2833", "Inband", "SIP INFO" ], "example": "Inband", "default": "RFC 2833" }, "first_command_timeout": { "type": "boolean", "description": "Specifies whether calls to phone numbers associated with this connection should hangup after timing out.", "example": true, "default": false }, "first_command_timeout_secs": { "type": "integer", "description": "Specifies how many seconds to wait before timing out a dial command.", "example": 10, "default": 30 }, "inbound": { "$ref": "#/components/schemas/CallControlApplicationInbound" }, "outbound": { "$ref": "#/components/schemas/CallControlApplicationOutbound" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true } }, "example": { "application_name": "call-router", "webhook_event_url": "https://example.com", "active": false, "anchorsite_override": "\"Latency\"", "dtmf_type": "Inband", "first_command_timeout": true, "first_command_timeout_secs": 10, "inbound": { "channel_limit": 10, "shaken_stir_enabled": true, "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" }, "webhook_api_version": "1", "webhook_event_failover_url": "https://failover.example.com", "webhook_timeout_secs": 25 } }, "UpdateCallRequest": { "type": "object", "title": "Update Call Request", "properties": { "Status": { "description": "The value to set the call status to. Setting the status to completed ends the call.", "example": "completed", "type": "string" }, "Url": { "description": "The URL where TeXML will make a request to retrieve a new set of TeXML instructions to continue the call flow.", "example": "https://www.example.com/intruction-b.xml", "type": "string" }, "Method": { "description": "HTTP request type used for `Url`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "FallbackUrl": { "description": "A failover URL for which Telnyx will retrieve the TeXML call instructions if the Url is not responding.", "example": "https://www.example.com/intruction-c.xml", "type": "string" }, "FallbackMethod": { "description": "HTTP request type used for `FallbackUrl`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "StatusCallback": { "description": "URL destination for Telnyx to send status callback events to for the call.", "example": "https://www.example.com/callback", "type": "string" }, "StatusCallbackMethod": { "description": "HTTP request type used for `StatusCallback`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "Texml": { "description": "TeXML to replace the current one with.", "example": "Hello", "type": "string" } }, "example": { "Status": "completed" } }, "UpdateCampaign": { "title": "UpdateCampaign", "type": "object", "properties": { "resellerId": { "title": "Resellerid", "maxLength": 8, "type": "string", "description": "Alphanumeric identifier of the reseller that you want to associate with this campaign." }, "sample1": { "title": "Sample1", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 1 or more message samples." }, "sample2": { "title": "Sample2", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 2 or more message samples." }, "sample3": { "title": "Sample3", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 3 or more message samples." }, "sample4": { "title": "Sample4", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 4 or more message samples." }, "sample5": { "title": "Sample5", "maxLength": 255, "type": "string", "description": "Message sample. Some campaign tiers require 5 or more message samples." }, "messageFlow": { "title": "Messageflow", "maxLength": 2048, "type": "string", "description": "Message flow description." }, "helpMessage": { "title": "Helpmessage", "maxLength": 255, "type": "string", "description": "Help message of the campaign." }, "autoRenewal": { "title": "Autorenewal", "type": "boolean", "description": "Help message of the campaign.", "default": true } } }, "UpdateCommandResult": { "type": "object", "title": "Update Call Result", "example": { "sid": "c46e06d7-b78f-4b13-96b6-c576af9640ff", "status": "accepted" }, "properties": { "sid": { "type": "string", "example": "c46e06d7-b78f-4b13-96b6-c576af9640ff" }, "status": { "type": "string", "example": "accepted" } } }, "UpdateConferenceParticipantRequest": { "type": "object", "title": "Update Conference Participant Request", "properties": { "Muted": { "description": "Whether the participant should be muted.", "example": true, "type": "boolean" }, "Hold": { "description": "Whether the participant should be on hold.", "example": true, "type": "boolean" }, "HoldURL": { "description": "The URL to be called using the `HoldMethod` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains , , , or verbs.", "example": true, "type": "string" }, "HoldMethod": { "description": "The HTTP method to use when calling the `HoldURL`.", "example": "POST", "enum": [ "GET", "POST" ], "type": "string" }, "AnnounceUrl": { "description": "The URL to call to announce something to the participant. The URL may return an MP3 fileo a WAV file, or a TwiML document that contains , , , or verbs.", "example": "https://www.example.com/announce.xml", "type": "string" }, "AnnounceMethod": { "description": "The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] }, "WaitUrl": { "description": "The URL to call for an audio file to play while the participant is waiting for the conference to start.", "example": "https://www.example.com/wait_music.mp3", "type": "string" }, "BeepOnExit": { "description": "Whether to play a notification beep to the conference when the participant exits.", "example": false, "type": "boolean" }, "EndConferenceOnExit": { "description": "Whether to end the conference when the participant leaves.", "example": false, "type": "boolean" }, "Coaching": { "description": "Whether the participant is coaching another call. When `true`, `CallSidToCoach` has to be given.", "example": false, "type": "boolean" }, "CallSidToCoach": { "description": "The SID of the participant who is being coached. The participant being coached is the only participant who can hear the participant who is coaching.", "example": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ", "type": "string" } }, "example": { "BeepOnExit": false } }, "UpdateConferenceRequest": { "type": "object", "title": "Update Conference Request", "properties": { "Status": { "description": "The new status of the resource. Specifying `completed` will end the conference and hang up all participants.", "example": "completed", "type": "string" }, "AnnounceUrl": { "description": "The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains , , , or verbs.", "example": "https://www.example.com/announce.xml", "type": "string" }, "AnnounceMethod": { "description": "The HTTP method used to call the `AnnounceUrl`. Defaults to `POST`.", "example": "GET", "type": "string", "enum": [ "GET", "POST" ] } }, "example": { "Status": "completed" } }, "UpdateCredentialConnectionRequest": { "type": "object", "title": "Update Credential Connection Request", "properties": { "active": { "type": "boolean", "description": "Defaults to true" }, "user_name": { "type": "string", "description": "The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters).", "example": "myusername123" }, "password": { "type": "string", "description": "The password to be used as part of the credentials. Must be 8 to 128 characters long.", "example": "my123secure456password789" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "$ref": "#/components/schemas/ConnectionName" }, "sip_uri_calling_preference": { "type": "string", "description": "This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI @telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).", "enum": [ "disabled", "unrestricted", "internal" ] }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": false, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout." }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios." }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings." }, "ios_push_credential_id": { "$ref": "#/components/schemas/ConnectionIosPushCredentialId" }, "android_push_credential_id": { "$ref": "#/components/schemas/ConnectionAndroidPushCredentialId" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "inbound": { "$ref": "#/components/schemas/CredentialInbound" }, "outbound": { "$ref": "#/components/schemas/CredentialOutbound" } }, "example": { "active": true, "password": "my123secure456password789", "user_name": "myusername123", "anchorsite_override": "Latency", "connection_name": "my name", "sip_uri_calling_preference": " disabled", "default_on_hold_comfort_noise_enabled": false, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": true, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_seconds": 10 }, "inbound": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": "G722", "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "timeout_1xx_secs": 10, "timeout_2xx_secs": 20, "shaken_stir_enabled": true }, "outbound": { "call_parking_enabled": true, "ani_override": "always", "channel_limit": 10, "instant_ringback_enabled": true, "generate_ringback_tone": true, "localization": "US", "t38_reinvite_source": "telnyx", "outbound_voice_profile_id": "1293384261075731499" } } }, "UpdateExternalConnectionPhoneNumberRequest": { "type": "object", "title": "Update External Connection Phone Number Request", "properties": { "location_id": { "type": "string", "format": "uuid", "description": "Identifies the location to assign the phone number to." } } }, "UpdateExternalConnectionRequest": { "type": "object", "title": "Update External Connection Request", "required": [ "outbound/outbound_voice_profile_id" ], "properties": { "active": { "$ref": "#/components/schemas/ConnectionActive" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } } }, "example": { "active": false, "outbound": { "outbound_voice_profile_id": "1911630617284445511" } } }, "UpdateFaxApplicationRequest": { "type": "object", "title": "Update Fax Application Request", "required": [ "application_name", "webhook_event_url" ], "properties": { "application_name": { "$ref": "#/components/schemas/ApplicationName" }, "active": { "$ref": "#/components/schemas/ConnectionActive" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "webhook_event_url": { "$ref": "#/components/schemas/WebhookEventUrl" }, "webhook_event_failover_url": { "$ref": "#/components/schemas/WebhookEventFailoverUrl" }, "webhook_timeout_secs": { "$ref": "#/components/schemas/WebhookTimeoutSecs" }, "fax_email_recipient": { "$ref": "#/components/schemas/FaxEmailRecipient" }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "inbound_fax_file_type": { "type": "string", "description": "The file type used for inbound faxes.", "enum": [ "pdf", "tiff" ], "default": "pdf", "example": "pdf" }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.", "default": null, "example": "example" }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ], "default": "from_anyone", "example": "only_my_connections" } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } } }, "example": { "application_name": "fax-router", "active": false, "anchorsite_override": "Amsterdam, Netherlands", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_timeout_secs": 25, "inbound": { "channel_limit": 10, "inbound_fax_file_type": "pdf", "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" } } }, "UpdateFqdnConnectionRequest": { "title": "Update FQDN Connection Request", "properties": { "active": { "type": "boolean", "description": "Defaults to true" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "$ref": "#/components/schemas/ConnectionName" }, "transport_protocol": { "$ref": "#/components/schemas/FqdnConnectionTransportProtocol" }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": true, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout." }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios." }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer that the sender and receiver negotiate T38 directly when both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call according to each leg's settings." }, "ios_push_credential_id": { "$ref": "#/components/schemas/ConnectionIosPushCredentialId" }, "android_push_credential_id": { "$ref": "#/components/schemas/ConnectionAndroidPushCredentialId" }, "webhook_event_url": { "$ref": "#/components/schemas/WebhookEventUrl" }, "webhook_event_failover_url": { "$ref": "#/components/schemas/WebhookEventFailoverUrl" }, "webhook_api_version": { "$ref": "#/components/schemas/WebhookApiVersion" }, "webhook_timeout_secs": { "$ref": "#/components/schemas/WebhookTimeoutSecs" }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "inbound": { "$ref": "#/components/schemas/InboundFqdn" }, "outbound": { "$ref": "#/components/schemas/OutboundFqdn" } }, "example": { "active": true, "anchorsite_override": "Latency", "connection_name": "string", "transport_protocol": "UDP", "default_on_hold_comfort_noise_enabled": true, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": true, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_secs": 10 }, "inbound": { "ani_number_format": "+E.164", "dnis_number_format": "+e164", "codecs": [ "G722" ], "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "string", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 10, "shaken_stir_enabled": true } } }, "UpdateFqdnRequest": { "title": "Update FQDN Request", "type": "object", "properties": { "connection_id": { "type": "string", "description": "ID of the FQDN connection to which this IP should be attached." }, "fqdn": { "type": "string", "description": "FQDN represented by this resource.", "example": "example.com" }, "port": { "type": "integer", "description": "Port to use when connecting to this FQDN.", "default": 5060, "example": 5060, "nullable": true }, "dns_record_type": { "type": "string", "description": "The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.", "example": "a" } }, "example": { "connection_id": "1516447646313612565", "fqdn": "example.com", "port": 8080, "dns_record_type": "a" } }, "UpdateIpConnectionRequest": { "title": "Update Ip Connection Request", "properties": { "active": { "type": "boolean", "description": "Defaults to true" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "connection_name": { "type": "string" }, "transport_protocol": { "type": "string", "description": "One of UDP, TLS, or TCP. Applies only to connections with IP authentication or FQDN authentication.", "default": "UDP", "enum": [ "UDP", "TCP", "TLS" ] }, "default_on_hold_comfort_noise_enabled": { "type": "boolean", "default": true, "description": "When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout." }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "encode_contact_header_enabled": { "type": "boolean", "default": false, "description": "Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios." }, "encrypted_media": { "$ref": "#/components/schemas/EncryptedMedia" }, "onnet_t38_passthrough_enabled": { "type": "boolean", "default": false, "description": "Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings." }, "ios_push_credential_id": { "$ref": "#/components/schemas/ConnectionIosPushCredentialId" }, "android_push_credential_id": { "$ref": "#/components/schemas/ConnectionAndroidPushCredentialId" }, "webhook_event_url": { "type": "string", "format": "url", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "example": "https://example.com" }, "webhook_event_failover_url": { "type": "string", "format": "url", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "example": "https://failover.example.com", "nullable": true, "default": "" }, "webhook_api_version": { "type": "string", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "enum": [ "1", "2" ], "example": "1", "default": "1" }, "webhook_timeout_secs": { "type": "integer", "minimum": 0, "maximum": 30, "description": "Specifies how many seconds to wait before timing out a webhook.", "example": 25, "default": null, "nullable": true }, "rtcp_settings": { "$ref": "#/components/schemas/ConnectionRtcpSettings" }, "inbound": { "$ref": "#/components/schemas/InboundIp" }, "outbound": { "$ref": "#/components/schemas/OutboundIp" } }, "example": { "active": true, "anchorsite_override": "Latency", "connection_name": "string", "transport_protocol": "UDP", "default_on_hold_comfort_noise_enabled": true, "dtmf_type": "RFC 2833", "encode_contact_header_enabled": true, "encrypted_media": "SRTP", "onnet_t38_passthrough_enabled": false, "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836", "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e", "webhook_event_url": "https://example.com", "webhook_event_failover_url": "https://failover.example.com", "webhook_api_version": "1", "webhook_timeout_secs": 25, "rtcp_settings": { "port": "rtcp-mux", "capture_enabled": true, "report_frequency_secs": 10 }, "inbound:": { "ani_number_format": "+E.164", "dns_number_format": "+e164", "codecs": "G722", "default_primary_ip_id": "192.168.0.0", "default_tertiary_ip_id": "192.168.0.0", "default_secondary_ip_id": "192.168.0.0", "default_routing_method": "sequential", "channel_limit": 10, "generate_ringback_tone": true, "isup_headers_enabled": true, "prack_enabled": true, "privacy_zone_enabled": true, "sip_compact_headers_enabled": true, "sip_region": "US", "sip_subdomain": "test", "sip_subdomain_receive_settings": "only_my_connections", "timeout_1xx_secs": 10, "timeout_2xx_secs": 20, "shaken_stir_enabled": true }, "outbound": { "call_parking_enabled": true, "ani_override": "string", "ani_override_type": "always", "channel_limit": 10, "instant_ringback_enabled": true, "generate_ringback_tone": true, "localization": "string", "t38_reinvite_source": "telnyx", "tech_prefix": "string", "ip_authentication_method": "token", "ip_authentication_token": "string", "outbound_voice_profile_id": "1293384261075731499" } } }, "UpdateIpRequest": { "title": "Update Ip Request", "type": "object", "required": [ "ip_address" ], "properties": { "connection_id": { "type": "string", "description": "ID of the IP Connection to which this IP should be attached." }, "ip_address": { "type": "string", "description": "IP adddress represented by this resource.", "example": "192.168.0.0" }, "port": { "type": "integer", "description": "Port to use when connecting to this IP.", "default": 5060, "example": 5060 } }, "example": { "connection_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "ip_address": "192.168.0.0", "port": 5060 } }, "UpdateManagedAccountGlobalChannelLimitRequest": { "title": "Update Managed Account Global Outbound Channels Request", "properties": { "channel_limit": { "type": "integer", "description": "Integer value that indicates the number of allocatable global outbound channels that should be allocated to the managed account. Must be 0 or more. If the value is 0 then the account will have no usable channels and will not be able to perform outbound calling.", "example": 30 } }, "example": { "channel_limit": 30 } }, "UpdateManagedAccountRequest": { "title": "Update Managed Account Request", "properties": { "managed_account_allow_custom_pricing": { "type": "boolean", "description": "Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. This value may be changed, but there may be time lag between when the value is changed and pricing changes take effect.", "example": false } }, "example": { "managed_account_allow_custom_pricing": true } }, "UpdateMediaMultipartRequest": { "type": "object", "title": "Upload media multipart request", "properties": { "media": { "description": "The file you want to upload. The maximum allowed size is 20 MB.", "type": "string", "format": "binary" }, "ttl_secs": { "description": "The number of seconds after which the media resource will be deleted, defaults to 2 days. The maximum allowed vale is 630720000, which translates to 20 years.", "type": "integer", "example": 86400 } }, "example": { "media": "string($binary)", "ttl_secs": 86400 } }, "UpdateMediaRequest": { "type": "object", "title": "Upload media request", "properties": { "media_url": { "description": "The URL where the media to be stored in Telnyx network is currently hosted. The maximum allowed size is 20 MB.", "type": "string", "example": "http://www.example.com/audio.mp3" }, "ttl_secs": { "description": "The number of seconds after which the media resource will be deleted, defaults to 2 days. The maximum allowed vale is 630720000, which translates to 20 years.", "type": "integer", "example": 86400 } }, "example": { "media_url": "http://www.example.com/audio.mp3", "ttl_secs": 86400 } }, "UpdateMessagingProfileRequest": { "type": "object", "properties": { "record_type": { "description": "Identifies the type of the resource.", "type": "string", "enum": [ "messaging_profile" ], "readOnly": true }, "id": { "description": "Identifies the type of resource.", "type": "string", "format": "uuid", "readOnly": true }, "name": { "description": "A user friendly name for the messaging profile.", "type": "string" }, "enabled": { "description": "Specifies whether the messaging profile is enabled or not.", "type": "boolean" }, "webhook_url": { "description": "The URL where webhooks related to this messaging profile will be sent.", "type": "string", "format": "url", "nullable": true }, "webhook_failover_url": { "description": "The failover URL where webhooks related to this messaging profile will be sent if sending to the primary URL fails.", "type": "string", "format": "url", "nullable": true }, "webhook_api_version": { "description": "Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 2010-04-01 format.", "type": "string", "enum": [ "1", "2", "2010-04-01" ] }, "whitelisted_destinations": { "description": "Destinations to which the messaging profile is allowed to send. If set to `null`, all destinations will be allowed. Setting a value of `[\"*\"]` has the equivalent effect. The elements in the list must be valid ISO 3166-1 alpha-2 country codes.", "type": "array", "nullable": true, "items": { "description": "ISO 3166-1 alpha-2 country code.", "type": "string", "pattern": "^[A-Z]{2}$" } }, "created_at": { "description": "ISO 8601 formatted date indicating when the resource was created.", "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "description": "ISO 8601 formatted date indicating when the resource was updated.", "type": "string", "format": "date-time", "readOnly": true }, "v1_secret": { "description": "Secret used to authenticate with v1 endpoints.", "type": "string" }, "number_pool_settings": { "$ref": "#/components/schemas/NumberPoolSettings" }, "url_shortener_settings": { "$ref": "#/components/schemas/UrlShortenerSettings" }, "alpha_sender": { "description": "The alphanumeric sender ID to use when sending to destinations that require an alphanumeric sender ID.", "type": "string", "pattern": "^[A-Za-z0-9 ]{1,11}$", "nullable": true } }, "example": { "name": "Updated Profile for Messages", "webhook_url": "https://www.example.com/hooks", "webhook_failover_url": "https://backup.example.com/hooks", "enabled": true, "webhook_api_version": "2", "whitelisted_destinations": [ "US" ], "number_pool_settings": { "toll_free_weight": 10, "long_code_weight": 2, "skip_unhealthy": false, "sticky_sender": true, "geomatch": false }, "url_shortener_settings": { "domain": "example.ex", "prefix": "cmpny", "replace_blacklist_only": true, "send_webhooks": false }, "v1_secret": "rP1VamejkU2v0qIUxntqLW2c" } }, "UpdateNumberOrderDocumentRequest": { "properties": { "id": { "type": "string", "format": "uuid", "example": "387d1e31-a218-4375-8151-103f2d5e2d2c", "readOnly": true }, "record_type": { "type": "string", "example": "number_order_document", "readOnly": true }, "file_id": { "type": "string", "description": "The id of the file to associate as a number order document.", "example": "1e3c5822-0362-4702-8e46-5a129f0d3976" }, "requirements_id": { "type": "string", "description": "Unique id for a requirement.", "example": "36aaf27d-986b-493c-bd1b-de16af2e4292" }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "requirement_type": { "type": "string", "enum": [ "address_proof", "identification", "reg_form" ], "readOnly": true }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order document was uploaded.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true } }, "example": { "id": "387d1e31-a218-4375-8151-103f2d5e2d2c", "record_type": "number_order_document", "file_id": "1e3c5822-0362-4702-8e46-5a129f0d3976", "requirements_id": "36aaf27d-986b-493c-bd1b-de16af2e4292", "customer_reference": "MY REF 001", "requirement_type": "address_proof", "created_at": "2018-01-01T00:00:00.000000Z" } }, "UpdateNumberOrderPhoneNumberRequest": { "properties": { "regulatory_requirements": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateRegulatoryRequirement" } } } }, "UpdateNumberOrderRequest": { "properties": { "id": { "type": "string", "format": "uuid", "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "readOnly": true }, "record_type": { "type": "string", "example": "number_order", "readOnly": true }, "phone_numbers": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" }, "writeOnly": true }, "phone_numbers_count": { "type": "integer", "description": "The count of phone numbers in the number order.", "example": 1, "readOnly": true }, "status": { "type": "string", "enum": [ "pending", "success", "failure" ], "description": "The status of the order.", "readOnly": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string denoting when the number order was created.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8901 datetime string for when the number order was updated.", "example": "2018-01-01T00:00:00.000000Z", "readOnly": true }, "requirements_met": { "type": "boolean", "description": "True if all requirements are met for every phone number, false otherwise.", "example": true, "readOnly": true } }, "example": { "id": "12ade33a-21c0-473b-b055-b3c836e1c292", "phone_numbers": [ { "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "record_type": "number_order_phone_number", "phone_number": "+19705555098", "bundle_id": "bc8e4d67-33a0-4cbb-af74-7b58f05bd494", "regulatory_requirements": [ { "record_type": "phone_number_regulatory_requirement", "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576", "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21", "field_type": "address" } ], "requirements_met": true, "status": "success" } ], "sub_number_orders_ids": [ "dc8e4d67-33a0-4cbb-af74-7b58f05bd494" ], "record_type": "number_order", "phone_numbers_count": 1, "status": "pending", "customer_reference": "MY REF 001", "created_at": "2018-01-01T00:00:00.000000Z", "updated_at": "2018-01-01T00:00:00.000000Z", "requirements_met": true } }, "UpdateOutboundVoiceProfileRequest": { "type": "object", "title": "Outbound Voice Profile", "required": [ "name" ], "example": { "name": "office", "traffic_type": "conversational", "service_plan": "global", "concurrent_call_limit": 10, "enabled": true, "tags": [ "office-profile" ], "usage_payment_method": "rate-deck", "whitelisted_destinations": [ "US", "BR", "AU" ], "max_destination_rate": 10, "daily_spend_limit": "100.00", "daily_spend_limit_enabled": true, "billing_group_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "properties": { "name": { "type": "string", "description": "A user-supplied name to help with organization.", "example": "office", "minLength": 3 }, "traffic_type": { "$ref": "#/components/schemas/TrafficType" }, "service_plan": { "$ref": "#/components/schemas/ServicePlan" }, "concurrent_call_limit": { "type": "integer", "description": "Must be no more than your global concurrent call limit. Null means no limit.", "example": 10, "nullable": true }, "enabled": { "type": "boolean", "description": "Specifies whether the outbound voice profile can be used. Disabled profiles will result in outbound calls being blocked for the associated Connections.", "example": true, "default": true }, "tags": { "type": "array", "items": { "type": "string" }, "example": [ "office-profile" ] }, "usage_payment_method": { "$ref": "#/components/schemas/UsagePaymentMethod" }, "whitelisted_destinations": { "type": "array", "items": { "type": "string" }, "description": "The list of destinations you want to be able to call using this outbound voice profile formatted in alpha2.", "example": [ "US", "BR", "AU" ], "default": [ "US", "CA" ] }, "max_destination_rate": { "type": "number", "description": "Maximum rate (price per minute) for a Destination to be allowed when making outbound calls." }, "daily_spend_limit": { "type": "string", "description": "The maximum amount of usage charges, in USD, you want Telnyx to allow on this outbound voice profile in a day before disallowing new calls.", "example": "100.00" }, "daily_spend_limit_enabled": { "type": "boolean", "description": "Specifies whether to enforce the daily_spend_limit on this outbound voice profile.", "example": true, "default": false }, "call_recording": { "$ref": "#/components/schemas/OutboundCallRecording" }, "billing_group_id": { "type": "string", "format": "uuid", "description": "The ID of the billing group associated with the outbound proflile. Defaults to null (for no group assigned).", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "default": null, "nullable": true } } }, "UpdatePhoneNumberMessagingSettingsRequest": { "type": "object", "properties": { "messaging_profile_id": { "type": "string", "description": "Unique identifier for a messaging profile." }, "messaging_product": { "type": "string", "description": "The requested messaging product the number should be on", "example": "P2P" } }, "example": { "messaging_profile_id": "dd50eba1-a0c0-4563-9925-b25e842a7cb6", "messaging_product": "P2P" } }, "UpdatePhoneNumberRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifies the type of resource.", "readOnly": true }, "tags": { "type": "array", "description": "A list of user-assigned tags to help organize phone numbers.", "items": { "type": "string" } }, "external_pin": { "type": "string", "description": "If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism." }, "hd_voice_enabled": { "type": "boolean", "description": "Indicates whether HD voice is enabled for this number.", "example": true }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "connection_id": { "type": "string", "description": "Identifies the connection associated with the phone number." }, "billing_group_id": { "type": "string", "description": "Identifies the billing group associated with the phone number." }, "number_level_routing": { "type": "string", "description": "Deprecated field, the only value for this is 'disabled'. All routing for numbers should be configured via connection settings.", "enum": [ "disabled" ], "default": "enabled" } }, "example": { "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "tags": [ "tag" ], "address_id": "dc8f39ac-953d-4520-b93b-786ae87db0da", "external_pin": "1234", "customer_reference": "customer-reference", "connection_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "billing_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494", "number_level_routing": "disabled", "hd_voice_enabled": true } }, "UpdatePhoneNumberVoiceSettingsRequest": { "type": "object", "properties": { "tech_prefix_enabled": { "type": "boolean", "default": false, "description": "Controls whether a tech prefix is enabled for this phone number." }, "translated_number": { "type": "string", "description": "This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed." }, "call_forwarding": { "$ref": "#/components/schemas/CallForwarding" }, "cnam_listing": { "$ref": "#/components/schemas/CnamListing" }, "usage_payment_method": { "type": "string", "enum": [ "pay-per-minute", "channel" ], "default": "pay-per-minute", "description": "Controls whether a number is billed per minute or uses your concurrent channels." }, "media_features": { "$ref": "#/components/schemas/MediaFeatures" }, "call_recording": { "$ref": "#/components/schemas/CallRecording" }, "inbound_call_screening": { "type": "string", "enum": [ "disabled", "reject_calls", "flag_calls" ], "default": "disabled", "description": "The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it." } }, "example": { "tech_prefix_enabled": true, "translated_number": "+13035559999", "call_forwarding": { "call_forwarding_enabled": true, "forwards_to": "+13035559123", "forwarding_type": "always" }, "cnam_listing": { "cnam_listing_enabled": true, "cnam_listing_details": "example" }, "usage_payment_method": "pay-per-minute", "media_features": { "rtp_auto_adjust_enabled": true, "accept_any_rtp_packets_enabled": true, "t38_fax_gateway_enabled": true }, "call_recording": { "inbound_call_recording_enabled": true, "inbound_call_recording_format": "wav", "inbound_call_recording_channels": "single" }, "inbound_call_screening": "disabled" } }, "UpdatePortingOrder": { "type": "object", "title": "UpdatePortingOrder", "properties": { "misc": { "$ref": "#/components/schemas/PortingOrderMisc" }, "end_user": { "$ref": "#/components/schemas/PortingOrderEndUser" }, "documents": { "$ref": "#/components/schemas/PortingOrderDocuments" }, "activation_settings": { "type": "object", "properties": { "foc_datetime_requested": { "type": "string", "format": "date-time", "description": "ISO 8601 formatted Date/Time requested for the FOC date", "example": "2021-03-19T10:07:15.527Z" } } }, "phone_number_configuration": { "$ref": "#/components/schemas/PortingOrderPhoneNumberConfiguration" }, "requirements": { "type": "array", "description": "List of requirements for porting numbers.", "items": { "$ref": "#/components/schemas/UpdatePortingOrderRequirement" } }, "user_feedback": { "$ref": "#/components/schemas/PortingOrderUserFeedback" }, "webhook_url": { "type": "string", "format": "uri" }, "customer_reference": { "type": "string" } } }, "UpdatePortingOrderRequirement": { "type": "object", "required": [ "field_value", "requirement_type_id" ], "properties": { "field_value": { "type": "string", "description": "identifies the document that satisfies this requirement", "example": "9787fb5f-cbe5-4de4-b765-3303774ee9fe" }, "requirement_type_id": { "type": "string", "description": "Identifies the requirement type that meets this requirement", "example": "59b0762a-b274-4f76-ac32-4d5cf0272e66" } } }, "UpdateRegulatoryRequirement": { "properties": { "requirement_id": { "type": "string", "format": "uuid", "description": "Unique id for a requirement.", "example": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576" }, "field_value": { "type": "string", "description": "The value of the requirement, this could be an id to a resource or a string value.", "example": "45f45a04-b4be-4592-95b1-9306b9db2b21" } } }, "UpdateShortCodeRequest": { "type": "object", "required": [ "messaging_profile_id" ], "properties": { "messaging_profile_id": { "type": "string", "description": "Unique identifier for a messaging profile." } }, "example": { "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000" } }, "UpdateSubNumberOrderRequest": { "properties": { "regulatory_requirements": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateRegulatoryRequirement" } } } }, "UpdateTexmlApplicationRequest": { "type": "object", "title": "Update Texml Application Request", "required": [ "friendly_name", "voice_url" ], "properties": { "friendly_name": { "$ref": "#/components/schemas/ApplicationName" }, "active": { "$ref": "#/components/schemas/ConnectionActive" }, "anchorsite_override": { "$ref": "#/components/schemas/AnchorsiteOverride" }, "dtmf_type": { "$ref": "#/components/schemas/DtmfType" }, "first_command_timeout": { "$ref": "#/components/schemas/FirstCommandTimeout" }, "first_command_timeout_secs": { "$ref": "#/components/schemas/FirstCommandTimeoutSecs" }, "voice_url": { "type": "string", "description": "URL to which Telnyx will deliver your XML Translator webhooks.", "format": "url", "example": "https://example.com" }, "voice_fallback_url": { "type": "string", "description": "URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.", "default": null, "format": "url", "example": "https://fallback.example.com" }, "voice_method": { "type": "string", "description": "HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.", "enum": [ "get", "post" ], "default": "post", "example": "get" }, "status_callback": { "type": "string", "description": "URL for Telnyx to send requests to containing information about call progress events.", "default": null, "format": "url", "example": "https://example.com" }, "status_callback_method": { "type": "string", "description": "HTTP request method Telnyx should use when requesting the status_callback URL.", "enum": [ "get", "post" ], "default": "post", "example": "get" }, "inbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of inbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "shaken_stir_enabled": { "type": "boolean", "description": "When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.", "default": false, "example": false }, "sip_subdomain": { "type": "string", "description": "Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain \"example.sip.telnyx.com\" can be called from any SIP endpoint by using the SIP URI \"sip:@example.sip.telnyx.com\" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.", "default": null, "example": "example" }, "sip_subdomain_receive_settings": { "type": "string", "description": "This option can be enabled to receive calls from: \"Anyone\" (any SIP endpoint in the public Internet) or \"Only my connections\" (any connection assigned to the same Telnyx user).", "enum": [ "only_my_connections", "from_anyone" ], "default": "from_anyone", "example": "only_my_connections" } } }, "outbound": { "type": "object", "properties": { "channel_limit": { "type": "integer", "description": "When set, this will limit the total number of outbound calls to phone numbers associated with this connection.", "default": null, "example": 10 }, "outbound_voice_profile_id": { "$ref": "#/components/schemas/OutboundVoiceProfileId" } } } }, "example": { "friendly_name": "call-router", "active": false, "anchorsite_override": "Amsterdam, Netherlands", "dtmf_type": "Inband", "first_command_timeout": true, "first_command_timeout_secs": 10, "voice_url": "https://example.com", "voice_fallback_url": "https://fallback.example.com", "voice_method": "get", "status_callback": "https://example.com", "status_callback_method": "get", "inbound": { "channel_limit": 10, "shaken_stir_enabled": true, "sip_subdomain": "example", "sip_subdomain_receive_settings": "only_my_connections" }, "outbound": { "channel_limit": 10, "outbound_voice_profile_id": "1293384261075731499" } } }, "UpdateVerifiedCallsDisplayProfileRequest": { "type": "object", "required": [ "name" ], "properties": { "call_reasons": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile/properties/call_reasons" }, "phone_numbers": { "$ref": "#/components/schemas/VerifiedCallsDisplayProfile/properties/phone_numbers" } }, "example": { "call_reasons": [ { "reason": "Confirming your travel notice" }, { "id": "7187f640-a1e2-4b3e-808d-b5460b7fb641", "reason": "Order completed" } ], "phone_numbers": [ { "phone_number": "+12345678901" }, { "id": "eeda5901-10a0-48b1-b78d-8a92ef8538bd", "phone_number": "+12345678900", "delete": true } ] } }, "UpdateVerifyProfileCallRequest": { "title": "UpdateVerifyProfileCallRequest", "type": "object", "properties": { "msg_template": { "example": "Hello, this is the Acme Inc verification code you requested: {code}.", "type": "string", "description": "Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code." }, "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "default_call_timeout_secs": { "type": "integer", "example": 30, "default": 45, "description": "Must be less than default_verification_timeout_secs" } } }, "UpdateVerifyProfileFlashcallRequest": { "title": "UpdateVerifyProfileFlashcallRequest", "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" } } }, "UpdateVerifyProfilePSD2Request": { "title": "UpdateVerifyProfilePSD2Request", "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" } } }, "UpdateVerifyProfileSMSRequest": { "title": "UpdateVerifyProfileSMSRequest", "type": "object", "properties": { "messaging_enabled": { "example": true, "description": "Enables SMS text messaging for the Verify profile.", "type": "boolean" }, "rcs_enabled": { "example": true, "description": "Enables RCS messaging for the Verify profile.", "type": "boolean" }, "messaging_template": { "example": "Hello, this is the Acme Inc verification code you requested: {code}.", "type": "string", "description": "Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code." }, "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "vsms_enabled": { "example": true, "description": "Enables VSMS for the Verify profile.", "type": "boolean" } } }, "UpdateVerifyProfileWhatsappRequest": { "title": "UpdateVerifyProfileWhatsappRequest", "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "app_name": { "example": "Example Secure App", "description": "The name that identifies the application requesting 2fa in the verification message.", "type": "string" } } }, "UpdatedAt": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "UplinkData": { "type": "object", "properties": { "amount": { "type": "number", "description": "Uplink data", "example": 1 }, "unit": { "description": "Transmission unit", "type": "string", "enum": [ "B", "KB", "MB" ], "default": "MB" } } }, "Upload": { "type": "object", "title": "Upload", "properties": { "ticket_id": { "$ref": "#/components/schemas/UUID" }, "tenant_id": { "type": "string", "format": "uuid", "example": "ea175aba-f47c-4702-9400-efaa42688048" }, "location_id": { "type": "string", "format": "uuid", "example": "c37e5036-1e87-42e6-86a2-b3e8dd39a2ad" }, "status": { "type": "string", "enum": [ "pending_upload", "pending", "in_progress", "partial_success", "success", "error" ], "description": "Represents the status of the upload on Microsoft Teams.", "example": "error", "default": "pending_upload" }, "available_usages": { "type": "array", "items": { "type": "string", "enum": [ "calling_user_assignment", "first_party_app_assignment" ], "description": "Available usages for the numbers in the upload on Microsoft Teams." } }, "error_code": { "type": "string", "description": "A code returned by Microsoft Teams if there is an error with the upload process." }, "error_message": { "type": "string", "description": "A message set if there is an error with the upload process." }, "tn_upload_entries": { "type": "array", "items": { "$ref": "#/components/schemas/TnUploadEntry" } } } }, "UploadFileMessagingHostedNumberOrderRequest": { "type": "object", "example": { "loa": "example loa", "bill": "bill example" }, "properties": { "loa": { "type": "string", "format": "binary", "description": "Must be a signed LOA for the numbers in the order in PDF format." }, "bill": { "type": "string", "format": "binary", "description": "Must be the last month's bill with proof of ownership of all of the numbers in the order in PDF format." } } }, "UploadMediaMultipartRequest": { "type": "object", "title": "Upload media multipart request", "required": [ "media" ], "properties": { "media": { "description": "The file you want to upload. The maximum allowed size is 20 MB.", "type": "string", "format": "binary" }, "ttl_secs": { "description": "The number of seconds after which the media resource will be deleted, defaults to 2 days. The maximum allowed vale is 630720000, which translates to 20 years.", "type": "integer", "example": 86400 }, "media_name": { "description": "The unique identifier of a file.", "type": "string", "example": "my_file" } }, "example": { "media": "string($binary)", "ttl_secs": 86400, "media_name": "my-file" } }, "UploadMediaRequest": { "type": "object", "title": "Upload media request", "required": [ "media_url" ], "properties": { "media_url": { "description": "The URL where the media to be stored in Telnyx network is currently hosted. The maximum allowed size is 20 MB.", "type": "string", "example": "http://www.example.com/audio.mp3" }, "ttl_secs": { "description": "The number of seconds after which the media resource will be deleted, defaults to 2 days. The maximum allowed vale is 630720000, which translates to 20 years.", "type": "integer", "example": 86400 }, "media_name": { "description": "The unique identifier of a file.", "type": "string", "example": "my_file" } }, "example": { "media_url": "http://www.example.com/audio.mp3", "ttl_secs": 86400, "media_name": "my-file" } }, "Url": { "title": "Url", "required": [ "url" ], "type": "object", "properties": { "url": { "title": "Url", "maxLength": 2083, "minLength": 1, "type": "string", "format": "uri" } } }, "UrlShortenerSettings": { "type": "object", "nullable": true, "required": [ "domain" ], "description": "The URL shortener feature allows automatic replacement of URLs that were generated using\na public URL shortener service. Some examples include bit.do, bit.ly, goo.gl, ht.ly,\nis.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com. Such URLs are replaced with\nwith links generated by Telnyx. The use of custom links can improve branding and message\ndeliverability.\n\nTo disable this feature, set the object field to `null`.\n", "properties": { "domain": { "type": "string", "example": "acct.fyi", "description": "One of the domains provided by the Telnyx URL shortener service.\n" }, "prefix": { "type": "string", "example": "", "description": "Optional prefix that can be used to identify your brand, and will appear in the Telnyx generated URLs after the domain name.\n" }, "replace_blacklist_only": { "type": "boolean", "example": true, "description": "Use the link replacement tool only for links that are specifically blacklisted by Telnyx.\n" }, "send_webhooks": { "type": "boolean", "example": false, "description": "Receive webhooks for when your replaced links are clicked. Webhooks are sent to the webhooks on the messaging profile.\n" } }, "example": { "domain": "example.ex", "prefix": "", "replace_blacklist_only": true, "send_webhooks": false } }, "UsagePaymentMethod": { "type": "string", "description": "Setting for how costs for outbound profile are calculated.", "enum": [ "tariff", "rate-deck" ], "example": "tariff", "default": "rate-deck" }, "UseCaseCategories": { "title": "UseCaseCategories", "enum": [ "2FA", "App Notifications", "Appointments", "Auctions", "Auto Repair Services", "Bank Transfers", "Billing", "Booking Confirmations", "Business Updates", "COVID-19 Alerts", "Career Training", "Chatbot", "Conversational / Alerts", "Courier Services & Deliveries", "Emergency Alerts", "Events & Planning", "Financial Services", "Fraud Alerts", "Fundraising", "General Marketing", "General School Updates", "HR / Staffing", "Healthcare Alerts", "Housing Community Updates", "Insurance Services", "Job Dispatch", "Legal Services", "Mixed", "Motivational Reminders", "Notary Notifications", "Order Notifications", "Political", "Public Works", "Real Estate Services", "Religious Services", "Repair and Diagnostics Alerts", "Rewards Program", "Surveys", "System Alerts", "Voting Reminders", "Waitlist Alerts", "Webinar Reminders", "Workshop Alerts" ], "type": "string", "description": "Tollfree usecase categories" }, "Usecase": { "title": "Usecase", "enum": [ "2FA", "ACCOUNT_NOTIFICATION", "AGENTS_FRANCHISES", "CARRIER_EXEMPT", "CHARITY", "CONVERSATIONAL", "CUSTOMER_CARE", "DELIVERY_NOTIFICATION", "EMERGENCY", "FRAUD_ALERT", "HIGHER_EDUCATION", "LOW_VOLUME", "MARKETING", "MANUFACTURING", "MIXED", "POLITICAL", "POLLING_VOTING", "PUBLIC_SERVICE_ANNOUNCEMENT", "SECURITY_ALERT", "SOCIAL", "SWEEPSTAKE", "SOLE_PROPRIETOR", "TRIAL" ], "description": "Campaign usecase. Must be of defined valid types. For more details, send a GET request to https://api.telnyx.com/10dlc/enum/usecase", "example": "MARKETING" }, "UsecaseMetadata": { "title": "UsecaseMetadata", "type": "object", "properties": { "annualFee": { "title": "Annualfee", "type": "number", "description": "Campaign annual subscription fee" }, "maxSubUsecases": { "title": "Maxsubusecases", "type": "integer", "description": "Maximum number of sub-usecases declaration required." }, "minSubUsecases": { "title": "Minsubusecases", "type": "integer", "description": "Minimum number of sub-usecases declaration required." }, "mnoMetadata": { "title": "Mnometadata", "type": "object", "description": "Map of usecase metadata for each MNO. Key is the network ID of the MNO (e.g. 10017), Value is the mno metadata for the usecase." }, "monthlyFee": { "title": "Monthlyfee", "type": "number", "description": "Campaign monthly subscription fee" }, "quarterlyFee": { "title": "Quarterlyfee", "type": "number", "description": "Campaign quarterly subscription fee" }, "usecase": { "title": "Usecase", "type": "string", "description": "Campaign usecase" } } }, "UserBalance": { "type": "object", "properties": { "record_type": { "type": "string", "example": "balance", "enum": [ "balance" ], "description": "Identifies the type of the resource." }, "balance": { "type": "string", "format": "decimal", "description": "The account's current balance.", "example": "300.00" }, "credit_limit": { "type": "string", "format": "decimal", "description": "The account's credit limit.", "example": "100.00" }, "available_credit": { "type": "string", "format": "decimal", "description": "Available amount to spend (balance + credit limit)", "example": "400.00" }, "currency": { "type": "string", "format": "iso4217", "description": "The ISO 4217 currency identifier.", "example": "USD" } }, "example": { "record_type": "balance", "balance": "300.00", "credit_limit": "100.00", "available_credit": "400.00", "currency": "USD" } }, "UserEmbeddedBuckets": { "properties": { "buckets": { "items": { "type": "string" }, "type": "array", "title": "Buckets" } }, "type": "object", "required": [ "buckets" ], "title": "UserEmbeddedBuckets" }, "UserEmbeddedBucketsData": { "properties": { "data": { "$ref": "#/components/schemas/UserEmbeddedBuckets" } }, "type": "object", "required": [ "data" ], "title": "UserEmbeddedBucketsData" }, "UserId": { "description": "Identifier of the user to whom the fax belongs", "type": "string", "format": "uuid", "example": "yfff7c54-4df3-4bca-a65a-3da1ecc777f0" }, "ValidateAddress": { "type": "object", "properties": { "street_address": { "$ref": "#/components/schemas/street_address" }, "extended_address": { "$ref": "#/components/schemas/extended_address" }, "locality": { "$ref": "#/components/schemas/locality" }, "administrative_area": { "$ref": "#/components/schemas/administrative_area" }, "postal_code": { "$ref": "#/components/schemas/postal_code" }, "country_code": { "$ref": "#/components/schemas/country_code" } } }, "ValidateAddressRequest": { "type": "object", "required": [ "country_code", "street_address", "postal_code" ], "properties": { "street_address": { "$ref": "#/components/schemas/street_address" }, "extended_address": { "$ref": "#/components/schemas/extended_address" }, "locality": { "$ref": "#/components/schemas/locality" }, "administrative_area": { "$ref": "#/components/schemas/administrative_area" }, "postal_code": { "$ref": "#/components/schemas/postal_code" }, "country_code": { "$ref": "#/components/schemas/country_code" } } }, "ValidateAddressResult": { "type": "object", "title": "Validate address action result", "properties": { "result": { "type": "string", "description": "Indicates whether an address is valid or invalid.", "enum": [ "valid", "invalid" ], "example": "valid" }, "suggested": { "type": "object", "description": "Provides normalized address when available.", "$ref": "#/components/schemas/ValidateAddress" }, "record_type": { "type": "string", "description": "Identifies the type of the resource.", "example": "address_validation" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } }, "required": [ "result", "suggested" ] }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "Verification": { "title": "Verification", "type": "object", "properties": { "id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "format": "uuid", "type": "string" }, "type": { "$ref": "#/components/schemas/VerificationType" }, "record_type": { "$ref": "#/components/schemas/VerificationRecordType" }, "phone_number": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "verify_profile_id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "type": "string", "format": "uuid", "description": "The identifier of the associated Verify profile." }, "timeout_secs": { "example": 300, "type": "integer", "description": "This is the number of seconds before the code of the request is expired. Once this request has expired, the code will no longer verify the user. Note: this will override the `default_verification_timeout_secs` on the Verify profile." }, "call_timeout_secs": { "example": 299, "type": "integer", "description": "This is the number of seconds before the call ends, if the verification makes a call. Note: this will override the `default_call_timeout_secs` on the Verify profile." }, "status": { "$ref": "#/components/schemas/VerificationStatus" }, "created_at": { "example": "2020-09-14T17:03:32.965812", "type": "string" }, "updated_at": { "example": "2020-09-14T17:03:32.965812", "type": "string" } } }, "VerificationProfileRecordType": { "title": "VerificationProfileRecordType", "enum": [ "verification_profile" ], "type": "string", "example": "verification_profile", "description": "The possible verification profile record types." }, "VerificationRecordType": { "title": "VerificationRecordType", "enum": [ "verification" ], "type": "string", "example": "verification", "description": "The possible verification record types." }, "VerificationRequestEgress": { "title": "VerificationRequestEgress", "required": [ "businessName", "corporateWebsite", "businessAddr1", "businessCity", "businessState", "businessZip", "businessContactFirstName", "businessContactLastName", "businessContactEmail", "businessContactPhone", "messageVolume", "phoneNumbers", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "optInWorkflowImageURLs", "additionalInformation", "isvReseller", "id", "verificationRequestId" ], "type": "object", "properties": { "businessName": { "title": "Businessname", "type": "string", "example": "Telnyx LLC" }, "corporateWebsite": { "title": "Corporatewebsite", "type": "string", "example": "http://example.com" }, "businessAddr1": { "title": "Businessaddr1", "type": "string", "example": "311 W Superior St" }, "businessAddr2": { "title": "Businessaddr2", "type": "string", "example": "121 W Superior St" }, "businessCity": { "title": "Businesscity", "type": "string", "example": "Chicago" }, "businessState": { "title": "Businessstate", "type": "string", "example": "Illinois" }, "businessZip": { "title": "Businesszip", "type": "string", "example": "60654" }, "businessContactFirstName": { "title": "Businesscontactfirstname", "type": "string", "example": "John" }, "businessContactLastName": { "title": "Businesscontactlastname", "type": "string", "example": "Doe" }, "businessContactEmail": { "title": "Businesscontactemail", "type": "string", "example": "email@example.com" }, "businessContactPhone": { "title": "Businesscontactphone", "type": "string", "example": "+18005550100" }, "messageVolume": { "allOf": [ { "$ref": "#/components/schemas/Volume" } ], "description": "One of the following exact values: 10; 100; 1,000; 10,000; 100,000; 250,000; 500,000; 750,000; 1,000,000; 5,000,000; 10,000,000+", "example": "100,000" }, "phoneNumbers": { "title": "Phonenumbers", "type": "array", "items": { "$ref": "#/components/schemas/TFPhoneNumber" }, "example": [ { "phoneNumber": "+18773554398" }, { "phoneNumber": "+18773554399" } ] }, "useCase": { "allOf": [ { "$ref": "#/components/schemas/UseCaseCategories" } ], "example": "2FA" }, "useCaseSummary": { "title": "Usecasesummary", "type": "string", "example": "This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal" }, "productionMessageContent": { "title": "Productionmessagecontent", "type": "string", "example": "Your Telnyx OTP is XXXX" }, "optInWorkflow": { "title": "Optinworkflow", "type": "string", "example": "User signs into the Telnyx portal, enters number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset" }, "optInWorkflowImageURLs": { "title": "Optinworkflowimageurls", "type": "array", "items": { "$ref": "#/components/schemas/Url" }, "example": [ { "url": "https://telnyx.com/sign-up" }, { "url": "https://telnyx.com/company/data-privacy" } ] }, "additionalInformation": { "title": "Additionalinformation", "type": "string", "example": "This is for security purposes, blah blah blah" }, "isvReseller": { "title": "Isvreseller", "type": "string", "example": "Yes" }, "webhookUrl": { "title": "Webhookurl", "type": "string", "example": "http://example-webhook.com" }, "id": { "title": "Id", "type": "string", "format": "uuid" }, "verificationRequestId": { "title": "Verificationrequestid", "type": "string" }, "verificationStatus": { "allOf": [ { "$ref": "#/components/schemas/TFVerificationStatus" } ], "default": "In Progress" } }, "description": "A verification request as it comes out of the database" }, "VerificationRequestStatus": { "title": "VerificationRequestStatus", "required": [ "businessName", "corporateWebsite", "businessAddr1", "businessCity", "businessState", "businessZip", "businessContactFirstName", "businessContactLastName", "businessContactEmail", "businessContactPhone", "messageVolume", "phoneNumbers", "useCase", "useCaseSummary", "productionMessageContent", "optInWorkflow", "optInWorkflowImageURLs", "additionalInformation", "isvReseller", "id", "verificationStatus" ], "type": "object", "properties": { "businessName": { "title": "Businessname", "type": "string", "example": "Telnyx LLC" }, "corporateWebsite": { "title": "Corporatewebsite", "type": "string", "example": "http://example.com" }, "businessAddr1": { "title": "Businessaddr1", "type": "string", "example": "311 W Superior St" }, "businessAddr2": { "title": "Businessaddr2", "type": "string", "example": "121 W Superior St" }, "businessCity": { "title": "Businesscity", "type": "string", "example": "Chicago" }, "businessState": { "title": "Businessstate", "type": "string", "example": "Illinois" }, "businessZip": { "title": "Businesszip", "type": "string", "example": "60654" }, "businessContactFirstName": { "title": "Businesscontactfirstname", "type": "string", "example": "John" }, "businessContactLastName": { "title": "Businesscontactlastname", "type": "string", "example": "Doe" }, "businessContactEmail": { "title": "Businesscontactemail", "type": "string", "example": "email@example.com" }, "businessContactPhone": { "title": "Businesscontactphone", "type": "string", "example": "+18889809750" }, "messageVolume": { "allOf": [ { "$ref": "#/components/schemas/Volume" } ], "description": "One of the following exact values: 10; 100; 1,000; 10,000; 100,000; 250,000; 500,000; 750,000; 1,000,000; 5,000,000; 10,000,000+", "example": "100,000" }, "phoneNumbers": { "title": "Phonenumbers", "type": "array", "items": { "$ref": "#/components/schemas/TFPhoneNumber" }, "example": [ { "phoneNumber": "+18773554398" }, { "phoneNumber": "+18773554399" } ] }, "useCase": { "allOf": [ { "$ref": "#/components/schemas/UseCaseCategories" } ], "example": "2FA" }, "useCaseSummary": { "title": "Usecasesummary", "type": "string", "example": "This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal" }, "productionMessageContent": { "title": "Productionmessagecontent", "type": "string", "example": "Your Telnyx OTP is XXXX" }, "optInWorkflow": { "title": "Optinworkflow", "type": "string", "example": "User signs into the Telnyx portal, enters number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset" }, "optInWorkflowImageURLs": { "title": "Optinworkflowimageurls", "type": "array", "items": { "$ref": "#/components/schemas/Url" }, "example": [ { "url": "https://telnyx.com/sign-up" }, { "url": "https://telnyx.com/company/data-privacy" } ] }, "additionalInformation": { "title": "Additionalinformation", "type": "string", "example": "This is for security purposes, blah blah blah" }, "isvReseller": { "title": "Isvreseller", "type": "string", "example": "Yes" }, "webhookUrl": { "title": "Webhookurl", "type": "string", "example": "http://example-webhook.com" }, "id": { "title": "Id", "type": "string", "format": "uuid", "example": "eaba9f52-164e-58e0-b002-4f668e18b7ed" }, "verificationStatus": { "allOf": [ { "$ref": "#/components/schemas/TFVerificationStatus" } ], "example": "Pending Customer Feedback" }, "reason": { "title": "Reason", "type": "string", "example": "Unfortunately, we have to cancel this request as we do not support non tollfree US numbers." } }, "description": "A verification request and its status, suitable for returning to users" }, "VerificationStatus": { "title": "VerificationStatus", "enum": [ "pending", "accepted", "invalid", "expired", "error" ], "type": "string", "example": "accepted", "description": "The possible statuses of the verification request." }, "VerificationType": { "title": "VerificationType", "enum": [ "sms", "psd2", "whatsapp", "call", "flashcall" ], "type": "string", "example": "sms", "description": "The possible types of verification." }, "VerifiedCallsDisplayProfile": { "type": "object", "properties": { "record_type": { "type": "string", "example": "verified_calls_display_profile", "readOnly": true }, "id": { "type": "string", "format": "uuid", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "name": { "type": "string", "description": "The Verified Calls Display Profile's name", "example": "My Verified Calls Display Profile" }, "display_name": { "type": "string", "description": "The display name to be shown as the caller name in phones", "example": "Acme Inc." }, "logo_url": { "type": "string", "description": "The URL pointing to a public image file that will be displayed during calls in phones", "example": "https://acme.com/logo.png" }, "status": { "type": "string", "description": "The approval status of the Verified Calls Display Profile in Google", "enum": [ "VERIFICATION_STATE_UNSPECIFIED", "VERIFICATION_STATE_UNVERIFIED", "VERIFICATION_STATE_PENDING", "VERIFICATION_STATE_VERIFIED", "VERIFICATION_STATE_SUSPENDED_IN_GMB" ], "readOnly": true }, "business_identity": { "type": "object", "description": "The associated Business Identity", "properties": { "record_type": { "type": "string", "example": "business_identity" }, "name": { "type": "string", "description": "The name of the business identity on the telnyx platform", "example": "Telnyx" } } }, "phone_numbers": { "type": "array", "items": { "type": "object", "description": "A Phone Number that can make phone calls displaying the configured brand information", "properties": { "record_type": { "type": "string", "example": "phone_number", "readOnly": true }, "id": { "type": "string", "format": "uuid", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "phone_number": { "type": "string", "description": "The phone number in e164 format", "format": "e164", "example": "+15001340938" }, "google_verification_status": { "type": "string", "description": "The approval status of this individual phone number in Google", "enum": [ "STATE_UNSPECIFIED", "PENDING_APPROVAL", "APPROVED", "DENIED", "PENDING_REMOVAL" ], "readOnly": true }, "google_approval_info": { "type": "string", "description": "Additional information about the decision, if available.", "readOnly": true }, "display_profile_id": { "type": "string", "format": "uuid", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "delete": { "type": "boolean", "description": "Marks the Phone Number to be removed from the Display Profile" } } } }, "call_reasons": { "type": "array", "items": { "type": "object", "description": "The Call Reason to be displayed to the call recipient", "properties": { "record_type": { "type": "string", "example": "phone_number", "readOnly": true }, "id": { "type": "string", "format": "uuid", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "reason": { "type": "string", "description": "The Call Reason text to be displayed to the call recipient", "example": "Your order was completed" }, "google_verification_status": { "type": "string", "description": "The approval status of this individual call reason in Google", "enum": [ "STATE_UNSPECIFIED", "PENDING_APPROVAL", "APPROVED", "DENIED", "PENDING_REMOVAL" ], "readOnly": true }, "google_approval_info": { "type": "string", "description": "Additional information about the decision, if available.", "readOnly": true }, "display_profile_id": { "type": "string", "format": "uuid", "example": "c6feda4e-6501-4db9-a21f-665e5b4ce2ba", "readOnly": true }, "delete": { "type": "boolean", "description": "Marks the Phone Number to be removed from the Display Profile" } } } }, "created_at": { "type": "string", "format": "datetime", "description": "An ISO 8601 datetime string for when the display profile was added to the Telnyx platform", "example": "2018-01-01T00:00:00Z", "readOnly": true }, "updated_at": { "type": "string", "format": "datetime", "description": "An ISO 8601 datetime string for when the display profile was updated", "example": "2018-01-01T00:00:00Z", "readOnly": true } }, "example": { "record_type": "verified_calls_display_profile", "id": "6786c69b-0063-47de-865f-cf64b7e7f59e", "organization_id": "633514e3-32d7-4d26-a959-1bc67c4f435d", "name": "My Verified Calls Display Profile", "display_name": "Acme Inc.", "logo_url": "https://acme.com/logo.png", "status": "VERIFICATION_STATE_VERIFIED", "business_identity": { "record_type": "business_identity", "name": "My Business Identity" }, "phone_numbers": [ { "id": "c43eabe9-59f3-4a46-909b-774d7f360d3d ", "record_type": "phone_number", "phone_number": "+12345678", "google_verification_status": "APPROVED", "display_profile_id": "8014539e-fc3b-4696-a26a-d13adb05463f" } ], "call_reasons": [ { "id": "615d79f5-0e2a-425f-925f-abfb1a160428", "record_type": "call_reason", "reason": "Your order is completed", "google_verification_status": "APPROVED", "display_profile_id": "8014539e-fc3b-4696-a26a-d13adb05463f" } ] } }, "VerifiedNumberRecordType": { "title": "VerifiedNumberRecordType", "enum": [ "verified_number" ], "type": "string", "example": "verified_number", "description": "The possible verified numbers record types." }, "VerifiedNumberResponse": { "title": "VerifiedNumberResponse", "type": "object", "properties": { "phone_number": { "example": "+15551234567", "type": "string" }, "record_type": { "$ref": "#/components/schemas/VerifiedNumberRecordType" }, "verified_at": { "example": "2020-09-14T17:03:32.965812", "type": "string" } } }, "VerifiedNumberResponseDataWrapper": { "title": "VerifiedNumberResponseDataWrapper", "type": "object", "properties": { "data": { "type": "object", "$ref": "#/components/schemas/VerifiedNumberResponse" } } }, "VerifyDetailRecord": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "0add777f-1549-46f7-84e9-ad7350f6aa97", "description": "Unique ID of the verification" }, "verify_profile_id": { "type": "string", "format": "uuid", "example": "49000176-1ab2-8bc1-352e-4009f6c37f82" }, "delivery_status": { "type": "string", "example": "pending" }, "verification_status": { "type": "string", "example": "pending" }, "destination_phone_number": { "type": "string", "description": "E.164 formatted phone number", "example": "+13124515883" }, "verify_channel_type": { "description": "Depending on the type of verification, the `verify_channel_id`\npoints to one of the following channel ids;\n---\nverify_channel_type | verify_channel_id\n------------------- | -----------------\nsms, psd2 | messaging_id\ncall, flashcall | call_control_id\nwhatsapp | messaging_whatsapp_id\n---\n", "type": "string", "enum": [ "sms", "psd2", "call", "flashcall", "whatsapp" ] }, "verify_channel_id": { "type": "string", "format": "uuid", "example": "5b7a8365-91f3-420a-befc-498d1efd6c20" }, "created_at": { "type": "string", "format": "datetime", "example": "2021-07-08T00:00:41.000000+00:00" }, "updated_at": { "type": "string", "format": "datetime", "example": "2021-07-08T00:00:41.000000+00:00" }, "rate": { "type": "string", "example": "0.002", "description": "Currency amount per billing unit used to calculate the Telnyx billing costs" }, "rate_measured_in": { "type": "string", "example": "number of occurrences", "description": "Billing unit used to calculate the Telnyx billing costs" }, "verify_usage_fee": { "type": "string", "example": "0.002", "description": "Currency amount for Verify Usage Fee" }, "currency": { "type": "string", "example": "USD", "description": "Telnyx account currency used to describe monetary values, including billing costs" }, "record_type": { "type": "string", "example": "verification_detail_record", "default": "verification_detail_record" } }, "required": [ "record_type" ] }, "VerifyProfileCallResponse": { "title": "VerifyProfileCallResponse", "type": "object", "properties": { "messaging_template": { "example": "Hello, this is the Acme Inc verification code you requested: {code}.", "type": "string", "description": "Optionally sets a speech text template when sending the verification code. Uses `{code}` to template in the actual verification code." }, "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "default_call_timeout_secs": { "type": "integer", "example": 30, "default": 45, "description": "Must be less than default_verification_timeout_secs" } } }, "VerifyProfileFlashcallResponse": { "title": "VerifyProfileFlashcallResponse", "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" } } }, "VerifyProfilePSD2Response": { "title": "VerifyProfilePSD2Response", "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" } } }, "VerifyProfileResponse": { "title": "VerifyProfileResponse", "type": "object", "properties": { "id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "format": "uuid", "type": "string" }, "name": { "example": "Test Profile", "type": "string" }, "webhook_url": { "type": "string", "example": "http://example.com/webhook" }, "webhook_failover_url": { "type": "string", "example": "http://example.com/webhook/failover" }, "record_type": { "$ref": "#/components/schemas/VerificationProfileRecordType" }, "created_at": { "example": "2020-09-14T17:03:32.965812", "type": "string" }, "updated_at": { "example": "2020-09-14T17:03:32.965812", "type": "string" }, "sms": { "type": "object", "$ref": "#/components/schemas/VerifyProfileSMSResponse" }, "psd2": { "type": "object", "$ref": "#/components/schemas/VerifyProfilePSD2Response" }, "whatsapp": { "type": "object", "$ref": "#/components/schemas/VerifyProfileWhatsappResponse" }, "call": { "type": "object", "$ref": "#/components/schemas/VerifyProfileCallResponse" }, "flashcall": { "type": "object", "$ref": "#/components/schemas/VerifyProfileFlashcallResponse" }, "language": { "type": "string", "example": "en-US" } } }, "VerifyProfileResponseDataWrapper": { "title": "VerifyProfileResponseDataWrapper", "type": "object", "properties": { "data": { "type": "object", "$ref": "#/components/schemas/VerifyProfileResponse" } } }, "VerifyProfileSMSResponse": { "title": "VerifyProfileSMSResponse", "type": "object", "properties": { "messaging_enabled": { "example": true, "description": "Enables SMS text messaging for the Verify profile.", "type": "boolean" }, "rcs_enabled": { "example": true, "description": "Enables RCS messaging for the Verify profile.", "type": "boolean" }, "messaging_template": { "example": "Hello, this is the Acme Inc verification code you requested: {code}.", "type": "string", "description": "Optionally sets a messaging text template when sending the verification code. Uses `{code}` to template in the actual verification code." }, "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "vsms_enabled": { "example": true, "description": "Enables VSMS for the Verify profile.", "type": "boolean" } } }, "VerifyProfileWhatsappResponse": { "title": "VerifyProfileWhatsappResponse", "type": "object", "properties": { "default_verification_timeout_secs": { "example": 300, "description": "For every request that is initiated via this Verify profile, this sets the number of seconds before a verification request code expires. Once the verification request expires, the user cannot use the code to verify their identity.", "type": "integer" }, "app_name": { "example": "Example Secure App", "description": "The name that identifies the application requesting 2fa in the verification message.", "type": "string" } } }, "VerifyVerificationCodeRequest": { "title": "VerifyVerificationCodeRequest", "required": [ "code", "verify_profile_id" ], "type": "object", "properties": { "code": { "example": "17686", "type": "string", "description": "This is the code the user submits for verification." }, "verify_profile_id": { "example": "12ade33a-21c0-473b-b055-b3c836e1c292", "type": "string", "format": "uuid", "description": "The identifier of the associated Verify profile." } } }, "VerifyVerificationCodeResponse": { "title": "VerifyVerificationCodeResponse", "required": [ "data" ], "type": "object", "properties": { "data": { "required": [ "phone_number", "response_code" ], "type": "object", "properties": { "phone_number": { "example": "+13035551234", "type": "string", "description": "+E164 formatted phone number." }, "response_code": { "enum": [ "accepted", "rejected" ], "type": "string", "example": "accepted", "description": "Identifies if the verification code has been accepted or rejected." } } } } }, "Vertical": { "title": "Vertical", "enum": [ "REAL_ESTATE", "HEALTHCARE", "ENERGY", "ENTERTAINMENT", "RETAIL", "AGRICULTURE", "INSURANCE", "EDUCATION", "HOSPITALITY", "FINANCIAL", "GAMBLING", "CONSTRUCTION", "NGO", "MANUFACTURING", "GOVERNMENT", "TECHNOLOGY", "COMMUNICATION" ], "description": "Vertical or industry segment of the brand or campaign.", "example": "TECHNOLOGY" }, "VettingClass": { "title": "VettingClass", "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "enabled": { "title": "Enabled", "type": "boolean" }, "displayName": { "title": "Displayname", "type": "string" }, "description": { "title": "Description", "type": "string" }, "validityMonths": { "title": "Validitymonths", "type": "integer" } } }, "VettingStatus": { "title": "VettingStatus", "enum": [ "PENDING", "ACTIVE", "EXPIRED", "ERROR", "CONTACT_VENDOR", "SIMULATION" ], "type": "string", "description": "An enumeration." }, "VideoRegion": { "type": "object", "properties": { "x_pos": { "description": "X axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.", "type": "integer", "example": 100, "default": 0, "nullable": true }, "y_pos": { "description": "Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.", "type": "integer", "example": 100, "default": 0, "nullable": true }, "z_pos": { "description": "Regions with higher z_pos values are stacked on top of regions with lower z_pos values", "type": "integer", "minimum": -99, "maximum": 99, "example": 1, "default": 0, "nullable": true }, "height": { "description": "Height of the video region", "type": "integer", "minimum": 16, "example": 360, "nullable": true }, "width": { "description": "Width of the video region", "type": "integer", "minimum": 16, "example": 480, "nullable": true }, "max_columns": { "description": "Maximum number of columns of the region's placement grid. By default, the region has as many columns as needed to layout all the specified video sources.", "type": "integer", "minimum": 1, "maximum": 1000, "example": 3, "nullable": true }, "max_rows": { "description": "Maximum number of rows of the region's placement grid. By default, the region has as many rows as needed to layout all the specified video sources.", "type": "integer", "minimum": 1, "maximum": 1000, "example": 3, "nullable": true }, "video_sources": { "description": "Array of video recording ids to be composed in the region. Can be \"*\" to specify all video recordings in the session", "type": "array", "items": { "type": "string", "format": "uuid", "example": "7b61621f-62e0-4aad-ab11-9fd19e272e73" } } } }, "VirtualCrossConnect": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "$ref": "#/components/schemas/Interface" }, { "type": "object", "title": "VirtualCrossConnect", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "virtual_cross_connect" }, "cloud_provider": { "type": "string", "enum": [ "aws", "azure", "gce" ], "description": "The Virtual Private Cloud with which you would like to establish a cross connect.", "example": "aws" }, "cloud_region": { "type": "string", "description": "The region where your Virtual Private Cloud hosts are located.

The available regions can be found using the /virtual_cross_connect_regions endpoint.", "example": "us-east-1" }, "bgp_asn": { "type": "number", "description": "The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value will be assigned by Telnyx.", "example": 1234 }, "bandwidth_mbps": { "type": "number", "description": "The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.

The available bandwidths can be found using the /virtual_cross_connect_regions endpoint.", "example": 50 }, "primary_enabled": { "type": "boolean", "description": "Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit.", "example": true, "readOnly": true }, "primary_cloud_account_id": { "type": "string", "description": "The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.", "example": "123456789012" }, "primary_telnyx_ip": { "type": "string", "format": "ipv4", "description": "The IP address assigned to the Telnyx side of the Virtual Cross Connect.

If none is provided, one will be generated for you.

This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.", "example": "169.254.0.1" }, "primary_cloud_ip": { "type": "string", "format": "ipv4", "description": "The IP address assigned for your side of the Virtual Cross Connect.

If none is provided, one will be generated for you.

This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.", "example": "169.254.0.2" }, "primary_bgp_key": { "type": "string", "description": "The authentication key for BGP peer configuration.", "example": "yFV4wEPtPVPfDUGLWiyQzwga" }, "secondary_enabled": { "type": "boolean", "description": "Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit.", "example": true, "readOnly": true }, "secondary_cloud_account_id": { "type": "string", "description": "The identifier for your Virtual Private Cloud. The number will be different based upon your Cloud provider.

This attribute is only necessary for GCE.", "example": "" }, "secondary_telnyx_ip": { "type": "string", "format": "ipv4", "description": "The IP address assigned to the Telnyx side of the Virtual Cross Connect.

If none is provided, one will be generated for you.

This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.", "example": "169.254.0.3" }, "secondary_cloud_ip": { "type": "string", "format": "ipv4", "description": "The IP address assigned for your side of the Virtual Cross Connect.

If none is provided, one will be generated for you.

This value should be null for GCE as Google will only inform you of your assigned IP once the connection has been accepted.", "example": "169.254.0.4" }, "secondary_bgp_key": { "type": "string", "description": "The authentication key for BGP peer configuration.", "example": "ge1lONeK9RcA83uuWaw9DvZy" } } } ] }, "VirtualCrossConnectCombined": { "allOf": [ { "$ref": "#/components/schemas/VirtualCrossConnectCreate" }, { "$ref": "#/components/schemas/VirtualCrossConnectPatch" }, { "$ref": "#/components/schemas/RegionOut" } ] }, "VirtualCrossConnectCreate": { "allOf": [ { "$ref": "#/components/schemas/VirtualCrossConnect" }, { "$ref": "#/components/schemas/RegionIn" }, { "type": "object", "title": "VirtualCrossConnectCreate", "required": [ "network_id", "region_code", "cloud_provider", "cloud_region", "bgp_asn", "primary_cloud_account_id" ] } ] }, "VirtualCrossConnectPatch": { "allOf": [ { "type": "object", "title": "VirtualCrossConnectPatch", "properties": { "primary_enabled": { "type": "boolean", "description": "Indicates whether the primary circuit is enabled. Setting this to `false` will disable the circuit.", "example": true }, "primary_routing_announcement": { "description": "Whether the primary BGP route is being announced.", "type": "boolean", "example": false }, "primary_cloud_ip": { "type": "string", "format": "ipv4", "description": "The IP address assigned for your side of the Virtual Cross Connect.

If none is provided, one will be generated for you.

This value can not be patched once the VXC has bene provisioned.", "example": "169.254.0.2" }, "secondary_enabled": { "type": "boolean", "description": "Indicates whether the secondary circuit is enabled. Setting this to `false` will disable the circuit.", "example": true }, "secondary_routing_announcement": { "description": "Whether the secondary BGP route is being announced.", "type": "boolean", "example": false }, "secondary_cloud_ip": { "type": "string", "format": "ipv4", "description": "The IP address assigned for your side of the Virtual Cross Connect.

If none is provided, one will be generated for you.

This value can not be patched once the VXC has bene provisioned.", "example": "169.254.0.4" } } } ] }, "VirtualCrossConnectRegion": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "type": "object", "title": "VirtualCrossConnectRegion", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "virtual_cross_connect_region" }, "region_code": { "description": "The region the interface is deployed to.", "type": "string", "example": "ashburn-va" }, "cloud_provider": { "type": "string", "enum": [ "aws", "azure", "gce" ], "description": "The Virtual Private Cloud with which you would like to establish a cross connect.", "example": "aws" }, "cloud_region": { "type": "string", "description": "The region where your Virtual Private Cloud hosts are located.", "example": "us-east-1" }, "bandwidth_mbps": { "type": "array", "description": "The available throughput in Megabits per Second (Mbps) for your Virtual Cross Connect.", "items": { "type": "number" }, "example": [ 50, 100, 200, 500 ] } } } ] }, "Volume": { "title": "Volume", "enum": [ "10", "100", "1,000", "10,000", "100,000", "250,000", "500,000", "750,000", "1,000,000", "5,000,000", "10,000,000+" ], "type": "string", "description": "Message Volume Enums" }, "WdrReport": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifies the resource.", "readOnly": true, "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "record_type": { "type": "string", "readOnly": true, "example": "detail_records_report" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "updated_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the resource was updated.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "start_time": { "description": "ISO 8601 formatted date-time indicating the start time.", "type": "string", "example": "2018-02-02T22:25:27.521Z" }, "end_time": { "description": "ISO 8601 formatted date-time indicating the end time.", "type": "string", "example": "2018-02-02T22:25:27.521Z" }, "status": { "description": "Indicates the status of the report, which is updated asynchronously.", "type": "string", "enum": [ "pending", "complete", "failed", "deleted" ], "example": "pending" }, "report_url": { "description": "The URL where the report content, when generated, will be published to.", "type": "string", "example": "http://example.com" } } }, "WdrReportRequest": { "type": "object", "properties": { "start_time": { "description": "ISO 8601 formatted date-time indicating the start time.", "type": "string", "example": "2018-02-02T22:25:27.521Z" }, "end_time": { "description": "ISO 8601 formatted date-time indicating the end time.", "type": "string", "example": "2018-02-02T22:25:27.521Z" } }, "example": { "start_time": "2018-02-02T22:25:27.521Z", "end_time": "2018-02-02T22:25:27.521Z" } }, "WebhookApiVersion": { "title": "Webhook API Version", "description": "Determines which webhook format will be used, Telnyx API v1 or v2.", "type": "string", "enum": [ "1", "2" ], "default": "1", "example": "1" }, "WebhookEventFailoverUrl": { "title": "Webhook Event Failover URL", "description": "The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.", "type": "string", "format": "url", "default": "", "nullable": true, "example": "https://failover.example.com" }, "WebhookEventUrl": { "title": "Webhook Event URL", "description": "The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.", "type": "string", "format": "url", "example": "https://example.com" }, "WebhookTimeoutSecs": { "title": "Webhook Timeout Secs", "type": "integer", "description": "Specifies how many seconds to wait before timing out a webhook.", "minimum": 0, "maximum": 30, "nullable": true, "default": null, "example": 25 }, "WhatsAppConversationDetailRecord": { "type": "object", "properties": { "recipient_region_code": { "type": "string", "description": "CLDR two-letter region-code of recipient", "example": "US" }, "currency": { "type": "string", "description": "Telnyx account currency used to describe monetary values, including billing cost", "example": "USD" }, "created_at": { "type": "string", "description": "UTC time when the message was created", "format": "date-time", "example": "2021-08-06T03:32:01.125Z" }, "whatsapp_fee": { "type": "string", "description": "Currency amount for WhatsApp cost", "example": 0.003 }, "conversation_id": { "type": "string", "description": "Whatsapp Conversation ID", "example": "f44ae083-c800-4433-baac-b439e5270aa4" }, "conversation_origin": { "type": "string", "description": "Whatsapp Conversation Origin", "enum": [ "business_initiated", "user_initiated", "referral_conversion" ] }, "whatsapp_business_account_id": { "type": "string", "description": "Whatsapp Business Account ID", "example": "421452453" }, "record_type": { "type": "string", "example": "whatsapp-conversation_detail_record", "default": "whatsapp-conversation_detail_record" } }, "required": [ "record_type" ] }, "WhatsAppDetailRecord": { "type": "object", "properties": { "id": { "type": "string", "description": "WhatsApp Message Id", "example": "gBOGyfgaqtrewgpRTGqKuHKaTRhP" }, "version": { "type": "string", "description": "WhatsApp API Version", "example": "v0.1.0" }, "sender_id": { "type": "string", "description": "WhatsApp Sender Id", "example": "18336512500" }, "recipient_id": { "type": "string", "description": "WhatsApp Recipient Id", "example": "18336512500" }, "message_type": { "type": "string", "description": "WhatsApp Message Type. Consult WhatsApp API documentation to see all available types", "example": "session", "enum": [ "session", "template" ] }, "message_status": { "type": "string", "description": "WhatsApp Message Status. Consult WhatsApp API documentation to see all available status", "example": "delivered", "enum": [ "sent", "delivered", "read", "failed", "deleted" ] }, "direction": { "type": "string", "description": "Logical direction of the message from the Telnyx customer's perspective. It's inbound when the Telnyx customer receives the message, or outbound otherwise", "example": "inbound", "enum": [ "inbound", "outbound" ] }, "recipient_region_code": { "type": "string", "description": "CLDR two-letter region-code of recipient", "example": "US" }, "currency": { "type": "string", "description": "Telnyx account currency used to describe monetary values, including billing cost", "example": "USD" }, "whatsapp_error_code": { "type": "string", "description": "A string representing Whatsapp error code. Consult WhatsApp API documentation to see all available error codes", "example": "490" }, "created_at": { "type": "string", "description": "UTC time when the message was created", "format": "date-time", "example": "2021-08-06T03:32:01.125Z" }, "webhook_received_at": { "type": "string", "description": "UTC time when the webhook was received", "format": "date-time", "example": "2021-08-06T03:32:01.125Z" }, "webhook_id": { "type": "string", "description": "UUID representation of the webhook unique identifier", "example": "3ca7bd3d-7d82-4e07-9df4-009123068320" }, "telnyx_fee": { "type": "string", "description": "Currency amount for Telnyx billing cost", "example": 0.003 }, "whatsapp_fee": { "type": "string", "description": "Currency amount for WhatsApp cost", "example": 0.003 }, "conversation_id": { "type": "string", "description": "Whatsapp Conversation ID", "example": "f44ae083-c800-4433-baac-b439e5270aa4" }, "conversation_origin": { "type": "string", "description": "Whatsapp Conversation Origin", "enum": [ "business_initiated", "user_initiated", "referral_conversion" ] }, "whatsapp_business_account_id": { "type": "string", "description": "Whatsapp Business Account ID", "example": "421452453" }, "record_type": { "type": "string", "example": "whatsapp_detail_record", "default": "whatsapp_detail_record" } }, "required": [ "record_type" ] }, "WireguardInterface": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "$ref": "#/components/schemas/Interface" }, { "type": "object", "title": "WireguardInterface", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "wireguard_interface" }, "endpoint": { "type": "string", "description": "The Telnyx WireGuard peers `Peer.endpoint` value.", "example": "203.0.113.0:51871", "readOnly": true }, "public_key": { "type": "string", "description": "The Telnyx WireGuard peers `Peer.PublicKey`.", "readOnly": true, "example": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=" }, "enable_sip_trunking": { "type": "boolean", "description": "Enable SIP traffic forwarding over VPN interface." } } } ] }, "WireguardInterfaceCreate": { "allOf": [ { "$ref": "#/components/schemas/WireguardInterface" }, { "$ref": "#/components/schemas/RegionIn" }, { "type": "object", "title": "WireguardInterfaceCreate", "required": [ "network_id", "region_code" ] } ] }, "WireguardInterfaceRead": { "allOf": [ { "$ref": "#/components/schemas/WireguardInterface" }, { "$ref": "#/components/schemas/RegionOut" } ] }, "WireguardPeer": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "$ref": "#/components/schemas/WireguardPeerPatch" }, { "type": "object", "title": "WireguardPeer", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "wireguard_peer" }, "last_seen": { "type": "string", "description": "ISO 8601 formatted date-time indicating when peer sent traffic last time.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "wireguard_interface_id": { "description": "The id of the wireguard interface associated with the peer.", "type": "string", "format": "uuid", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "private_key": { "type": "string", "description": "Your WireGuard `Interface.PrivateKey`.

This attribute is only ever utlised if, on POST, you do NOT provide your own `public_key`. In which case, a new Public and Private key pair will be generated for you. When your `private_key` is returned, you must save this immediately as we do not save it within Telnyx. If you lose your Private Key, it can not be recovered.", "example": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=", "readOnly": true } } } ] }, "WireguardPeerAllowedIP": { "allOf": [ { "$ref": "#/components/schemas/Record" }, { "type": "object", "title": "WireguardAllowedIP", "properties": { "record_type": { "type": "string", "description": "Identifies the type of the resource.", "readOnly": true, "example": "wireguard_allowed_ip" }, "ip_address": { "type": "string", "description": "The IP address to add to the Wireguard Interface's AllowedIP list.", "example": "198.51.100.1" } } } ] }, "WireguardPeerAllowedIPCreate": { "allOf": [ { "$ref": "#/components/schemas/WireguardPeerAllowedIP" }, { "type": "object", "title": "WireguardPeerAllowedIPCreate", "required": [ "ip_address" ] } ] }, "WireguardPeerCreate": { "allOf": [ { "$ref": "#/components/schemas/WireguardPeer" }, { "type": "object", "title": "WireguardPeerCreate", "required": [ "wireguard_interface_id" ] } ] }, "WireguardPeerPatch": { "type": "object", "title": "WireguardPeerPatch", "properties": { "public_key": { "type": "string", "description": "The WireGuard `PublicKey`.

If you do not provide a Public Key, a new Public and Private key pair will be generated for you.", "example": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=" } } }, "WirelessConnectivityLog": { "type": "object", "title": "WirelessConnectivityLog", "description": "This object represents a wireless connectivity session log that happened through a SIM card. It aids in finding out potential problems when the SIM is not able to attach properly.", "properties": { "record_type": { "type": "string", "example": "wireless_connectivity_log", "readOnly": true }, "id": { "type": "integer", "example": 137509451, "description": "Uniquely identifies the session.", "readOnly": true }, "sim_card_id": { "type": "string", "format": "uuid", "description": "The identification UUID of the related SIM card resource.", "example": "6a09cdc3-8948-47f0-aa62-74ac943d6c58" }, "log_type": { "type": "string", "enum": [ "registration", "data" ], "example": "registration", "description": "The type of the session, 'registration' being the initial authentication session and 'data' the actual data transfer sessions.", "readOnly": true }, "imsi": { "type": "string", "description": "SIM cards are identified on their individual network operators by a unique International Mobile Subscriber Identity (IMSI).
\nMobile network operators connect mobile phone calls and communicate with their market SIM cards using their IMSIs. The IMSI is stored in the Subscriber Identity Module (SIM) inside the device and is sent by the device to the appropriate network. It is used to acquire the details of the device in the Home Location Register (HLR) or the Visitor Location Register (VLR).\n", "readOnly": true, "example": "081932214823362973" }, "imei": { "type": "string", "description": "The International Mobile Equipment Identity (or IMEI) is a number, usually unique, that identifies the device currently being used connect to the network.", "readOnly": true, "example": "490154203237518" }, "mobile_country_code": { "type": "string", "description": "It's a three decimal digit that identifies a country.

\nThis code is commonly seen joined with a Mobile Network Code (MNC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.", "readOnly": true, "example": "310" }, "mobile_network_code": { "type": "string", "description": "It's a two to three decimal digits that identify a network.

\n This code is commonly seen joined with a Mobile Country Code (MCC) in a tuple that allows identifying a carrier known as PLMN (Public Land Mobile Network) code.", "readOnly": true, "example": "410" }, "start_time": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the session started.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "stop_time": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the session ended.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "created_at": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the record was created.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "last_seen": { "type": "string", "description": "ISO 8601 formatted date-time indicating when the last heartbeat to the device was successfully recorded.", "readOnly": true, "example": "2018-02-02T22:25:27.521Z" }, "apn": { "type": "string", "description": "The Access Point Name (APN) identifies the packet data network that a mobile data user wants to communicate with.", "readOnly": true, "example": "data00.telnyx" }, "ipv4": { "type": "string", "description": "The SIM's address in the currently connected network. This IPv4 address is usually obtained dynamically, so it may vary according to the location or new connections.\n", "readOnly": true, "example": "192.168.0.0" }, "ipv6": { "type": "string", "description": "The SIM's address in the currently connected network. This IPv6 address is usually obtained dynamically, so it may vary according to the location or new connections.\n", "readOnly": true, "example": "2001:cdba:0000:0000:0000:0000:3257:9652" }, "radio_access_technology": { "type": "string", "description": "The radio technology the SIM card used during the session.", "readOnly": true, "example": "LTE" }, "state": { "type": "string", "description": "The state of the SIM card after when the session happened.", "readOnly": true, "example": "provisioned" }, "cell_id": { "type": "string", "description": "The cell ID to which the SIM connected.", "readOnly": true, "example": "311210-6813" } } }, "WirelessCost": { "type": "object", "properties": { "amount": { "type": "string", "description": "Final cost. Cost is calculated as rate * unit", "example": 0.1 }, "currency": { "type": "string", "description": "Currency of the rate and cost", "example": "USD", "enum": [ "AUD", "CAD", "EUR", "GBP", "USD" ] } } }, "WirelessRate": { "type": "object", "properties": { "amount": { "type": "string", "description": "Rate from which cost is calculated", "example": 0.1 }, "currency": { "type": "string", "description": "Currency of the rate and cost", "example": "USD", "enum": [ "AUD", "CAD", "EUR", "GBP", "USD" ] } } }, "active": { "type": "boolean", "description": "The active status of the authentication provider", "example": true, "default": true }, "address_book": { "type": "boolean", "description": "Indicates whether or not the address should be considered part of your list of addresses that appear for regular use.", "example": false, "default": true }, "administrative_area": { "type": "string", "description": "The locality of the address. For US addresses, this corresponds to the state of the address.", "example": "IL" }, "attempt": { "description": "Webhook delivery attempt details.", "properties": { "status": { "type": "string", "enum": [ "delivered", "failed" ] }, "started_at": { "description": "ISO 8601 timestamp indicating when the attempt was initiated.", "type": "string", "format": "date-time" }, "finished_at": { "description": "ISO 8601 timestamp indicating when the attempt has finished.", "type": "string", "format": "date-time" }, "http": { "$ref": "#/components/schemas/http" }, "errors": { "description": "Webhook delivery errors.", "type": "array", "items": { "$ref": "#/components/schemas/error" } } }, "example": [ { "status": "delivered", "started_at": "2020-08-10T14:00:05.364Z", "finished_at": "2020-08-10T14:00:05.595Z", "http": { "request": { "url": "https://fallback.example.com/webhooks", "headers": [ "Accept: */*" ] }, "response": { "status": 200, "headers": [ "Content-Type: text/html" ], "body": "All good." } } }, { "status": "failed", "started_at": "2020-08-10T14:00:05.004Z", "finished_at": "2020-08-10T14:00:05.360Z", "http": { "request": { "url": "https://typo.example.com/webhooks", "headers": [ "Accept: */*" ] }, "response": { "status": 404, "headers": [ "Content-Type: text/html", "Pragma: no-cache" ], "body": "Oops. Not found." } }, "errors": [ { "code": "75499", "title": "Webhook host returned HTTP 4XX", "detail": "The server returned another HTTP 4XX error" } ] }, { "status": "failed", "started_at": "2020-08-10T14:00:00.000Z", "finished_at": "2020-08-10T14:00:05.000Z", "http": { "request": { "url": "https://slow.example.com/webhooks", "headers": [ "Accept: */*" ] }, "reponse": null }, "errors": [ { "code": "75001", "title": "Could not resolve name", "detail": "Unable to resolve the webhook URL domain name" } ] } ] }, "borough": { "type": "string", "description": "The borough of the address. This field is not used for addresses in the US but is used for some international addresses.", "example": "Guadalajara" }, "business_name": { "type": "string", "description": "The business name associated with the address. An address must have either a first last name or a business name.", "example": "Toy-O'Kon" }, "callRecordingError": { "type": "object", "title": "Call Recording Error", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "call.recording.error", "enum": [ "call.recording.error" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": { "call_control_id": { "type": "string", "example": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg", "description": "Call ID used to issue commands via Call Control API." }, "connection_id": { "type": "string", "example": "7267xxxxxxxxxxxxxx", "description": "Call Control App ID (formerly Telnyx connection ID) used in the call." }, "call_leg_id": { "type": "string", "example": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "description": "ID that is unique to the call and can be used to correlate webhook events." }, "call_session_id": { "type": "string", "example": "428c31b6-abf3-3bc1-b7f4-5013ef9657c1", "description": "ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call." }, "client_state": { "type": "string", "example": "aGF2ZSBhIG5pY2UgZGF5ID1d", "description": "State received from a command." }, "reason": { "type": "string", "example": "Internal server error", "enum": [ "Failed to authorize with storage using custom credentials", "Invalid credentials json", "Unsupported backend", "Internal server error" ], "description": "Indication that there was a problem recording the call." } } } }, "example": { "record_type": "event", "event_type": "call.recording.error", "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "occurred_at": "2018-02-02T22:25:27.521992Z", "payload": { "connection_id": "7267xxxxxxxxxxxxxx", "call_leg_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "call_session_id": "428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d", "result": "Internal server error" } } }, "callRecordingErrorEvent": { "type": "object", "title": "Call Recording Error Event", "properties": { "data": { "$ref": "#/components/schemas/callRecordingError" } } }, "campaign_registry__api__schemas__bulk_creation__Meta": { "properties": { "page": { "title": "Page", "type": "integer", "example": 1 }, "recordsPerPage": { "title": "Recordsperpage", "type": "integer", "example": 20 }, "totalPages": { "title": "Totalpages", "type": "integer", "example": 1 }, "totalRecords": { "title": "Totalrecords", "type": "integer", "example": 1 } }, "required": [ "page", "recordsPerPage", "totalRecords", "totalPages" ], "title": "Meta", "type": "object" }, "campaign_registry__api__schemas__bulk_creation__TaskStatus": { "description": "An enumeration.", "enum": [ "pending", "processing", "completed", "completed with errors" ], "title": "TaskStatus", "type": "string" }, "country_code": { "type": "string", "description": "The two-character (ISO 3166-1 alpha-2) country code of the address.", "example": "US" }, "customer_reference": { "type": "string", "description": "A customer reference string for customer look ups.", "example": "MY REF 001" }, "error": { "properties": { "code": { "type": "string", "format": "int" }, "title": { "type": "string" }, "detail": { "type": "string" } } }, "extended_address": { "type": "string", "description": "Additional street address information about the address such as, but not limited to, unit number or apartment number.", "example": "#504" }, "first_name": { "type": "string", "description": "The first name associated with the address. An address must have either a first last name or a business name.", "example": "Alfred" }, "http": { "description": "HTTP request and response information.", "properties": { "request": { "description": "Request details.", "properties": { "url": { "type": "string", "example": "https://example.com/webhooks" }, "headers": { "$ref": "#/components/schemas/http_headers" } } }, "response": { "description": "Response details, optional.", "nullable": true, "properties": { "status": { "type": "integer", "example": 200 }, "headers": { "$ref": "#/components/schemas/http_headers" }, "body": { "description": "Raw response body, limited to 10kB.", "type": "string" } } } } }, "http_headers": { "description": "List of headers, limited to 10kB.", "type": "array", "items": { "type": "string", "example": "Header-Name: header value" } }, "last_name": { "type": "string", "description": "The last name associated with the address. An address must have either a first last name or a business name.", "example": "Foster" }, "locality": { "type": "string", "description": "The locality of the address. For US addresses, this corresponds to the city of the address.", "example": "Chicago" }, "name": { "type": "string", "description": "The name associated with the authentication provider.", "example": "Okta" }, "neighborhood": { "type": "string", "description": "The neighborhood of the address. This field is not used for addresses in the US but is used for some international addresses.", "example": "Ciudad de los deportes" }, "organization_id": { "type": "string", "format": "uuid", "description": "The id from the Organization the authentication provider belongs to.", "example": "24b4a4bb-c4df-46ad-bbcb-23fc741c5ad7" }, "phone_number": { "type": "string", "description": "The phone number associated with the address.", "example": "+12125559000" }, "postal_code": { "type": "string", "description": "The postal code of the address.", "example": "60654" }, "settings": { "type": "object", "description": "The settings associated with the authentication provider.", "required": [ "idp_entity_id", "idp_sso_target_url", "idp_cert_fingerprint" ], "properties": { "idp_entity_id": { "type": "string", "description": "The Entity ID for the identity provider (IdP).", "example": "https://myorg.myidp.com/saml/metadata" }, "idp_sso_target_url": { "type": "string", "description": "The SSO target url for the identity provider (IdP).", "example": "https://myorg.myidp.com/trust/saml2/http-post/sso" }, "idp_cert_fingerprint": { "type": "string", "description": "The certificate fingerprint for the identity provider (IdP)", "example": "13:38:C7:BB:C9:FF:4A:70:38:3A:E3:D9:5C:CD:DB:2E:50:1E:80:A7" }, "idp_cert_fingerprint_algorithm": { "type": "string", "description": "The algorithm used to generate the identity provider's (IdP) certificate fingerprint", "enum": [ "sha1", "sha256", "sha384", "sha512" ], "example": "sha256", "default": "sha1" } } }, "settings_url": { "type": "string", "description": "The URL for the identity provider metadata file to populate the settings automatically. If the settings attribute is provided, that will be used instead.", "example": "https://myorg.myidp.com/saml/metadata" }, "short_name": { "type": "string", "description": "The short name associated with the authentication provider. This must be unique and URL-friendly, as it's going to be part of the login URL.", "example": "myorg" }, "street_address": { "type": "string", "description": "The primary street address information about the address.", "example": "311 W Superior Street" }, "validate_address": { "type": "boolean", "description": "Indicates whether or not the address should be validated for emergency use upon creation or not. This should be left with the default value of `true` unless you have used the `/addresses/actions/validate` endpoint to validate the address separately prior to creation. If an address is not validated for emergency use upon creation and it is not valid, it will not be able to be used for emergency services.", "example": true, "default": true }, "webhook_delivery": { "description": "Record of all attempts to deliver a webhook.", "properties": { "id": { "description": "Uniquely identifies the webhook_delivery record.", "type": "string", "format": "uuid", "example": "f5586561-8ff0-4291-a0ac-84fe544797bd" }, "user_id": { "description": "Uniquely identifies the user that owns the webhook_delivery record.", "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0" }, "record_type": { "description": "Identifies the type of the resource.", "type": "string", "example": "webhook_delivery" }, "status": { "description": "Delivery status: 'delivered' when successfuly delivered or 'failed' if all attempts have failed.", "enum": [ "delivered", "failed" ], "type": "string" }, "webhook": { "description": "Original webhook JSON data. Payload fields vary according to event type.", "type": "object", "properties": { "record_type": { "type": "string", "example": "event", "enum": [ "event" ], "description": "Identifies the type of the resource." }, "event_type": { "type": "string", "example": "webhook.command", "enum": [ "webhook.command" ], "description": "The type of event being delivered." }, "id": { "type": "string", "format": "uuid", "example": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "description": "Identifies the type of resource." }, "occurred_at": { "type": "string", "format": "date-time", "example": "2018-02-02T22:25:27.521992Z", "description": "ISO 8601 datetime of when the event occurred." }, "payload": { "type": "object", "properties": {} } }, "example": { "record_type": "event", "id": "C9C0797E-901D-4349-A33C-C2C8F31A92C2", "event_type": "call_initiated", "occurred_at": "2020-08-10T13:02:01.000Z", "payload": { "useful": "information" } } }, "started_at": { "description": "ISO 8601 timestamp indicating when the first request attempt was initiated.", "type": "string", "format": "date-time", "example": "2020-08-10T14:00:00.000Z" }, "finished_at": { "description": "ISO 8601 timestamp indicating when the last webhook response has been received.", "type": "string", "format": "date-time", "example": "2020-08-10T14:00:05.595Z" }, "attempts": { "description": "Detailed delivery attempts, ordered by most recent.", "type": "array", "items": { "$ref": "#/components/schemas/attempt" }, "example": [ { "status": "delivered", "started_at": "2020-08-10T14:00:05.364Z", "finished_at": "2020-08-10T14:00:05.595Z", "http": { "request": { "url": "https://fallback.example.com/webhooks", "headers": [ "Accept: */*" ] }, "response": { "status": 200, "headers": [ "Content-Type: text/html" ], "body": "All good." } } }, { "status": "failed", "started_at": "2020-08-10T14:00:05.004Z", "finished_at": "2020-08-10T14:00:05.360Z", "http": { "request": { "url": "https://typo.example.com/webhooks", "headers": [ "Accept: */*" ] }, "response": { "status": 404, "headers": [ "Content-Type: text/html", "Pragma: no-cache" ], "body": "Oops. Not found." } }, "errors": [ { "code": "75499", "title": "Webhook host returned HTTP 4XX", "detail": "The server returned another HTTP 4XX error" } ] } ] } } } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" }, "bearerAuth": { "type": "http", "scheme": "bearer" } } } }