/genesys-voicemail | Type: Application | PCID required: Yes
Tools
genesys_voicemail_delete_message
Delete a voicemail message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message ID |
genesys_voicemail_delete_messages
Delete all voicemail messagesgenesys_voicemail_get_group_mailbox
Get the group’s mailbox information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | groupId |
genesys_voicemail_get_group_messages
List voicemail messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | Group ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
genesys_voicemail_get_group_policy
Get a group’s voicemail policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | Group ID |
genesys_voicemail_get_mailbox
Get the current user’s mailbox informationgenesys_voicemail_get_me_mailbox
Get the current user’s mailbox informationgenesys_voicemail_get_me_messages
List voicemail messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
genesys_voicemail_get_me_policy
Get the current user’s voicemail policygenesys_voicemail_get_message
Get a voicemail message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message ID |
expand | any[] | No | — | If 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message ID |
formatId | string | No | — | The desired media format. |
genesys_voicemail_get_messages
List voicemail messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string | No | — | An optional comma separated list of VoicemailMessage ids |
expand | any[] | No | — | If the caller is a known user, which fields, if any, to expand |
genesys_voicemail_get_policy
Get a policygenesys_voicemail_get_queue_messages
List voicemail messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
queueId | string | Yes | — | Queue ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
genesys_voicemail_get_user_mailbox
Get a user’s mailbox information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
genesys_voicemail_get_user_messages
List voicemail messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
genesys_voicemail_get_userpolicy
Get a user’s voicemail policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
genesys_voicemail_patch_group_policy
Update a group’s voicemail policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | Group ID |
disableEmailPii | boolean | No | — | Removes 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. |
emailPolicy | object | No | — | emailPolicy |
enabled | boolean | No | — | Whether voicemail is enabled for the group |
group | object | No | — | group |
groupAlertType | string | No | — | Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin. |
includeEmailTranscriptions | boolean | No | — | Whether to include the voicemail transcription in a group notification email |
includeGroupNumberInUserCallerIdLists | boolean | No | — | Whether the group phone number should be included in users’ caller id lists |
interactiveResponsePromptId | string | No | — | The prompt to use when connecting a user to a Group Ring call |
interactiveResponseRequired | boolean | No | — | Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call |
languagePreference | string | No | — | The language preference for the group. Used for group voicemail transcription |
name | string | No | — | name |
overflowGroupId | string | No | — | A fallback group to contact when all of the members in this group did not answer the call. |
rotateCallsSecs | integer | No | — | How many seconds to ring before rotating to the next member in the group |
sendEmailNotifications | boolean | No | — | Whether email notifications are sent to group members when a new voicemail is received |
stopRingingAfterRotations | integer | No | — | How many rotations to go through |
genesys_voicemail_patch_me_policy
Update the current user’s voicemail policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alertTimeoutSeconds | integer | No | — | The number of seconds to ring the user’s phone before a call is transfered to voicemail |
enabled | boolean | No | — | Whether the user has voicemail enabled |
modifiedDate | string | No | — | The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
pin | string | No | — | The user’s PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security |
sendEmailNotifications | boolean | No | — | Whether email notifications are sent to the user when a new voicemail is received |
genesys_voicemail_patch_message
Update a voicemail message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message ID |
audioRecordingDurationSeconds | integer | No | — | The voicemail message’s audio recording duration in seconds |
audioRecordingSizeBytes | integer | No | — | The voicemail message’s audio recording size in bytes |
callerAddress | string | No | — | The caller address |
callerName | string | No | — | Optionally the name of the caller that left the voicemail message if the caller was a known user |
callerUser | object | No | — | callerUser |
conversation | object | No | — | conversation |
copiedFrom | object | No | — | copiedFrom |
copiedTo | any[] | No | — | Represents where this voicemail has been copied to |
createdDate | string | No | — | The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
deleted | boolean | No | — | Whether the voicemail message has been marked as deleted |
deletedDate | string | No | — | The 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 |
deleteRetentionPolicy | object | No | — | Governs how the voicemail is retained |
group | object | No | — | group |
id | string | No | — | The globally unique identifier for the object. |
modifiedDate | string | No | — | The 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 |
note | string | No | — | An optional note |
queue | object | No | — | queue |
read | boolean | No | — | Whether the voicemail message is marked as read |
selfUri | string | No | — | The URI for this object |
transcription | string | No | — | The transcription of the voicemail’s audio |
user | object | No | — | user |
genesys_voicemail_patch_userpolicy
Update a user’s voicemail policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
alertTimeoutSeconds | integer | No | — | The number of seconds to ring the user’s phone before a call is transfered to voicemail |
enabled | boolean | No | — | Whether the user has voicemail enabled |
modifiedDate | string | No | — | The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
pin | string | No | — | The user’s PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security |
sendEmailNotifications | boolean | No | — | Whether 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | No | — | The id of the Group to copy the VoicemailMessage to |
userId | string | No | — | The id of the User to copy the VoicemailMessage to |
voicemailMessageId | string | No | — | The id of the VoicemailMessage to copy |
genesys_voicemail_put_message
Update a voicemail message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message ID |
audioRecordingDurationSeconds | integer | No | — | The voicemail message’s audio recording duration in seconds |
audioRecordingSizeBytes | integer | No | — | The voicemail message’s audio recording size in bytes |
callerAddress | string | No | — | The caller address |
callerName | string | No | — | Optionally the name of the caller that left the voicemail message if the caller was a known user |
callerUser | object | No | — | callerUser |
conversation | object | No | — | conversation |
copiedFrom | object | No | — | copiedFrom |
copiedTo | any[] | No | — | Represents where this voicemail has been copied to |
createdDate | string | No | — | The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
deleted | boolean | No | — | Whether the voicemail message has been marked as deleted |
deletedDate | string | No | — | The 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 |
deleteRetentionPolicy | object | No | — | Governs how the voicemail is retained |
group | object | No | — | group |
id | string | No | — | The globally unique identifier for the object. |
modifiedDate | string | No | — | The 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 |
note | string | No | — | An optional note |
queue | object | No | — | queue |
read | boolean | No | — | Whether the voicemail message is marked as read |
selfUri | string | No | — | The URI for this object |
transcription | string | No | — | The transcription of the voicemail’s audio |
user | object | No | — | user |
genesys_voicemail_put_policy
Update a policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alertTimeoutSeconds | integer | No | — | The organization’s default number of seconds to ring a user’s phone before a call is transferred to voicemail |
disableEmailPii | boolean | No | — | Removes any PII from emails. This overrides any analogous group configuration value. This is always true if HIPAA is enabled or unknown for an organization. |
enabled | boolean | No | — | Whether voicemail is enabled for this organization |
includeEmailTranscriptions | boolean | No | — | Whether to include the voicemail transcription in the notification email |
interactiveResponseRequired | boolean | No | — | Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call |
maximumRecordingTimeSeconds | integer | No | — | Default value for the maximum length of time in seconds of a recorded voicemail |
modifiedDate | string | No | — | The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
pinConfiguration | object | No | — | pinConfiguration |
pinRequired | boolean | No | — | If this is true, a PIN is required when accessing a user’s voicemail from a phone. |
sendEmailNotifications | boolean | No | — | Whether 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. |
voicemailExtension | string | No | — | The extension for voicemail retrieval. The default value is *86. |
genesys_voicemail_put_userpolicy
Update a user’s voicemail policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
alertTimeoutSeconds | integer | No | — | The number of seconds to ring the user’s phone before a call is transfered to voicemail |
enabled | boolean | No | — | Whether the user has voicemail enabled |
modifiedDate | string | No | — | The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
pin | string | No | — | The user’s PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security |
sendEmailNotifications | boolean | No | — | Whether email notifications are sent to the user when a new voicemail is received |

