Voice API reference

Voice API.

12 endpoints, 5 of them read-only. Every one is also a command in the orbit CLI, a method in the SDKs and a tool on the MCP server.

numbers

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /voice/numbers` Your Voice numbers, and those that ring an extension assigned to you	read	—	`orbit voice numbers list` `voice_numbers_list`
`POST /voice/numbers` Claim a Voice number; your packs set how many you may hold	write	body: `label` string	`orbit voice numbers claim` `voice_numbers_claim`
`GET /voice/numbers/{number}` One Voice number	read	`number` string	`orbit 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	write	`number` string body: `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	write	`number` string	`orbit voice numbers release <number>` `voice_numbers_release`

endpoints

Endpoint	Scope	Parameters	CLI · MCP tool
`POST /voice/numbers/{number}/endpoints` Make the number ring an extension you own or are assigned; an extension rings for one number at most	write	`number` string body: `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	write	`number` string `pbx` string `ext` string	`orbit voice endpoints remove <number> <pbx> <ext>` `voice_endpoints_remove`

General

Endpoint	Scope	Parameters	CLI · MCP tool
`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	read	—	`orbit voice destinations` `voice_destinations`
`GET /voice/extensions` Extensions a Voice number can ring: those on PBXs you own and those assigned to you	read	—	`orbit voice extensions` `voice_extensions`

pbx

Endpoint	Scope	Parameters	CLI · MCP tool
`GET /vgate/pbx/{pbx}/voice-numbers` The Voice number each extension of a PBX rings for	read	`pbx` string	`orbit 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	write	`pbx` string `id` string body: `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	write	`pbx` string `id` string	`orbit voice pbx unassign <pbx> <id>` `voice_pbx_unassign`

Account API reference

Every Account endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Organization API reference

Every Organization endpoint in the Orbit API (10): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

Services API reference

Every Services endpoint in the Orbit API (15): method and path, the token scope it needs, its parameters, and the matching CLI command and MCP tool.

← All documentation