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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Voicemail API

Mailbox, messages, policy

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Voicemail API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Voicemail. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 27 operations across 16 paths, and defines 175 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, https://api.mypurecloud.com.

27 operations 16 paths 175 schemas 2 DELETE16 GET4 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Voicemail API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud_OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest_Chat_JWT).

Paths & Operations 27

Across 16 paths, the API surfaces 27 operations — 2 DELETE, 16 GET, 4 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Voicemail 27

Mailbox, messages, policy

GET
/api/v2/voicemail/groups/{groupId}/messages
List voicemail messages
getVoicemailGroupMessages 3 params → 200400401403404408409413
GET
/api/v2/voicemail/queues/{queueId}/messages
List voicemail messages
getVoicemailQueueMessages 3 params → 200400401403404408409413
GET
/api/v2/voicemail/users/{userId}/messages
List voicemail messages
getVoicemailUserMessages 3 params → 200400401403404408409413
GET
/api/v2/voicemail/groups/{groupId}/policy
Get a group's voicemail policy
getVoicemailGroupPolicy 1 param → 200400401403404408409413
PATCH
/api/v2/voicemail/groups/{groupId}/policy
Update a group's voicemail policy
patchVoicemailGroupPolicy 1 param body → 200400401403404408409413
GET
/api/v2/voicemail/mailbox
Get the current user's mailbox information
getVoicemailMailbox → 200400401403404408409413
GET
/api/v2/voicemail/me/mailbox
Get the current user's mailbox information
getVoicemailMeMailbox → 200400401403404408409413
GET
/api/v2/voicemail/groups/{groupId}/mailbox
Get the group's mailbox information
getVoicemailGroupMailbox 1 param → 200400401403404408409413
GET
/api/v2/voicemail/users/{userId}/mailbox
Get a user's mailbox information
getVoicemailUserMailbox 1 param → 200400401403404408409413
GET
/api/v2/voicemail/me/messages
List voicemail messages
getVoicemailMeMessages 2 params → 200400401403404408409413
GET
/api/v2/voicemail/me/policy
Get the current user's voicemail policy
getVoicemailMePolicy → 200400401403404408409413
PATCH
/api/v2/voicemail/me/policy
Update the current user's voicemail policy
patchVoicemailMePolicy body → 200400401403404408409413
GET
/api/v2/voicemail/messages/{messageId}
Get a voicemail message
getVoicemailMessage 2 params → 200400401403404408409413
PUT
/api/v2/voicemail/messages/{messageId}
Update a voicemail message
putVoicemailMessage 1 param body → 200400401403404408409413
DELETE
/api/v2/voicemail/messages/{messageId}
Delete a voicemail message
deleteVoicemailMessage 1 param → 200400401403404408409413
PATCH
/api/v2/voicemail/messages/{messageId}
Update a voicemail message
patchVoicemailMessage 1 param body → 200400401403404408409413
GET
/api/v2/voicemail/messages/{messageId}/media
Get media playback URI for this voicemail message
getVoicemailMessageMedia 2 params → 200400401403404408409413
GET
/api/v2/voicemail/messages
List voicemail messages
getVoicemailMessages 2 params → 200400401403404408409413
POST
/api/v2/voicemail/messages
Copy a voicemail message to a user or group
postVoicemailMessages body → 200400401403404408409413
DELETE
/api/v2/voicemail/messages
Delete all voicemail messages
deleteVoicemailMessages → 200400401403404408409413
GET
/api/v2/voicemail/policy
Get a policy
getVoicemailPolicy → 200400401403404408409413
PUT
/api/v2/voicemail/policy
Update a policy
putVoicemailPolicy body → 200400401403404408409413
GET
/api/v2/voicemail/userpolicies/{userId}
Get a user's voicemail policy
getVoicemailUserpolicy 1 param → 200400401403404408409413
PUT
/api/v2/voicemail/userpolicies/{userId}
Update a user's voicemail policy
putVoicemailUserpolicy 1 param body → 200400401403404408409413
PATCH
/api/v2/voicemail/userpolicies/{userId}
Update a user's voicemail policy
patchVoicemailUserpolicy 1 param body → 200400401403404408409413
GET
/api/v2/voicemail/search
Search voicemails using the q64 value returned from a previous search
getVoicemailSearch 2 params → 200400401403404408409413
POST
/api/v2/voicemail/search
Search voicemails
postVoicemailSearch body → 200400401403404408409413

Schemas 175

The contract defines 175 schemas that model the data the API accepts and returns. The most detailed are Participant (50 properties), Evaluation (43 properties), Queue (41 properties), User (39 properties). Each schema is shown below with its type and property counts.

ScoredAgent
object
2 properties
JourneyCustomer
object
2 properties 2 required
DomainEntityListingEvaluationForm
object
10 properties
JourneyActionMap
object
2 properties 2 required
AddressableEntityRef
object
2 properties
SocialExpression
object
20 properties
InternalMessageDetails
object
2 properties
PresenceDefinition
object
3 properties
CallbackMediaSettings
object
18 properties
DefaultAnswer
object
2 properties
QuestionGroupSettings
object
2 properties
TransferDestination
object
2 properties
AfterCallWork
object
3 properties
Wrapup
object
7 properties
DomainEntityRef
object
3 properties
ConversationMessageMetadataEvent
object
Metadata information about a message event.
2 properties
OutOfOffice
object
8 properties
Screenshare
object
16 properties
Participant
object
50 properties
MessageMedia
object
5 properties
JourneyCustomerSession
object
2 properties 2 required
MessageSubtypeSettings
object
2 properties
AiScoringSettings
object
3 properties
JourneyContext
object
3 properties 1 required
Voicemail
object
2 properties
Detail
object
4 properties
VisibilityCondition
object
2 properties
EmployerInfo
object
4 properties
TopicDuration
object
1 property
LocationImage
object
2 properties
UserStations
object
4 properties
User
object
39 properties 1 required
DirectRoutingMediaSettings
object
1 property
Location
object
5 properties
VoicemailGroupPolicy
object
15 properties
PagelessDomainEntityListingEvaluationVersion
object
3 properties
Callback
object
29 properties
EvaluationQuestionGroupScore
object
16 properties
Bullseye
object
1 property
MessageDetails
object
10 properties
ConditionalGroupActivationRule
object
3 properties
VoicemailRetentionPolicy
object
Governs how the voicemail is retained
2 properties
RoutingStatus
object
3 properties
ConversationRoutingData
object
8 properties
GroupContact
object
5 properties 3 required
LocationEmergencyNumber
object
3 properties
ConversationChat
object
22 properties
QueueMediaSettings
object
5 properties
Calibration
object
16 properties
InboundRoute
object
19 properties 2 required
Video
object
19 properties
EmailAddress
object
2 properties
Ring
object
3 properties
UserConversationSummary
object
8 properties
TransferResponseModifiedBy
object
2 properties
Actions
object
1 property
ConversationReference
object
2 properties
FaxStatus
object
8 properties
Message
object
33 properties
Biography
object
5 properties
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
PINConfiguration
object
2 properties
TransferInitiator
object
1 property
VoicemailMessageEntityListing
object
10 properties
Script
object
15 properties
LocationAddressVerificationDetails
object
4 properties
WritableDivision
object
3 properties
AgentOwnedRouting
object
3 properties
ConversationMessageMetadata
object
Metadata information about a message.
3 properties
Education
object
5 properties
QueueEmailAddress
object
2 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
AssistanceCondition
object
2 properties
ConditionalGroupActivationPilotRule
object
2 properties
VoicemailMailboxInfo
object
13 properties
Email
object
27 properties
EvaluationScoringSet
object
11 properties
DispositionParameters
object
1 property
ErrorBody
object
11 properties
RoutingRule
object
3 properties
DisconnectReason
object
4 properties
AiScoringSetting
object
1 property
MessageMediaSettings
object
8 properties
ConditionalGroupRouting
object
1 property
ConditionalGroupRoutingRule
object
6 properties
MediaSettings
object
5 properties
EvaluationQuestionGroup
object
12 properties
AnswerOption
object
6 properties
WorkPlanBidRanks
object
4 properties
EvaluationQuestion
object
14 properties
CopyVoicemailMessage
object
Used to copy a VoicemailMessage to either a User or a Group
3 properties 1 required
EvaluationReference
object
2 properties
UserAuthorization
object
4 properties
Evaluation
object
43 properties
Conversation
object
17 properties 2 required
ExpansionCriterium
object
2 properties
DefaultAnswersTo
object
4 properties
SkillsToRemove
object
3 properties
TransferResponse
object
7 properties
ServiceLevel
object
2 properties
JourneyAction
object
2 properties 2 required
UserPresence
object
10 properties
LocationDefinition
object
16 properties
QuestionSettings
object
2 properties
AiAnswer
object
3 properties
ConversationDivisionMembership
object
2 properties
EvaluationSettingsAssignee
object
2 properties
DivisionEntityRef
object
4 properties
Call
object
35 properties
VoicemailSearchCriteria
object
9 properties 1 required
Disposition
object
7 properties 1 required
Division
object
3 properties
LocationAddress
object
7 properties
TopicOffset
object
2 properties
Limit
object
3 properties
CannedResponseLibraries
object
2 properties
TranscriptTopic
object
9 properties
ScreenMonitoring
object
12 properties
Signature
object
4 properties
EvaluationVersion
object
3 properties
Chat
object
1 property
EvaluationSource
object
4 properties
DispositionSilentCallTimeout
object
3 properties
Segment
object
5 properties 2 required
ConversationMessageMetadataContent
object
Metadata information about a message content.
2 properties
VoicemailSearchRequest
object
7 properties
Page
object
8 properties
InternalMessage
object
15 properties
ConditionalGroupActivation
object
2 properties
MemberGroup
object
6 properties
MediaSummary
object
2 properties
AiScoring
object
3 properties
UserStation
object
8 properties
SearchSort
object
2 properties
Attachment
object
6 properties
Geolocation
object
11 properties
Contact
object
7 properties
ConversationQueueMediaSettings
object
4 properties
Team
object
8 properties 1 required
VoicemailMediaInfo
object
4 properties
Queue
object
41 properties
RecordersState
object
4 properties
GroupEmailPolicy
object
2 properties
EvaluationForm
object
12 properties 2 required
EvaluationQuestionScore
object
10 properties
EmailMediaSettings
object
5 properties
ConditionalGroupActivationSimpleMetric
object
2 properties
ResourcePermissionPolicy
object
11 properties
ErrorInfo
object
2 properties
Image
object
2 properties
DialerPreview
object
6 properties
ResourceConditionNode
object
5 properties
EvaluationSettings
object
4 properties
Address
object
5 properties
VoicemailMessage
object
21 properties
AdjustableLiveSpeakerDetection
object
6 properties
ResourceConditionValue
object
2 properties
OAuthLastTokenIssued
object
1 property
VoicemailOrganizationPolicy
object
11 properties
ConditionalGroupActivationCondition
object
3 properties
Cobrowsesession
object
19 properties
InactivityTimeoutSettings
object
3 properties
VoicemailsSearchResponse
object
9 properties 6 required
PhoneNumberColumn
object
3 properties
DomainRole
object
2 properties
VoicemailCopyRecord
object
3 properties
MediaSummaryDetail
object
2 properties
QueueMessagingAddresses
object
3 properties
DispositionAmdTimeout
object
4 properties
AcwSettings
object
2 properties
DirectRouting
object
6 properties
MessageSticker
object
2 properties
UserReferenceWithName
object
3 properties
Group
object
17 properties 4 required
VoicemailUserPolicy
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-voicemail-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
#Voicemail
← Back to G APIs
API Details
ID
genesys:genesys-voicemail-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-voicemail-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-voicemail-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Genesys Voicemail 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.