{"@context": "https://schema.org", "@type": "WebAPI", "name": "Vonage Integration Suite API", "description": "The Vonage Integration Suite API enables call control and webhooks for call events. Your application must subscribe to the VonageIntegrationSuite API suite to use this API.", "provider": {"@type": "Organization", "name": "vonage.com"}, "documentation": "https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/vonage-business-cloud/vgis.yml"}
The Vonage Integration Suite API enables call control and webhooks for call events. Your application must subscribe to the VonageIntegrationSuite API suite to use this API.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.vonage.com/t/vbc.prod/vis/v1 https://api.vonage.com/t/vbc.prod/provisioning https://api.vonage.com/t/vbc.prod/reports
auth: b e a r
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The Vonage Integration Suite API enables call control and webhooks for call events. Your application must subscribe to the VonageIntegrationSuite API suite to use this API.
| method | path | what the vendor says it does |
|---|---|---|
GET | /self | User info Users |
GET | /self/account | Account info Accounts |
GET | /self/calls | List active calls Lists currently active calls Calls |
POST | /self/calls | Place a call Calls |
GET | /self/calls/count | Get calls count Calls |
GET | /self/calls/{id} | Get a call Calls |
DELETE | /self/calls/{id} | End a call Calls |
PUT | /self/calls/{id}/answer | Answer call (On supported devices) Calls |
PUT | /self/calls/{id}/hold | Put call on hold Calls |
DELETE | /self/calls/{id}/hold | Unhold Calls |
POST | /self/calls/{id}/transfer | Transfer call Calls |
PUT | /self/calls/{id}/vmtransfer | Send call to voicemail Calls |
GET | /self/events | List events Events |
GET | /self/events/count | Get events count Events |
GET | /self/events/{id} | Get event Events |
GET | /self/webhooks | List web hooks Webhooks |
POST | /self/webhooks | Create a new webhook subscription Webhooks |
GET | /self/webhooks/{id} | Get web hook details Webhooks |
DELETE | /self/webhooks/{id} | Remove a web hook Webhooks |
PUT | /self/webhooks/{id}/renew | Renews a web hook Webhooks |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/vonage-busine
The Vonage Business Cloud Account API enables you to retrieve information about accounts. Your application must subscribe to the Provisioning API suite to use this API.
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/accounts/{account_id} | Get account data by ID |
GET | /api/accounts/{account_id}/locations | Get account locations data by account ID |
GET | /api/accounts/{account_id}/locations/{location_id} | Get location data by account ID and location ID |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/vonage-busine
The Vonage Business Cloud Extension API enables you to retrieve information about extensions. Your application must subscribe to the Provisioning API suite to use this API.
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/accounts/{account_id}/extensions | Get account extensions data by account ID |
GET | /api/accounts/{account_id}/extensions/{extension_number} | Get extension data by account ID and extension number |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/vonage-busine
The Vonage Business Cloud User API enables you to retrieve information about users. Your application must subscribe to the Provisioning API suite to use this API.
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/accounts/{account_id}/users | Get account users data by account ID |
GET | /api/accounts/{account_id}/users/{user_id} | Get user data by account ID and user ID |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/vonage-busine
The Vonage Business Cloud Reports API enables you to retrieve call logs for your account. Your application must subscribe to the Reports API suite to use this API.
| method | path | what the vendor says it does |
|---|---|---|
GET | /accounts/{account_id}/call-logs | Retrieve call logs for your account Retrieve call logs for your account |
specification origin: https://raw.githubusercontent.com/nexmo/api-specification/master/definitions/vonage-busine
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.