How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wazo Switchboards API

The switchboards API from Wazo — 9 operation(s) for switchboards.

Wazo Switchboards API is one of 113 APIs that Wazo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include switchboards. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, a changelog, authentication docs, and an AsyncAPI specification.

This API exposes 13 operations across 9 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: /1.0, /1.1.

13 operations 9 paths 46 schemas 1 DELETE5 GET1 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{wazo_stack}/api/auth/0.1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Wazo Switchboards API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Auth-Token (wazo_auth_token). By default, every request must be authenticated.

Paths & Operations 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 5 GET, 1 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

switchboards 13
GET
/switchboards/{switchboard_uuid}/calls/queued
List calls queued in the switchboard
getSwitchboardsBySwitchboardUuidCallsQueued 2 params → 200404503
PUT
/switchboards/{switchboard_uuid}/calls/queued/{call_id}/answer
Answer the specified queued call
putSwitchboardsBySwitchboardUuidCallsQueuedByCallIdAnswer 4 params → 200400404503
GET
/switchboards/{switchboard_uuid}/calls/held
List calls held in the switchboard
getSwitchboardsBySwitchboardUuidCallsHeld 2 params → 200404503
PUT
/switchboards/{switchboard_uuid}/calls/held/{call_id}
Put the specified call on hold in the switchboard
putSwitchboardsBySwitchboardUuidCallsHeldByCallId 3 params → 204400404503
PUT
/switchboards/{switchboard_uuid}/calls/held/{call_id}/answer
Answer the specified held call
putSwitchboardsBySwitchboardUuidCallsHeldByCallIdAnswer 4 params → 200400404503
GET
/switchboards
List switchboards
getSwitchboards 7 params → 200
POST
/switchboards
Create a switchboard
postSwitchboards 1 param body → 201400
GET
/switchboards/{switchboard_uuid}
Get a switchboard
getSwitchboardsBySwitchboardUuid 2 params → 200404
PUT
/switchboards/{switchboard_uuid}
Update a switchboard
putSwitchboardsBySwitchboardUuid 2 params body → 204400404
DELETE
/switchboards/{switchboard_uuid}
Delete a switchboard
deleteSwitchboardsBySwitchboardUuid 2 params → 204404
GET
/switchboards/{switchboard_uuid}/fallbacks
List all fallbacks for switchboard
get_switchboard_fallback 2 params → 200
PUT
/switchboards/{switchboard_uuid}/fallbacks
Update switchboard's fallbacks
update_switchboard_fallback 2 params body → 204400404
PUT
/switchboards/{switchboard_uuid}/members/users
Update switchboard and members
update_switchboard_member_users 1 param body → 204400404

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are DestinationType (14 properties), DestinationApplicationApplication (6 properties), DestinationQueue (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.

SwitchboardQueuedCall
object
3 properties
CallID
object
1 property
SwitchboardQueuedCalls
object
1 property
SwitchboardHeldCalls
object
1 property
Error
object
Error message for the client
4 properties
SwitchboardHeldCall
object
3 properties
DestinationConference
object
2 properties 2 required
DestinationNone
object
1 property 1 required
DestinationHangupNormal
1 required
DestinationSwitchboard
object
2 properties 2 required
Switchboard
object
DestinationOutcall
object
3 properties 3 required
DestinationApplicationDirectory
DestinationHangup
object
1 property 1 required
DestinationApplicationCustom
2 required
DestinationGroup
object
3 properties 2 required
UsersUuid
object
1 property
DestinationExtension
object
3 properties 3 required
IncallRelationBase
object
1 property
DestinationUser
object
4 properties 2 required
DestinationApplicationApplication
object
6 properties
SwitchboardRelationMembers
object
1 property
DestinationQueue
object
5 properties 2 required
DestinationIVR
object
2 properties 2 required
DestinationApplicationCallbackDISA
IncallRelationExtensions
object
1 property
DestinationHangupCongestion
1 required
DestinationHangupBusy
1 required
SwitchboardRelationIncalls
object
1 property
SwitchboardRelationMemberUsers
object
1 property
DestinationHangupCause
object
3 properties
DestinationCustom
object
2 properties 2 required
DestinationApplicationFaxToMail
2 required
ExtensionRelationBase
object
3 properties
UserRelationBase
object
3 properties
DestinationApplicationVoicemail
DestinationVoicemail
object
4 properties 2 required
DestinationApplicationDISA
SwitchboardRelationFallbacks
object
1 property
SwitchboardRelationIncall
DestinationSound
object
4 properties 2 required
SwitchboardFallbacks
object
1 property
DestinationApplication
object
1 property 1 required
UserUuid
object
1 property
Error_2
array
DestinationType
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wazo-switchboards-api-openapi.yml Raw ↑

Other APIs Wazo publishes across the network.

Wazo Phone Provisioning API (wazo-provd)
Wazo Websocket Event Stream (wazo-websocketd)
Wazo Aastra API
Wazo Access Features API
Wazo Action API
Wazo Adhoc Conferences API
Wazo Admin API
Wazo Agent Statistics API
Wazo Agents API
Wazo Applications API
Wazo Asterisk API
Wazo Backends API
Where this information came from

This is an independent, third-party profile of Wazo Switchboards API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.