{"openapi":"3.1.0","info":{"title":"Telnyx Numbers Config (BYOK) API","version":"0.1.0","description":"Telnyx Numbers Config (BYOK) lets an AI assistant read your own Telnyx Numbers Config data through the Telnyx Numbers Config API with a key you supply (API key (V2)). Read-only: 10 tools (list_number_voice_settings, get_number_voice_settings, list_number_messaging_settings, get_number_messaging_settings, list_number_orders, get_number_order, list_number_block_orders, list_number_bulk_jobs,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-telnyx-numbers-config.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-telnyx-numbers-config/docs"},"termsOfService":"https://connectorbay.com/byok-telnyx-numbers-config/terms"},"servers":[{"url":"https://byok-telnyx-numbers-config.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-telnyx-numbers-config/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_number_voice_settings":{"post":{"operationId":"list_number_voice_settings","summary":"List your phone numbers with voice settings: connection, payment method, call screening, recording format, emergency sta","description":"List your phone numbers with voice settings: connection, payment method, call screening, recording format, emergency status and CNAM listing flag. Forwarding targets are not returned. Use for \"Which of my Telnyx numbers have call screening or emergency services enabled\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (1 to 250, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"sort":{"anyOf":[{"enum":["purchased_at","phone_number","connection_name","usage_payment_method"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order: purchased_at, phone_number, connection_name, usage_payment_method.","title":"Sort"},"phone_number":{"anyOf":[{"maxLength":20,"type":"string"},{"type":"null"}],"default":null,"description":"Only numbers containing these digits (at least three).","title":"Phone Number"},"customer_reference":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only numbers with this customer reference text.","title":"Customer Reference"}},"title":"list_number_voice_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_number_voice_settings":{"post":{"operationId":"get_number_voice_settings","summary":"Get the voice settings of one phone number record: connection, payment method, screening, recording, emergency and media","description":"Get the voice settings of one phone number record: connection, payment method, screening, recording, emergency and media features. Use for \"What are the voice settings of this Telnyx number\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"number_id":{"description":"Phone number record ID from a number list (not the number itself).","maxLength":64,"title":"Number Id","type":"string"}},"required":["number_id"],"title":"get_number_voice_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_number_messaging_settings":{"post":{"operationId":"list_number_messaging_settings","summary":"List your numbers with messaging settings: messaging profile, number type, traffic type, eligible products and health ra","description":"List your numbers with messaging settings: messaging profile, number type, traffic type, eligible products and health ratios. Use for \"Which Telnyx numbers can send messages and which profile are they on\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (1 to 250, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"messaging_profile_id":{"anyOf":[{"maxLength":64,"type":"string"},{"type":"null"}],"default":null,"description":"Only numbers of this messaging profile (UUID).","title":"Messaging Profile Id"},"type":{"anyOf":[{"enum":["tollfree","longcode","shortcode"],"type":"string"},{"type":"null"}],"default":null,"description":"Only numbers of this type.","title":"Type"}},"title":"list_number_messaging_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_number_messaging_settings":{"post":{"operationId":"get_number_messaging_settings","summary":"Get the messaging settings of one phone number record: profile, type, traffic type, eligible products and health. Use fo","description":"Get the messaging settings of one phone number record: profile, type, traffic type, eligible products and health. Use for \"What are the messaging settings of this Telnyx number\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"number_id":{"description":"Phone number record ID from a number list (not the number itself).","maxLength":64,"title":"Number Id","type":"string"}},"required":["number_id"],"title":"get_number_messaging_settingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_number_orders":{"post":{"operationId":"list_number_orders","summary":"List phone number orders with status, number count, connection, messaging profile and whether regulatory requirements ar","description":"List phone number orders with status, number count, connection, messaging profile and whether regulatory requirements are met. Use for \"Are any of my Telnyx number orders still pending\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (1 to 250, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"status":{"anyOf":[{"enum":["pending","success","failure"],"type":"string"},{"type":"null"}],"default":null,"description":"Only orders with this status: pending, success or failure.","title":"Status"}},"title":"list_number_ordersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_number_order":{"post":{"operationId":"get_number_order","summary":"Get one phone number order: status, number count, connection, messaging profile and requirement state. Use for \"What is ","description":"Get one phone number order: status, number count, connection, messaging profile and requirement state. Use for \"What is the status of this Telnyx number order\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"number_order_id":{"description":"Number order ID (UUID) from the order list.","maxLength":64,"title":"Number Order Id","type":"string"}},"required":["number_order_id"],"title":"get_number_orderArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_number_block_orders":{"post":{"operationId":"list_number_block_orders","summary":"List number block orders (ranges of consecutive numbers) with starting number, range size, status and requirement state.","description":"List number block orders (ranges of consecutive numbers) with starting number, range size, status and requirement state. Use for \"Which number block orders have I placed on Telnyx\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (1 to 250, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"title":"list_number_block_ordersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_number_bulk_jobs":{"post":{"operationId":"list_number_bulk_jobs","summary":"List bulk phone number jobs (update, delete, emergency settings) with status and type. Use for \"Did my Telnyx bulk numbe","description":"List bulk phone number jobs (update, delete, emergency settings) with status and type. Use for \"Did my Telnyx bulk number update job finish\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":250,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items per page (1 to 250, default 20).","title":"Page Size"},"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"}},"title":"list_number_bulk_jobsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_requirement_types":{"post":{"operationId":"list_requirement_types","summary":"List the kinds of requirement (document, address or text) that regulators ask for when buying numbers, with description ","description":"List the kinds of requirement (document, address or text) that regulators ask for when buying numbers, with description and example. Use for \"What kinds of regulatory requirements does Telnyx ask for when ordering numbers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_requirement_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_regulatory_requirements":{"post":{"operationId":"list_regulatory_requirements","summary":"List the regulatory requirements for ordering or porting numbers by country, number type and action. Use for \"What do I ","description":"List the regulatory requirements for ordering or porting numbers by country, number type and action. Use for \"What do I need to buy a local number in Germany on Telnyx\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"country_code":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"ISO 3166 alpha-2 country code, for example DE.","title":"Country Code"},"phone_number_type":{"anyOf":[{"enum":["local","toll_free","mobile","national","shared_cost"],"type":"string"},{"type":"null"}],"default":null,"description":"Number type to check.","title":"Phone Number Type"},"action":{"anyOf":[{"enum":["ordering","porting","action"],"type":"string"},{"type":"null"}],"default":null,"description":"What the requirement applies to.","title":"Action"}},"title":"list_regulatory_requirementsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}