/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "Message ID"
}
},
"required": [
"PCID",
"messageId"
]
}
genesys_voicemail_delete_messages
Delete all voicemail messagesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_voicemail_get_group_mailbox
Get the group’s mailbox information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | Group Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group Id"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
}
},
"required": [
"PCID",
"groupId"
]
}
genesys_voicemail_get_group_policy
Get a group’s voicemail policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | Group ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
}
},
"required": [
"PCID",
"groupId"
]
}
genesys_voicemail_get_mailbox
Get the current user’s mailbox informationShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_voicemail_get_me_mailbox
Get the current user’s mailbox informationShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_voicemail_get_me_messages
List voicemail messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size |
pageNumber | integer | No | — | Page number |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
}
},
"required": [
"PCID"
]
}
genesys_voicemail_get_me_policy
Get the current user’s voicemail policyShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_voicemail_get_message
Get a voicemail message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | Message ID |
expand | string[] | No | — | If the caller is a known user, which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "Message ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"callerUser.routingStatus",
"callerUser.primaryPresence",
"callerUser.conversationSummary",
"callerUser.outOfOffice",
"callerUser.geolocation",
"conversations",
"transcription"
]
},
"description": "If the caller is a known user, which fields, if any, to expand"
}
},
"required": [
"PCID",
"messageId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "Message ID"
},
"formatId": {
"type": "string",
"description": "The desired media format.",
"enum": [
"WAV",
"WEBM",
"WAV_ULAW",
"OGG_VORBIS",
"OGG_OPUS",
"MP3",
"NONE"
]
}
},
"required": [
"PCID",
"messageId"
]
}
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 | string[] | No | — | If the caller is a known user, which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "An optional comma separated list of VoicemailMessage ids"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"callerUser.routingStatus",
"callerUser.primaryPresence",
"callerUser.conversationSummary",
"callerUser.outOfOffice",
"callerUser.geolocation",
"conversations",
"transcription"
]
},
"description": "If the caller is a known user, which fields, if any, to expand"
}
},
"required": [
"PCID"
]
}
genesys_voicemail_get_policy
Get a policyShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
genesys_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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"queueId": {
"type": "string",
"description": "Queue ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
}
},
"required": [
"PCID",
"queueId"
]
}
genesys_voicemail_get_user_mailbox
Get a user’s mailbox information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"pageSize": {
"type": "integer",
"description": "Page size"
},
"pageNumber": {
"type": "integer",
"description": "Page number"
}
},
"required": [
"PCID",
"userId"
]
}
genesys_voicemail_get_userpolicy
Get a user’s voicemail policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
}
},
"required": [
"PCID",
"userId"
]
}
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 | — | Email Policy |
enabled | boolean | No | — | Whether voicemail is enabled for the group |
group | object | No | — | The group value |
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 | — | The name value |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "Group ID"
},
"disableEmailPii": {
"type": "boolean",
"description": "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": {
"type": "object",
"description": "Email Policy",
"properties": {
"emailMembers": {
"type": "boolean",
"description": "Email Members"
},
"emailGroup": {
"type": "boolean",
"description": "Email Group"
}
}
},
"enabled": {
"type": "boolean",
"description": "Whether voicemail is enabled for the group"
},
"group": {
"type": "object",
"description": "The group value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The group name."
},
"description": {
"type": "string",
"description": "The description value"
},
"dateModified": {
"type": "string",
"description": "Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"memberCount": {
"type": "integer",
"description": "Number of members."
},
"state": {
"type": "string",
"description": "Active, inactive, or deleted state.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"version": {
"type": "integer",
"description": "Current version for this resource."
},
"type": {
"type": "string",
"description": "Type of group.",
"enum": [
"official",
"social"
]
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "The addresses value"
},
"rulesVisible": {
"type": "boolean",
"description": "Are membership rules visible to the person requesting to view the group"
},
"visibility": {
"type": "string",
"description": "Who can view this group",
"enum": [
"public",
"owners",
"members"
]
},
"rolesEnabled": {
"type": "boolean",
"description": "Allow roles to be assigned to this group"
},
"includeOwners": {
"type": "boolean",
"description": "Allow owners to be included as members of the group"
},
"callsEnabled": {
"type": "boolean",
"description": "Allow calls to be placed to this group."
},
"owners": {
"type": "array",
"items": {
"type": "object"
},
"description": "Owners of the group"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name",
"rulesVisible",
"type",
"visibility"
]
},
"groupAlertType": {
"type": "string",
"description": "Specifies if the members in this group should be contacted randomly, in a specific order, or by round-robin.",
"enum": [
"RANDOM",
"ROUND_ROBIN",
"SEQUENTIAL"
]
},
"includeEmailTranscriptions": {
"type": "boolean",
"description": "Whether to include the voicemail transcription in a group notification email"
},
"includeGroupNumberInUserCallerIdLists": {
"type": "boolean",
"description": "Whether the group phone number should be included in users' caller id lists"
},
"interactiveResponsePromptId": {
"type": "string",
"description": "The prompt to use when connecting a user to a Group Ring call"
},
"interactiveResponseRequired": {
"type": "boolean",
"description": "Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call"
},
"languagePreference": {
"type": "string",
"description": "The language preference for the group. Used for group voicemail transcription"
},
"name": {
"type": "string",
"description": "The name value"
},
"overflowGroupId": {
"type": "string",
"description": "A fallback group to contact when all of the members in this group did not answer the call."
},
"rotateCallsSecs": {
"type": "integer",
"description": "How many seconds to ring before rotating to the next member in the group"
},
"sendEmailNotifications": {
"type": "boolean",
"description": "Whether email notifications are sent to group members when a new voicemail is received"
},
"stopRingingAfterRotations": {
"type": "integer",
"description": "How many rotations to go through"
}
},
"required": [
"PCID",
"groupId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alertTimeoutSeconds": {
"type": "integer",
"description": "The number of seconds to ring the user's phone before a call is transfered to voicemail"
},
"enabled": {
"type": "boolean",
"description": "Whether the user has voicemail enabled"
},
"modifiedDate": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security"
},
"sendEmailNotifications": {
"type": "boolean",
"description": "Whether email notifications are sent to the user when a new voicemail is received"
}
},
"required": [
"PCID"
]
}
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 | — | Caller User |
conversation | object | No | — | The conversation value |
copiedFrom | object | No | — | Copied From |
copiedTo | object[] | 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 | — | The group value |
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 | — | The queue value |
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 | — | The user value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "Message ID"
},
"audioRecordingDurationSeconds": {
"type": "integer",
"description": "The voicemail message's audio recording duration in seconds"
},
"audioRecordingSizeBytes": {
"type": "integer",
"description": "The voicemail message's audio recording size in bytes"
},
"callerAddress": {
"type": "string",
"description": "The caller address"
},
"callerName": {
"type": "string",
"description": "Optionally the name of the caller that left the voicemail message if the caller was a known user"
},
"callerUser": {
"type": "object",
"description": "Caller User",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"conversation": {
"type": "object",
"description": "The conversation value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"externalTag": {
"type": "string",
"description": "The external tag associated with the conversation."
},
"startTime": {
"type": "string",
"description": "The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"endTime": {
"type": "string",
"description": "The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"address": {
"type": "string",
"description": "The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound."
},
"participants": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of all participants in the conversation."
},
"conversationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference."
},
"maxParticipants": {
"type": "integer",
"description": "If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."
},
"recordingState": {
"type": "string",
"description": "On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.",
"enum": [
"ACTIVE",
"PAUSED",
"NONE"
]
},
"state": {
"type": "string",
"description": "On update, 'disconnected' will disconnect the conversation. No other values are valid. When reading conversations, this field will never have a value present.",
"enum": [
"alerting",
"dialing",
"contacting",
"offering",
"connected",
"disconnected",
"terminated",
"converting",
"uploading",
"transmitting",
"parked",
"none"
]
},
"divisions": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers of divisions associated with this conversation"
},
"recentTransfers": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of the most recent 20 transfer commands applied to this conversation."
},
"securePause": {
"type": "boolean",
"description": "True when the recording of this conversation is in secure pause status."
},
"utilizationLabelId": {
"type": "string",
"description": "An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"
},
"inactivityTimeout": {
"type": "string",
"description": "The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"participants",
"startTime"
]
},
"copiedFrom": {
"type": "object",
"description": "Copied From",
"properties": {
"user": {
"type": "object",
"description": "The user value"
},
"group": {
"type": "object",
"description": "The group value"
},
"date": {
"type": "string",
"description": "The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
}
}
},
"copiedTo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"user": {
"type": "object",
"description": "The user value"
},
"group": {
"type": "object",
"description": "The group value"
},
"date": {
"type": "string",
"format": "date-time",
"description": "The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
}
}
},
"description": "Represents where this voicemail has been copied to"
},
"createdDate": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "Whether the voicemail message has been marked as deleted"
},
"deletedDate": {
"type": "string",
"description": "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": {
"type": "object",
"description": "Governs how the voicemail is retained",
"properties": {
"voicemailRetentionPolicyType": {
"type": "string",
"description": "The retention policy type",
"enum": [
"RETAIN_INDEFINITELY",
"RETAIN_WITH_TTL",
"IMMEDIATE_DELETE"
]
},
"numberOfDays": {
"type": "integer",
"description": "If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL"
}
}
},
"group": {
"type": "object",
"description": "The group value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The group name."
},
"description": {
"type": "string",
"description": "The description value"
},
"dateModified": {
"type": "string",
"description": "Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"memberCount": {
"type": "integer",
"description": "Number of members."
},
"state": {
"type": "string",
"description": "Active, inactive, or deleted state.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"version": {
"type": "integer",
"description": "Current version for this resource."
},
"type": {
"type": "string",
"description": "Type of group.",
"enum": [
"official",
"social"
]
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "The addresses value"
},
"rulesVisible": {
"type": "boolean",
"description": "Are membership rules visible to the person requesting to view the group"
},
"visibility": {
"type": "string",
"description": "Who can view this group",
"enum": [
"public",
"owners",
"members"
]
},
"rolesEnabled": {
"type": "boolean",
"description": "Allow roles to be assigned to this group"
},
"includeOwners": {
"type": "boolean",
"description": "Allow owners to be included as members of the group"
},
"callsEnabled": {
"type": "boolean",
"description": "Allow calls to be placed to this group."
},
"owners": {
"type": "array",
"items": {
"type": "object"
},
"description": "Owners of the group"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name",
"rulesVisible",
"type",
"visibility"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifiedDate": {
"type": "string",
"description": "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": {
"type": "string",
"description": "An optional note"
},
"queue": {
"type": "object",
"description": "The queue value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"description": {
"type": "string",
"description": "The queue description."
},
"dateCreated": {
"type": "string",
"description": "The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"modifiedBy": {
"type": "string",
"description": "The ID of the user that last modified the queue."
},
"createdBy": {
"type": "string",
"description": "The ID of the user that created the queue."
},
"memberCount": {
"type": "integer",
"description": "The total number of members in the queue."
},
"userMemberCount": {
"type": "integer",
"description": "The number of user members (i.e., non-group members) in the queue."
},
"joinedMemberCount": {
"type": "integer",
"description": "The number of joined members in the queue."
},
"mediaSettings": {
"type": "object",
"description": "Media Settings"
},
"routingRules": {
"type": "array",
"items": {
"type": "object"
},
"description": "The routing rules for the queue, used for Preferred Agent Routing."
},
"conditionalGroupRouting": {
"type": "object",
"description": "Conditional Group Routing"
},
"conditionalGroupActivation": {
"type": "object",
"description": "Conditional Group Activation"
},
"bullseye": {
"type": "object",
"description": "The bullseye value"
},
"scoringMethod": {
"type": "string",
"description": "The Scoring Method for the queue.",
"enum": [
"TimestampAndPriority",
"PriorityOnly"
]
},
"lastAgentRoutingMode": {
"type": "string",
"description": "The Last Agent Routing Mode for the queue.",
"enum": [
"Disabled",
"QueueMembersOnly",
"AnyAgent"
]
},
"acwSettings": {
"type": "object",
"description": "Acw Settings"
},
"skillEvaluationMethod": {
"type": "string",
"description": "The skill evaluation method to use when routing conversations.",
"enum": [
"NONE",
"BEST",
"ALL"
]
},
"memberGroups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes."
},
"queueFlow": {
"type": "object",
"description": "Queue Flow"
},
"emailInQueueFlow": {
"type": "object",
"description": "Email In Queue Flow"
},
"messageInQueueFlow": {
"type": "object",
"description": "Message In Queue Flow"
},
"whisperPrompt": {
"type": "object",
"description": "Whisper Prompt"
},
"onHoldPrompt": {
"type": "object",
"description": "On Hold Prompt"
},
"autoAnswerOnly": {
"type": "boolean",
"description": "Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."
},
"cannedResponseLibraries": {
"type": "object",
"description": "Canned Response Libraries"
},
"enableTranscription": {
"type": "boolean",
"description": "Indicates whether voice transcription is enabled for this queue."
},
"enableAudioMonitoring": {
"type": "boolean",
"description": "Indicates whether audio monitoring is enabled for this queue."
},
"enableManualAssignment": {
"type": "boolean",
"description": "Indicates whether manual assignment is enabled for this queue."
},
"agentOwnedRouting": {
"type": "object",
"description": "Agent Owned Routing"
},
"directRouting": {
"type": "object",
"description": "Direct Routing"
},
"callingPartyName": {
"type": "string",
"description": "The name to use for caller identification for outbound calls from this queue."
},
"callingPartyNumber": {
"type": "string",
"description": "The phone number to use for caller identification for outbound calls from this queue."
},
"defaultScripts": {
"type": "object",
"description": "The default script Ids for the communication types."
},
"outboundMessagingAddresses": {
"type": "object",
"description": "Outbound Messaging Addresses"
},
"outboundEmailAddress": {
"type": "object",
"description": "Outbound Email Address"
},
"peerId": {
"type": "string",
"description": "The ID of an associated external queue."
},
"suppressInQueueCallRecording": {
"type": "boolean",
"description": "Indicates whether recording in-queue calls is suppressed for this queue."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"read": {
"type": "boolean",
"description": "Whether the voicemail message is marked as read"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"transcription": {
"type": "string",
"description": "The transcription of the voicemail's audio"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
}
},
"required": [
"PCID",
"messageId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"alertTimeoutSeconds": {
"type": "integer",
"description": "The number of seconds to ring the user's phone before a call is transfered to voicemail"
},
"enabled": {
"type": "boolean",
"description": "Whether the user has voicemail enabled"
},
"modifiedDate": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security"
},
"sendEmailNotifications": {
"type": "boolean",
"description": "Whether email notifications are sent to the user when a new voicemail is received"
}
},
"required": [
"PCID",
"userId"
]
}
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 | Yes | — | The id of the VoicemailMessage to copy |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The id of the Group to copy the VoicemailMessage to"
},
"userId": {
"type": "string",
"description": "The id of the User to copy the VoicemailMessage to"
},
"voicemailMessageId": {
"type": "string",
"description": "The id of the VoicemailMessage to copy"
}
},
"required": [
"PCID",
"voicemailMessageId"
]
}
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 | — | Caller User |
conversation | object | No | — | The conversation value |
copiedFrom | object | No | — | Copied From |
copiedTo | object[] | 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 | — | The group value |
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 | — | The queue value |
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 | — | The user value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"messageId": {
"type": "string",
"description": "Message ID"
},
"audioRecordingDurationSeconds": {
"type": "integer",
"description": "The voicemail message's audio recording duration in seconds"
},
"audioRecordingSizeBytes": {
"type": "integer",
"description": "The voicemail message's audio recording size in bytes"
},
"callerAddress": {
"type": "string",
"description": "The caller address"
},
"callerName": {
"type": "string",
"description": "Optionally the name of the caller that left the voicemail message if the caller was a known user"
},
"callerUser": {
"type": "object",
"description": "Caller User",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"conversation": {
"type": "object",
"description": "The conversation value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"externalTag": {
"type": "string",
"description": "The external tag associated with the conversation."
},
"startTime": {
"type": "string",
"description": "The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"endTime": {
"type": "string",
"description": "The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"address": {
"type": "string",
"description": "The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound."
},
"participants": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of all participants in the conversation."
},
"conversationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference."
},
"maxParticipants": {
"type": "integer",
"description": "If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference."
},
"recordingState": {
"type": "string",
"description": "On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.",
"enum": [
"ACTIVE",
"PAUSED",
"NONE"
]
},
"state": {
"type": "string",
"description": "On update, 'disconnected' will disconnect the conversation. No other values are valid. When reading conversations, this field will never have a value present.",
"enum": [
"alerting",
"dialing",
"contacting",
"offering",
"connected",
"disconnected",
"terminated",
"converting",
"uploading",
"transmitting",
"parked",
"none"
]
},
"divisions": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers of divisions associated with this conversation"
},
"recentTransfers": {
"type": "array",
"items": {
"type": "object"
},
"description": "The list of the most recent 20 transfer commands applied to this conversation."
},
"securePause": {
"type": "boolean",
"description": "True when the recording of this conversation is in secure pause status."
},
"utilizationLabelId": {
"type": "string",
"description": "An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level"
},
"inactivityTimeout": {
"type": "string",
"description": "The time in the future, after which this conversation would be considered inactive. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"participants",
"startTime"
]
},
"copiedFrom": {
"type": "object",
"description": "Copied From",
"properties": {
"user": {
"type": "object",
"description": "The user value"
},
"group": {
"type": "object",
"description": "The group value"
},
"date": {
"type": "string",
"description": "The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
}
}
},
"copiedTo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"user": {
"type": "object",
"description": "The user value"
},
"group": {
"type": "object",
"description": "The group value"
},
"date": {
"type": "string",
"format": "date-time",
"description": "The date when the voicemail was copied. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
}
}
},
"description": "Represents where this voicemail has been copied to"
},
"createdDate": {
"type": "string",
"description": "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": {
"type": "boolean",
"description": "Whether the voicemail message has been marked as deleted"
},
"deletedDate": {
"type": "string",
"description": "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": {
"type": "object",
"description": "Governs how the voicemail is retained",
"properties": {
"voicemailRetentionPolicyType": {
"type": "string",
"description": "The retention policy type",
"enum": [
"RETAIN_INDEFINITELY",
"RETAIN_WITH_TTL",
"IMMEDIATE_DELETE"
]
},
"numberOfDays": {
"type": "integer",
"description": "If retentionPolicyType == RETAIN_WITH_TTL, then this value represents the number of days for the TTL"
}
}
},
"group": {
"type": "object",
"description": "The group value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The group name."
},
"description": {
"type": "string",
"description": "The description value"
},
"dateModified": {
"type": "string",
"description": "Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"memberCount": {
"type": "integer",
"description": "Number of members."
},
"state": {
"type": "string",
"description": "Active, inactive, or deleted state.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"version": {
"type": "integer",
"description": "Current version for this resource."
},
"type": {
"type": "string",
"description": "Type of group.",
"enum": [
"official",
"social"
]
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "The addresses value"
},
"rulesVisible": {
"type": "boolean",
"description": "Are membership rules visible to the person requesting to view the group"
},
"visibility": {
"type": "string",
"description": "Who can view this group",
"enum": [
"public",
"owners",
"members"
]
},
"rolesEnabled": {
"type": "boolean",
"description": "Allow roles to be assigned to this group"
},
"includeOwners": {
"type": "boolean",
"description": "Allow owners to be included as members of the group"
},
"callsEnabled": {
"type": "boolean",
"description": "Allow calls to be placed to this group."
},
"owners": {
"type": "array",
"items": {
"type": "object"
},
"description": "Owners of the group"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name",
"rulesVisible",
"type",
"visibility"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifiedDate": {
"type": "string",
"description": "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": {
"type": "string",
"description": "An optional note"
},
"queue": {
"type": "object",
"description": "The queue value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"description": {
"type": "string",
"description": "The queue description."
},
"dateCreated": {
"type": "string",
"description": "The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateModified": {
"type": "string",
"description": "The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"modifiedBy": {
"type": "string",
"description": "The ID of the user that last modified the queue."
},
"createdBy": {
"type": "string",
"description": "The ID of the user that created the queue."
},
"memberCount": {
"type": "integer",
"description": "The total number of members in the queue."
},
"userMemberCount": {
"type": "integer",
"description": "The number of user members (i.e., non-group members) in the queue."
},
"joinedMemberCount": {
"type": "integer",
"description": "The number of joined members in the queue."
},
"mediaSettings": {
"type": "object",
"description": "Media Settings"
},
"routingRules": {
"type": "array",
"items": {
"type": "object"
},
"description": "The routing rules for the queue, used for Preferred Agent Routing."
},
"conditionalGroupRouting": {
"type": "object",
"description": "Conditional Group Routing"
},
"conditionalGroupActivation": {
"type": "object",
"description": "Conditional Group Activation"
},
"bullseye": {
"type": "object",
"description": "The bullseye value"
},
"scoringMethod": {
"type": "string",
"description": "The Scoring Method for the queue.",
"enum": [
"TimestampAndPriority",
"PriorityOnly"
]
},
"lastAgentRoutingMode": {
"type": "string",
"description": "The Last Agent Routing Mode for the queue.",
"enum": [
"Disabled",
"QueueMembersOnly",
"AnyAgent"
]
},
"acwSettings": {
"type": "object",
"description": "Acw Settings"
},
"skillEvaluationMethod": {
"type": "string",
"description": "The skill evaluation method to use when routing conversations.",
"enum": [
"NONE",
"BEST",
"ALL"
]
},
"memberGroups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups of agents associated with the queue, if any. Queue membership will update to match group membership changes."
},
"queueFlow": {
"type": "object",
"description": "Queue Flow"
},
"emailInQueueFlow": {
"type": "object",
"description": "Email In Queue Flow"
},
"messageInQueueFlow": {
"type": "object",
"description": "Message In Queue Flow"
},
"whisperPrompt": {
"type": "object",
"description": "Whisper Prompt"
},
"onHoldPrompt": {
"type": "object",
"description": "On Hold Prompt"
},
"autoAnswerOnly": {
"type": "boolean",
"description": "Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered."
},
"cannedResponseLibraries": {
"type": "object",
"description": "Canned Response Libraries"
},
"enableTranscription": {
"type": "boolean",
"description": "Indicates whether voice transcription is enabled for this queue."
},
"enableAudioMonitoring": {
"type": "boolean",
"description": "Indicates whether audio monitoring is enabled for this queue."
},
"enableManualAssignment": {
"type": "boolean",
"description": "Indicates whether manual assignment is enabled for this queue."
},
"agentOwnedRouting": {
"type": "object",
"description": "Agent Owned Routing"
},
"directRouting": {
"type": "object",
"description": "Direct Routing"
},
"callingPartyName": {
"type": "string",
"description": "The name to use for caller identification for outbound calls from this queue."
},
"callingPartyNumber": {
"type": "string",
"description": "The phone number to use for caller identification for outbound calls from this queue."
},
"defaultScripts": {
"type": "object",
"description": "The default script Ids for the communication types."
},
"outboundMessagingAddresses": {
"type": "object",
"description": "Outbound Messaging Addresses"
},
"outboundEmailAddress": {
"type": "object",
"description": "Outbound Email Address"
},
"peerId": {
"type": "string",
"description": "The ID of an associated external queue."
},
"suppressInQueueCallRecording": {
"type": "boolean",
"description": "Indicates whether recording in-queue calls is suppressed for this queue."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"read": {
"type": "boolean",
"description": "Whether the voicemail message is marked as read"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"transcription": {
"type": "string",
"description": "The transcription of the voicemail's audio"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
}
},
"required": [
"PCID",
"messageId"
]
}
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 | — | Pin Configuration |
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alertTimeoutSeconds": {
"type": "integer",
"description": "The organization's default number of seconds to ring a user's phone before a call is transferred to voicemail"
},
"disableEmailPii": {
"type": "boolean",
"description": "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": {
"type": "boolean",
"description": "Whether voicemail is enabled for this organization"
},
"includeEmailTranscriptions": {
"type": "boolean",
"description": "Whether to include the voicemail transcription in the notification email"
},
"interactiveResponseRequired": {
"type": "boolean",
"description": "Whether user should be prompted with a confirmation prompt when connecting to a Group Ring call"
},
"maximumRecordingTimeSeconds": {
"type": "integer",
"description": "Default value for the maximum length of time in seconds of a recorded voicemail"
},
"modifiedDate": {
"type": "string",
"description": "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": {
"type": "object",
"description": "Pin Configuration",
"properties": {
"minimumLength": {
"type": "integer",
"description": "Minimum Length"
},
"maximumLength": {
"type": "integer",
"description": "Maximum Length"
}
}
},
"pinRequired": {
"type": "boolean",
"description": "If this is true, a PIN is required when accessing a user's voicemail from a phone."
},
"sendEmailNotifications": {
"type": "boolean",
"description": "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": {
"type": "string",
"description": "The extension for voicemail retrieval. The default value is *86."
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User ID"
},
"alertTimeoutSeconds": {
"type": "integer",
"description": "The number of seconds to ring the user's phone before a call is transfered to voicemail"
},
"enabled": {
"type": "boolean",
"description": "Whether the user has voicemail enabled"
},
"modifiedDate": {
"type": "string",
"description": "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": {
"type": "string",
"description": "The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security"
},
"sendEmailNotifications": {
"type": "boolean",
"description": "Whether email notifications are sent to the user when a new voicemail is received"
}
},
"required": [
"PCID",
"userId"
]
}