Voice API 参考

Voice API。

共 12 个端点,其中 5 个只读。每一个都同时是 orbit 命令行中的命令、SDK 中的方法和 MCP 服务器上的工具。

01

numbers

端点权限参数CLI · MCP 工具
GET /voice/numbers
Your Voice numbers, and those that ring an extension assigned to you
只读—orbit voice numbers list
voice_numbers_list
POST /voice/numbers
Claim a Voice number; your packs set how many you may hold
读写请求体: label stringorbit voice numbers claim
voice_numbers_claim
GET /voice/numbers/{number}
One Voice number
只读number stringorbit voice numbers get <number>
voice_numbers_get
PATCH /voice/numbers/{number}
Change a number's label, whether other SIP services may call it, and where its calls go
读写number string
请求体: sip_in boolean, noanswer string, label string, dest string
orbit voice numbers patch <number>
voice_numbers_patch
DELETE /voice/numbers/{number}
Release a Voice number
读写number stringorbit voice numbers release <number>
voice_numbers_release
02

endpoints

端点权限参数CLI · MCP 工具
POST /voice/numbers/{number}/endpoints
Make the number ring an extension you own or are assigned; an extension rings for one number at most
读写number string
请求体: pbx_id* string, ext* string
orbit voice endpoints add <number>
voice_endpoints_add
DELETE /voice/numbers/{number}/endpoints/{pbx}/{ext}
Stop the number ringing an extension
读写number string
pbx string
ext string
orbit voice endpoints remove <number> <pbx> <ext>
voice_endpoints_remove
03

通用

端点权限参数CLI · MCP 工具
GET /voice/destinations
Where a number of yours can send its calls: the IVRs, queues, ring groups, time conditions and voicemail boxes of your PBXs
只读—orbit voice destinations
voice_destinations
GET /voice/extensions
Extensions a Voice number can ring: those on PBXs you own and those assigned to you
只读—orbit voice extensions
voice_extensions
04

pbx

端点权限参数CLI · MCP 工具
GET /vgate/pbx/{pbx}/voice-numbers
The Voice number each extension of a PBX rings for
只读pbx stringorbit voice pbx numbers <pbx>
voice_pbx_numbers
POST /vgate/pbx/{pbx}/extensions/{id}/voice-number
Give an extension a Voice number of its own, held by the PBX's owner
读写pbx string
id string
请求体: label string
orbit voice pbx assign <pbx> <id>
voice_pbx_assign
DELETE /vgate/pbx/{pbx}/extensions/{id}/voice-number
Take an extension's Voice number away; a number held by the PBX's owner that rings nowhere else is released
读写pbx string
id string
orbit voice pbx unassign <pbx> <id>
voice_pbx_unassign
继续

相关文档

账户 API 参考

Orbit API 中 账户 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

组织 API 参考

Orbit API 中 组织 的全部 10 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

服务 API 参考

Orbit API 中 服务 的全部 15 个端点:方法与路径、所需令牌权限、参数,以及对应的命令行命令与 MCP 工具。

← 全部文档