Skip to main content
Server path: /genesys-voicemail | Type: Application | PCID required: Yes

Tools

ToolDescription
genesys_voicemail_delete_messageDelete a voicemail message.
genesys_voicemail_delete_messagesDelete all voicemail messages
genesys_voicemail_get_group_mailboxGet the group’s mailbox information
genesys_voicemail_get_group_messagesList voicemail messages
genesys_voicemail_get_group_policyGet a group’s voicemail policy
genesys_voicemail_get_mailboxGet the current user’s mailbox information
genesys_voicemail_get_me_mailboxGet the current user’s mailbox information
genesys_voicemail_get_me_messagesList voicemail messages
genesys_voicemail_get_me_policyGet the current user’s voicemail policy
genesys_voicemail_get_messageGet a voicemail message
genesys_voicemail_get_message_mediaGet media playback URI for this voicemail message
genesys_voicemail_get_messagesList voicemail messages
genesys_voicemail_get_policyGet a policy
genesys_voicemail_get_queue_messagesList voicemail messages
genesys_voicemail_get_user_mailboxGet a user’s mailbox information
genesys_voicemail_get_user_messagesList voicemail messages
genesys_voicemail_get_userpolicyGet a user’s voicemail policy
genesys_voicemail_patch_group_policyUpdate a group’s voicemail policy
genesys_voicemail_patch_me_policyUpdate the current user’s voicemail policy
genesys_voicemail_patch_messageUpdate a voicemail message
genesys_voicemail_patch_userpolicyUpdate a user’s voicemail policy
genesys_voicemail_post_messagesCopy a voicemail message to a user or group
genesys_voicemail_put_messageUpdate a voicemail message
genesys_voicemail_put_policyUpdate a policy
genesys_voicemail_put_userpolicyUpdate a user’s voicemail policy

genesys_voicemail_delete_message

Delete a voicemail message. Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesMessage ID

genesys_voicemail_delete_messages

Delete all voicemail messages

genesys_voicemail_get_group_mailbox

Get the group’s mailbox information Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesgroupId

genesys_voicemail_get_group_messages

List voicemail messages Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number

genesys_voicemail_get_group_policy

Get a group’s voicemail policy Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID

genesys_voicemail_get_mailbox

Get the current user’s mailbox information

genesys_voicemail_get_me_mailbox

Get the current user’s mailbox information

genesys_voicemail_get_me_messages

List voicemail messages Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size
pageNumberintegerNoPage number

genesys_voicemail_get_me_policy

Get the current user’s voicemail policy

genesys_voicemail_get_message

Get a voicemail message Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesMessage ID
expandany[]NoIf the caller is a known user, which fields, if any, to expand

genesys_voicemail_get_message_media

Get media playback URI for this voicemail message Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesMessage ID
formatIdstringNoThe desired media format.

genesys_voicemail_get_messages

List voicemail messages Parameters:
ParameterTypeRequiredDefaultDescription
idsstringNoAn optional comma separated list of VoicemailMessage ids
expandany[]NoIf the caller is a known user, which fields, if any, to expand

genesys_voicemail_get_policy

Get a policy

genesys_voicemail_get_queue_messages

List voicemail messages Parameters:
ParameterTypeRequiredDefaultDescription
queueIdstringYesQueue ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number

genesys_voicemail_get_user_mailbox

Get a user’s mailbox information Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId

genesys_voicemail_get_user_messages

List voicemail messages Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
pageSizeintegerNoPage size
pageNumberintegerNoPage number

genesys_voicemail_get_userpolicy

Get a user’s voicemail policy Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

genesys_voicemail_patch_group_policy

Update a group’s voicemail policy Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringYesGroup ID
disableEmailPiibooleanNoRemoves any PII from group emails. This is overridden by the analogous organization configuration value. This is always true if HIPAA is enabled or unknown for an organization.
emailPolicyobjectNoemailPolicy
enabledbooleanNoWhether voicemail is enabled for the group
groupobjectNogroup
groupAlertTypestringNoSpecifies if the members in this group should be contacted randomly, in a specific order, or by round-robin.
includeEmailTranscriptionsbooleanNoWhether to include the voicemail transcription in a group notification email
includeGroupNumberInUserCallerIdListsbooleanNoWhether the group phone number should be included in users’ caller id lists
interactiveResponsePromptIdstringNoThe prompt to use when connecting a user to a Group Ring call
interactiveResponseRequiredbooleanNoWhether user should be prompted with a confirmation prompt when connecting to a Group Ring call
languagePreferencestringNoThe language preference for the group. Used for group voicemail transcription
namestringNoname
overflowGroupIdstringNoA fallback group to contact when all of the members in this group did not answer the call.
rotateCallsSecsintegerNoHow many seconds to ring before rotating to the next member in the group
sendEmailNotificationsbooleanNoWhether email notifications are sent to group members when a new voicemail is received
stopRingingAfterRotationsintegerNoHow many rotations to go through

genesys_voicemail_patch_me_policy

Update the current user’s voicemail policy Parameters:
ParameterTypeRequiredDefaultDescription
alertTimeoutSecondsintegerNoThe number of seconds to ring the user’s phone before a call is transfered to voicemail
enabledbooleanNoWhether the user has voicemail enabled
modifiedDatestringNoThe date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
pinstringNoThe user’s PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security
sendEmailNotificationsbooleanNoWhether email notifications are sent to the user when a new voicemail is received

genesys_voicemail_patch_message

Update a voicemail message Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesMessage ID
audioRecordingDurationSecondsintegerNoThe voicemail message’s audio recording duration in seconds
audioRecordingSizeBytesintegerNoThe voicemail message’s audio recording size in bytes
callerAddressstringNoThe caller address
callerNamestringNoOptionally the name of the caller that left the voicemail message if the caller was a known user
callerUserobjectNocallerUser
conversationobjectNoconversation
copiedFromobjectNocopiedFrom
copiedToany[]NoRepresents where this voicemail has been copied to
createdDatestringNoThe date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
deletedbooleanNoWhether the voicemail message has been marked as deleted
deletedDatestringNoThe date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
deleteRetentionPolicyobjectNoGoverns how the voicemail is retained
groupobjectNogroup
idstringNoThe globally unique identifier for the object.
modifiedDatestringNoThe date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
notestringNoAn optional note
queueobjectNoqueue
readbooleanNoWhether the voicemail message is marked as read
selfUristringNoThe URI for this object
transcriptionstringNoThe transcription of the voicemail’s audio
userobjectNouser

genesys_voicemail_patch_userpolicy

Update a user’s voicemail policy Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
alertTimeoutSecondsintegerNoThe number of seconds to ring the user’s phone before a call is transfered to voicemail
enabledbooleanNoWhether the user has voicemail enabled
modifiedDatestringNoThe date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
pinstringNoThe user’s PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security
sendEmailNotificationsbooleanNoWhether email notifications are sent to the user when a new voicemail is received

genesys_voicemail_post_messages

Copy a voicemail message to a user or group Parameters:
ParameterTypeRequiredDefaultDescription
groupIdstringNoThe id of the Group to copy the VoicemailMessage to
userIdstringNoThe id of the User to copy the VoicemailMessage to
voicemailMessageIdstringNoThe id of the VoicemailMessage to copy

genesys_voicemail_put_message

Update a voicemail message Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesMessage ID
audioRecordingDurationSecondsintegerNoThe voicemail message’s audio recording duration in seconds
audioRecordingSizeBytesintegerNoThe voicemail message’s audio recording size in bytes
callerAddressstringNoThe caller address
callerNamestringNoOptionally the name of the caller that left the voicemail message if the caller was a known user
callerUserobjectNocallerUser
conversationobjectNoconversation
copiedFromobjectNocopiedFrom
copiedToany[]NoRepresents where this voicemail has been copied to
createdDatestringNoThe date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
deletedbooleanNoWhether the voicemail message has been marked as deleted
deletedDatestringNoThe date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
deleteRetentionPolicyobjectNoGoverns how the voicemail is retained
groupobjectNogroup
idstringNoThe globally unique identifier for the object.
modifiedDatestringNoThe date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
notestringNoAn optional note
queueobjectNoqueue
readbooleanNoWhether the voicemail message is marked as read
selfUristringNoThe URI for this object
transcriptionstringNoThe transcription of the voicemail’s audio
userobjectNouser

genesys_voicemail_put_policy

Update a policy Parameters:
ParameterTypeRequiredDefaultDescription
alertTimeoutSecondsintegerNoThe organization’s default number of seconds to ring a user’s phone before a call is transferred to voicemail
disableEmailPiibooleanNoRemoves any PII from emails. This overrides any analogous group configuration value. This is always true if HIPAA is enabled or unknown for an organization.
enabledbooleanNoWhether voicemail is enabled for this organization
includeEmailTranscriptionsbooleanNoWhether to include the voicemail transcription in the notification email
interactiveResponseRequiredbooleanNoWhether user should be prompted with a confirmation prompt when connecting to a Group Ring call
maximumRecordingTimeSecondsintegerNoDefault value for the maximum length of time in seconds of a recorded voicemail
modifiedDatestringNoThe date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
pinConfigurationobjectNopinConfiguration
pinRequiredbooleanNoIf this is true, a PIN is required when accessing a user’s voicemail from a phone.
sendEmailNotificationsbooleanNoWhether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting.
voicemailExtensionstringNoThe extension for voicemail retrieval. The default value is *86.

genesys_voicemail_put_userpolicy

Update a user’s voicemail policy Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
alertTimeoutSecondsintegerNoThe number of seconds to ring the user’s phone before a call is transfered to voicemail
enabledbooleanNoWhether the user has voicemail enabled
modifiedDatestringNoThe date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
pinstringNoThe user’s PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security
sendEmailNotificationsbooleanNoWhether email notifications are sent to the user when a new voicemail is received