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 Voicemails API

The voicemails API from Wazo — 20 operation(s) for voicemails.

Wazo Voicemails 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 Voicemails. 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 40 operations across 20 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

40 operations 20 paths 26 schemas 6 DELETE17 GET2 HEAD6 POST9 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 Voicemails 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 40

Across 20 paths, the API surfaces 40 operations — 6 DELETE, 17 GET, 2 HEAD, 6 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Voicemails 40
GET
/voicemails/messages
List all voicemail messages in a tenant
getVoicemailsMessages 12 params → 200400503
GET
/voicemails/{voicemail_id}
Get details of a voicemail
getVoicemailsByVoicemailId 2 params → 200400404503
PUT
/voicemails/{voicemail_id}
Update voicemail
update_voicemail 2 params body → 204400404
DELETE
/voicemails/{voicemail_id}
Delete voicemail
delete_voicemail 2 params → 204400404
GET
/voicemails/{voicemail_id}/folders/{folder_id}
Get details of a folder
getVoicemailsByVoicemailIdFoldersByFolderId 2 params → 200400404503
GET
/voicemails/{voicemail_id}/messages/{message_id}
Get a message
getVoicemailsByVoicemailIdMessagesByMessageId 2 params → 200400404503
PUT
/voicemails/{voicemail_id}/messages/{message_id}
Update a message
putVoicemailsByVoicemailIdMessagesByMessageId 2 params body → 204400404503
DELETE
/voicemails/{voicemail_id}/messages/{message_id}
Delete a mesage
deleteVoicemailsByVoicemailIdMessagesByMessageId 2 params → 204400404503
GET
/voicemails/{voicemail_id}/messages/{message_id}/recording
Get a message's recording
getVoicemailsByVoicemailIdMessagesByMessageIdRecording 4 params → 200400404503
POST
/voicemails/{voicemail_id}/greetings/{greeting}
Create a custom greeting
postVoicemailsByVoicemailIdGreetingsByGreeting 2 params body → 204400404503
HEAD
/voicemails/{voicemail_id}/greetings/{greeting}
Check if greeting exists
headVoicemailsByVoicemailIdGreetingsByGreeting 2 params → 200400404503
GET
/voicemails/{voicemail_id}/greetings/{greeting}
Get a custom greeting
getVoicemailsByVoicemailIdGreetingsByGreeting 2 params → 200400404503
PUT
/voicemails/{voicemail_id}/greetings/{greeting}
Update a custom greeting
putVoicemailsByVoicemailIdGreetingsByGreeting 2 params body → 204400404503
DELETE
/voicemails/{voicemail_id}/greetings/{greeting}
Delete a custom greeting
deleteVoicemailsByVoicemailIdGreetingsByGreeting 2 params → 204400404503
POST
/voicemails/{voicemail_id}/greetings/{greeting}/copy
Copy a custom greeting
postVoicemailsByVoicemailIdGreetingsByGreetingCopy 2 params body → 204400404503
GET
/users/me/voicemails
Get details of the voicemail of the authenticated user
getUsersMeVoicemails → 200400404503
GET
/users/me/voicemails/folders/{folder_id}
Get details of a folder
getUsersMeVoicemailsFoldersByFolderId 1 param → 200400404503
GET
/users/me/voicemails/messages
Get all user's messages
getUsersMeVoicemailsMessages 5 params → 200400404503
GET
/users/me/voicemails/messages/{message_id}
Get a message
getUsersMeVoicemailsMessagesByMessageId 1 param → 200400404503
PUT
/users/me/voicemails/messages/{message_id}
Update a message
putUsersMeVoicemailsMessagesByMessageId 1 param body → 204400404503
DELETE
/users/me/voicemails/messages/{message_id}
Delete a mesage
deleteUsersMeVoicemailsMessagesByMessageId 1 param → 204400404503
GET
/users/me/voicemails/messages/{message_id}/recording
Get a message's recording
getUsersMeVoicemailsMessagesByMessageIdRecording 3 params → 200400404503
POST
/users/me/voicemails/greetings/{greeting}
Create a custom greeting
postUsersMeVoicemailsGreetingsByGreeting 1 param body → 204400404503
HEAD
/users/me/voicemails/greetings/{greeting}
Check if greeting exists
headUsersMeVoicemailsGreetingsByGreeting 1 param → 200400404503
GET
/users/me/voicemails/greetings/{greeting}
Get a custom greeting
getUsersMeVoicemailsGreetingsByGreeting 1 param → 200400404503
PUT
/users/me/voicemails/greetings/{greeting}
Update a custom greeting
putUsersMeVoicemailsGreetingsByGreeting 1 param body → 204400404503
DELETE
/users/me/voicemails/greetings/{greeting}
Delete a custom greeting
deleteUsersMeVoicemailsGreetingsByGreeting 1 param → 204400404503
POST
/users/me/voicemails/greetings/{greeting}/copy
Copy a custom greeting
postUsersMeVoicemailsGreetingsByGreetingCopy 1 param body → 204400404503
POST
/users/{user_id}/voicemails
Create user voicemail
create_user_voicemail 2 params body → 201400404
GET
/users/{user_id}/voicemails
Get user voicemails
get_user_voicemail 2 params → 200404
DELETE
/users/{user_id}/voicemails
Dissociate user and voicemail
dissociate_user_voicemail 1 param → 204400404
PUT
/users/{user_id}/voicemails/{voicemail_id}
Associate user and voicemail
associate_user_voicemail 2 params → 204400404
GET
/voicemails
List voicemails
list_voicemails 7 params → 200
POST
/voicemails
Create voicemail
create_voicemail body → 201400
GET
/asterisk/voicemail/general
List Voicemail general options
list_asterisk_voicemail_general → 200
PUT
/asterisk/voicemail/general
Update Voicemail general option
update_asterisk_voicemail_general body → 204400404
GET
/voicemails/transcription
Retrieve the voicemail transcription configuration for the tenant
get_voicemail_transcription_config 1 param → 200404
PUT
/voicemails/transcription
Update the voicemail transcription configuration for the tenant
update_voicemail_transcription_config 1 param body → 204400404
GET
/asterisk/voicemail/zonemessages
List Voicemail zonemessages options
list_asterisk_voicemail_zonemessages → 200
PUT
/asterisk/voicemail/zonemessages
Update Voicemail zonemessages option
update_asterisk_voicemail_zonemessages body → 204400404

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are BaseVoicemail (15 properties), VoicemailMessageBase (6 properties), Voicemail (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.

VoicemailFolderBase
object
3 properties
GreetingCopy
object
1 property 1 required
VoicemailMessageVoicemail
object
3 properties
VoicemailMessageBase
object
6 properties
Error
object
Error message for the client
4 properties
VoicemailTranscription
object
1 property
VoicemailMessageUpdate
object
1 property 1 required
Voicemail
object
5 properties
AdminVoicemailMessage
object
AdminVoicemailMessages
object
3 properties
VoicemailFolder
object
VoicemailMessage
object
VoicemailMessages
object
2 properties
VoicemailTranscriptedMessageBase
object
VoicemailZoneMessages
object
1 property
VoicemailTranscriptionConfig
object
1 property 1 required
VoicemailRelationBase
object
2 properties
VoicemailItems
object
2 properties
UserRelationBase
object
3 properties
Voicemail_2
VoicemailZoneMessage
object
3 properties 2 required
KeyValueOption
array
Options must have the following form: { "options": [ ["option", "value"], ] }
VoicemailGeneral
object
Voicemail general configuration. This configuration will be in the file 'voicemail.conf' used by asterisk. Please consult the asterisk documentation for furthe…
1 property
Error_2
array
VoicemailRelationUsers
object
1 property
BaseVoicemail
object
15 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wazo-voicemails-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 Voicemails 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.