genesys-conversations-digital - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /genesys-conversations-digital | Type: Application | PCID required: Yes

Tools

Tool	Description
`genesys_conversations_digital_delete_email_messages_draft_attachment`	Delete attachment from draft
`genesys_conversations_digital_get_cobrowsesession`	Get cobrowse conversation
`genesys_conversations_digital_get_cobrowsesessions`	Get active cobrowse conversations for the logged in user
`genesys_conversations_digital_get_email`	Get email conversation
`genesys_conversations_digital_get_email_message`	Get conversation message
`genesys_conversations_digital_get_email_messages`	Get conversation messages
`genesys_conversations_digital_get_email_messages_draft`	Get conversation draft reply
`genesys_conversations_digital_get_email_participant_communication_wrapup`	Get the wrap-up for this conversation communication.
`genesys_conversations_digital_get_email_participant_wrapup`	Get the wrap-up for this conversation participant.
`genesys_conversations_digital_get_email_participant_wrapupcodes`	Get list of wrapup codes for this conversation participant
`genesys_conversations_digital_get_email_settings`	Get emails settings for a given conversation
`genesys_conversations_digital_get_emails`	Get the logged-in user’s active conversations and their Email participants state.
`genesys_conversations_digital_get_internalmessage`	Get internal message conversation
`genesys_conversations_digital_get_internalmessages`	Get the logged-in user’s active conversations and their InternalMessage participants state.
`genesys_conversations_digital_get_message`	Get message conversation
`genesys_conversations_digital_get_message_communication_messages_media`	Get message media list by status
`genesys_conversations_digital_get_message_communication_messages_media_media_id`	Get media
`genesys_conversations_digital_get_message_details`	Get message
`genesys_conversations_digital_get_message_message`	Get conversation message
`genesys_conversations_digital_get_message_participant_communication_wrapup`	Get the wrap-up for this conversation communication.
`genesys_conversations_digital_get_message_participant_wrapup`	Get the wrap-up for this conversation participant.
`genesys_conversations_digital_get_message_participant_wrapupcodes`	Get list of wrapup codes for this conversation participant
`genesys_conversations_digital_get_messages`	Get the logged-in user’s active conversations and their Message participants state.
`genesys_conversations_digital_get_messaging_integrations`	Get a list of Integrations
`genesys_conversations_digital_get_social_participant_communication_wrapup`	Get the wrap-up for this conversation communication.
`genesys_conversations_digital_get_video_participant_communication_wrapup`	Get the wrap-up for this conversation communication.
`genesys_conversations_digital_get_videos_meeting`	Gets a record for a given meetingId
`genesys_conversations_digital_patch_email`	Update a conversation by disconnecting all of the participants
`genesys_conversations_digital_patch_email_messages_draft`	Reset conversation draft to its initial state and/or auto-fill draft content
`genesys_conversations_digital_patch_email_participant`	Update conversation participant
`genesys_conversations_digital_patch_email_participant_attributes`	Update the attributes on a conversation participant.
`genesys_conversations_digital_patch_email_participant_communication`	Update conversation participant’s communication by disconnecting it. This endpoint does not update wrapup.
`genesys_conversations_digital_patch_email_participant_parkingstate`	Update conversation by setting its parking state
`genesys_conversations_digital_patch_message`	Update a conversation by disconnecting all of the participants
`genesys_conversations_digital_patch_message_participant`	Update conversation participant
`genesys_conversations_digital_patch_message_participant_attributes`	Update the attributes on a conversation participant.
`genesys_conversations_digital_patch_message_participant_communication`	Update conversation participant’s communication by disconnecting it. This endpoint does not update wrapup.
`genesys_conversations_digital_post_email_inboundmessages`	Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.
`genesys_conversations_digital_post_email_messages`	Send an email reply
`genesys_conversations_digital_post_email_messages_draft_attachments_copy`	Copy attachments from an email message to the current draft.
`genesys_conversations_digital_post_email_participant_communication_wrapup`	Apply wrap-up for this conversation communication
`genesys_conversations_digital_post_email_participant_replace`	Replace this participant with the specified user and/or address
`genesys_conversations_digital_post_email_reconnect`	Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation
`genesys_conversations_digital_post_emails`	Create an email conversation
`genesys_conversations_digital_post_emails_agentless`	Create an email conversation, per API
`genesys_conversations_digital_post_faxes`	Create Fax Conversation
`genesys_conversations_digital_post_message_communication_messages`	Send message
`genesys_conversations_digital_post_message_communication_messages_media_uploads`	Create a URL to upload a message media file
`genesys_conversations_digital_post_message_communication_socialmedia_messages`	Send a social media message
`genesys_conversations_digital_post_message_communication_typing`	Send message typing event
`genesys_conversations_digital_post_message_inbound_open_event`	Send an inbound Open Event Message
`genesys_conversations_digital_post_message_inbound_open_message`	Send inbound Open Message
`genesys_conversations_digital_post_message_inbound_open_receipt`	Send an inbound Open Receipt Message
`genesys_conversations_digital_post_message_inbound_open_structured_response`	Send inbound Open Response
`genesys_conversations_digital_post_message_participant_communication_wrapup`	Apply wrap-up for this conversation communication
`genesys_conversations_digital_post_message_participant_monitor`	Listen in on the conversation from the point of view of a given participant.
`genesys_conversations_digital_post_message_participant_replace`	Replace this participant with the specified user and/or address
`genesys_conversations_digital_post_messages`	Create an outbound messaging conversation.
`genesys_conversations_digital_post_messages_agentless`	Send an agentless outbound message
`genesys_conversations_digital_post_social_participant_communication_wrapup`	Apply wrap-up for this conversation communication
`genesys_conversations_digital_post_video_participant_communication_wrapup`	Apply wrap-up for this conversation communication
`genesys_conversations_digital_post_videos_meetings`	Generate a meetingId for a given conferenceId
`genesys_conversations_digital_put_email_messages_draft`	Update conversation draft reply

genesys_conversations_digital_delete_email_messages_draft_attachment

Delete attachment from draft Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`attachmentId`	string	Yes	—	Attachment Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "attachmentId": {
      "type": "string",
      "description": "Attachment Id"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "attachmentId"
  ]
}

genesys_conversations_digital_get_cobrowsesession

Get cobrowse conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_get_cobrowsesessions

Get active cobrowse conversations for the logged in user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_digital_get_email

Get email conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_get_email_message

Get conversation message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`messageId`	string	Yes	—	Message Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "messageId": {
      "type": "string",
      "description": "Message Id"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "messageId"
  ]
}

genesys_conversations_digital_get_email_messages

Get conversation messages Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`includeAgentlessStitchedMessages`	boolean	No	—	Whether to include Agentless ‘api’ type of messages, on stitched conversations. If you provide a conversationId in the agentless email request (/api/v2/conversations/emails/agentless) that matches an existing conversation, then that’s a stitched agentless message.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "includeAgentlessStitchedMessages": {
      "type": "boolean",
      "description": "Whether to include Agentless 'api' type of messages, on stitched conversations. If you provide a conversationId in the agentless email request (/api/v2/conversations/emails/agentless) that matches an existing conversation, then that's a stitched agentless message."
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_get_email_messages_draft

Get conversation draft reply Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_get_email_participant_communication_wrapup

Get the wrap-up for this conversation communication. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`provisional`	boolean	No	—	Indicates whether or not to fetch provisional wrap-up code.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_get_email_participant_wrapup

Get the wrap-up for this conversation participant. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`provisional`	boolean	No	—	Indicates whether or not to fetch provisional wrap-up code.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_get_email_participant_wrapupcodes

Get list of wrapup codes for this conversation participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_get_email_settings

Get emails settings for a given conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_get_emails

Get the logged-in user’s active conversations and their Email participants state.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_digital_get_internalmessage

Get internal message conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_get_internalmessages

Get the logged-in user’s active conversations and their InternalMessage participants state.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_digital_get_message

Get message conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_get_message_communication_messages_media

Get message media list by status Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`communicationId`	string	Yes	—	Communication Id
`status`	string	No	—	The status on which to filter the response.
`pageNumber`	integer	No	—	Page number
`pageSize`	integer	No	—	Page size

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "status": {
      "type": "string",
      "description": "The status on which to filter the response.",
      "enum": [
        "uploading",
        "valid",
        "invalid"
      ]
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId"
  ]
}

genesys_conversations_digital_get_message_communication_messages_media_media_id

Get media Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`communicationId`	string	Yes	—	Communication Id
`mediaId`	string	Yes	—	Media Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "mediaId": {
      "type": "string",
      "description": "Media Id"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "mediaId"
  ]
}

genesys_conversations_digital_get_message_details

Get message Parameters:

Parameter	Type	Required	Default	Description
`messageId`	string	Yes	—	Message Id
`useNormalizedMessage`	boolean	No	—	If true, response removes deprecated fields (textBody, media)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "messageId": {
      "type": "string",
      "description": "Message Id"
    },
    "useNormalizedMessage": {
      "type": "boolean",
      "description": "If true, response removes deprecated fields (textBody, media)"
    }
  },
  "required": [
    "PCID",
    "messageId"
  ]
}

genesys_conversations_digital_get_message_message

Get conversation message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`messageId`	string	Yes	—	Message Id
`useNormalizedMessage`	boolean	No	—	If true, response removes deprecated fields (textBody, media)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "messageId": {
      "type": "string",
      "description": "Message Id"
    },
    "useNormalizedMessage": {
      "type": "boolean",
      "description": "If true, response removes deprecated fields (textBody, media)"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "messageId"
  ]
}

genesys_conversations_digital_get_message_participant_communication_wrapup

Get the wrap-up for this conversation communication. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`provisional`	boolean	No	—	Indicates whether or not to fetch provisional wrap-up code.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_get_message_participant_wrapup

Get the wrap-up for this conversation participant. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`provisional`	boolean	No	—	Indicates whether or not to fetch provisional wrap-up code.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_get_message_participant_wrapupcodes

Get list of wrapup codes for this conversation participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_get_messages

Get the logged-in user’s active conversations and their Message participants state.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_digital_get_messaging_integrations

Get a list of Integrations Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size
`pageNumber`	integer	No	—	Page number
`expand`	any[]	No	—	Expand instructions for the return value.
`supportedContent.id`	string	No	—	Filter integrations returned based on the supported content ID
`messagingSetting.id`	string	No	—	Filter integrations returned based on the setting ID

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"
    },
    "expand": {
      "type": "array",
      "description": "Expand instructions for the return value."
    },
    "supportedContent.id": {
      "type": "string",
      "description": "Filter integrations returned based on the supported content ID"
    },
    "messagingSetting.id": {
      "type": "string",
      "description": "Filter integrations returned based on the setting ID"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_digital_get_social_participant_communication_wrapup

Get the wrap-up for this conversation communication. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`provisional`	boolean	No	—	Indicates whether or not to fetch provisional wrap-up code.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_get_video_participant_communication_wrapup

Get the wrap-up for this conversation communication. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`provisional`	boolean	No	—	Indicates whether or not to fetch provisional wrap-up code.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_get_videos_meeting

Gets a record for a given meetingId Parameters:

Parameter	Type	Required	Default	Description
`meetingId`	string	Yes	—	Meeting Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "meetingId": {
      "type": "string",
      "description": "Meeting Id"
    }
  },
  "required": [
    "PCID",
    "meetingId"
  ]
}

genesys_conversations_digital_patch_email

Update a conversation by disconnecting all of the participants Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`address`	string	No	—	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.
`conversationIds`	any[]	No	—	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.
`divisions`	any[]	No	—	Identifiers of divisions associated with this conversation
`endTime`	string	No	—	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
`externalTag`	string	No	—	The external tag associated with the conversation.
`id`	string	No	—	The globally unique identifier for the object.
`inactivityTimeout`	string	No	—	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
`maxParticipants`	integer	No	—	If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.
`name`	string	No	—	The name value
`participants`	any[]	Yes	—	The list of all participants in the conversation.
`recentTransfers`	any[]	No	—	The list of the most recent 20 transfer commands applied to this conversation.
`recordingState`	string	No	—	On update, ‘paused’ initiates a secure pause, ‘active’ resumes any paused recordings; otherwise indicates state of conversation recording.
`securePause`	boolean	No	—	True when the recording of this conversation is in secure pause status.
`selfUri`	string	No	—	The URI for this object
`startTime`	string	Yes	—	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
`state`	string	No	—	On update, ‘disconnected’ will disconnect the conversation. No other values are valid. When reading conversations, this field will never have a value present.
`utilizationLabelId`	string	No	—	An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "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."
    },
    "conversationIds": {
      "type": "array",
      "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."
    },
    "divisions": {
      "type": "array",
      "description": "Identifiers of divisions associated with this conversation"
    },
    "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"
    },
    "externalTag": {
      "type": "string",
      "description": "The external tag associated with the conversation."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "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"
    },
    "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."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "participants": {
      "type": "array",
      "description": "The list of all participants in the conversation."
    },
    "recentTransfers": {
      "type": "array",
      "description": "The list of the most recent 20 transfer commands applied to this conversation."
    },
    "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"
      ]
    },
    "securePause": {
      "type": "boolean",
      "description": "True when the recording of this conversation is in secure pause status."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "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"
    },
    "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"
      ]
    },
    "utilizationLabelId": {
      "type": "string",
      "description": "An optional label that categorizes the conversation.  Max-utilization settings can be configured at a per-label level"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participants",
    "startTime"
  ]
}

genesys_conversations_digital_patch_email_messages_draft

Reset conversation draft to its initial state and/or auto-fill draft content Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`autoFill`	boolean	No	—	Auto Fill
`discard`	boolean	No	—	The discard value
`draftType`	string	No	—	The kind of draft that as to be treated. Used to prefix response subject or auto-include information
`translate`	object	No	—	The translate value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "autoFill": {
      "type": "boolean",
      "description": "Auto Fill"
    },
    "discard": {
      "type": "boolean",
      "description": "The discard value"
    },
    "draftType": {
      "type": "string",
      "description": "The kind of draft that as to be treated. Used to prefix response subject or auto-include information",
      "enum": [
        "Reply",
        "ReplyAll",
        "Forward"
      ]
    },
    "translate": {
      "type": "object",
      "description": "The translate value",
      "properties": {
        "from": {
          "type": "string",
          "description": "A translation for the word \"from\", for the expected language"
        },
        "to": {
          "type": "string",
          "description": "A translation for the word \"to\", for the expected language"
        },
        "cc": {
          "type": "string",
          "description": "A translation for the word \"cc\", for the expected language"
        },
        "subject": {
          "type": "string",
          "description": "A translation for the word \"subject\", for the expected language"
        },
        "replyPrefix": {
          "type": "string",
          "description": "A translation for the subject prefix \"Reply\", for the expected language"
        },
        "forwardPrefix": {
          "type": "string",
          "description": "A translation for the subject prefix \"Forward\", for the expected language"
        },
        "sent": {
          "type": "string",
          "description": "A translation for the word \"sent\", for the expected language"
        },
        "language": {
          "type": "string",
          "description": "The code of the expected language"
        },
        "timeZone": {
          "type": "string",
          "description": "Timezone used by the agent, used to format the sent email date and time. If not defined, will default to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London"
        }
      },
      "required": [
        "cc",
        "forwardPrefix",
        "from",
        "language",
        "replyPrefix",
        "sent",
        "subject",
        "to"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_patch_email_participant

Update conversation participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`confined`	boolean	No	—	True to confine this conversation participant. Should only be used for ad-hoc conferences
`held`	boolean	No	—	True to hold this conversation participant.
`muted`	boolean	No	—	True to mute this conversation participant.
`recording`	boolean	No	—	True to enable ad-hoc recording of this participant, otherwise false to disable recording.
`resumeTime`	string	No	—	Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	The wrapup value
`wrapupSkipped`	boolean	No	—	True to skip wrap-up for this participant.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "confined": {
      "type": "boolean",
      "description": "True to confine this conversation participant.  Should only be used for ad-hoc conferences"
    },
    "held": {
      "type": "boolean",
      "description": "True to hold this conversation participant."
    },
    "muted": {
      "type": "boolean",
      "description": "True to mute this conversation participant."
    },
    "recording": {
      "type": "boolean",
      "description": "True to enable ad-hoc recording of this participant, otherwise false to disable recording."
    },
    "resumeTime": {
      "type": "string",
      "description": "Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "state": {
      "type": "string",
      "description": "The state to update to set for this participant's communications.  Possible values are: 'connected' and 'disconnected'.",
      "enum": [
        "alerting",
        "dialing",
        "contacting",
        "offering",
        "connected",
        "disconnected",
        "terminated",
        "converting",
        "uploading",
        "transmitting",
        "parked",
        "none"
      ]
    },
    "wrapup": {
      "type": "object",
      "description": "The wrapup value",
      "properties": {
        "code": {
          "type": "string",
          "description": "The user configured wrap up code id."
        },
        "name": {
          "type": "string",
          "description": "The user configured wrap up code name."
        },
        "notes": {
          "type": "string",
          "description": "Text entered by the agent to describe the call or disposition."
        },
        "tags": {
          "type": "array",
          "description": "List of tags selected by the agent to describe the call or disposition."
        },
        "durationSeconds": {
          "type": "integer",
          "description": "The length of time in seconds that the agent spent doing after call work."
        },
        "endTime": {
          "type": "string",
          "description": "The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "provisional": {
          "type": "boolean",
          "description": "Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later."
        },
        "disableEndTimeUpdates": {
          "type": "boolean",
          "description": "Prevent updates to wrapup end time when set to true."
        }
      }
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_patch_email_participant_attributes

Update the attributes on a conversation participant. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`attributes`	object	No	—	The map of attribute keys to values.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "attributes": {
      "type": "object",
      "description": "The map of attribute keys to values."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_patch_email_participant_communication

Update conversation participant’s communication by disconnecting it. This endpoint does not update wrapup. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`confined`	boolean	No	—	True to confine this conversation participant. Should only be used for ad-hoc conferences
`held`	boolean	No	—	True to hold this conversation participant.
`muted`	boolean	No	—	True to mute this conversation participant.
`recording`	boolean	No	—	True to enable ad-hoc recording of this participant, otherwise false to disable recording.
`resumeTime`	string	No	—	Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	The wrapup value
`wrapupSkipped`	boolean	No	—	True to skip wrap-up for this participant.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "confined": {
      "type": "boolean",
      "description": "True to confine this conversation participant.  Should only be used for ad-hoc conferences"
    },
    "held": {
      "type": "boolean",
      "description": "True to hold this conversation participant."
    },
    "muted": {
      "type": "boolean",
      "description": "True to mute this conversation participant."
    },
    "recording": {
      "type": "boolean",
      "description": "True to enable ad-hoc recording of this participant, otherwise false to disable recording."
    },
    "resumeTime": {
      "type": "string",
      "description": "Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "state": {
      "type": "string",
      "description": "The state to update to set for this participant's communications.  Possible values are: 'connected' and 'disconnected'.",
      "enum": [
        "alerting",
        "dialing",
        "contacting",
        "offering",
        "connected",
        "disconnected",
        "terminated",
        "converting",
        "uploading",
        "transmitting",
        "parked",
        "none"
      ]
    },
    "wrapup": {
      "type": "object",
      "description": "The wrapup value",
      "properties": {
        "code": {
          "type": "string",
          "description": "The user configured wrap up code id."
        },
        "name": {
          "type": "string",
          "description": "The user configured wrap up code name."
        },
        "notes": {
          "type": "string",
          "description": "Text entered by the agent to describe the call or disposition."
        },
        "tags": {
          "type": "array",
          "description": "List of tags selected by the agent to describe the call or disposition."
        },
        "durationSeconds": {
          "type": "integer",
          "description": "The length of time in seconds that the agent spent doing after call work."
        },
        "endTime": {
          "type": "string",
          "description": "The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "provisional": {
          "type": "boolean",
          "description": "Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later."
        },
        "disableEndTimeUpdates": {
          "type": "boolean",
          "description": "Prevent updates to wrapup end time when set to true."
        }
      }
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_patch_email_participant_parkingstate

Update conversation by setting its parking state Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`resumeTime`	string	No	—	Timestamp for resume parked conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`state`	string	Yes	—	State to set the participant.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "resumeTime": {
      "type": "string",
      "description": "Timestamp for resume parked conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "state": {
      "type": "string",
      "description": "State to set the participant.",
      "enum": [
        "alerting",
        "dialing",
        "contacting",
        "offering",
        "connected",
        "disconnected",
        "terminated",
        "converting",
        "uploading",
        "transmitting",
        "parked",
        "none"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "state"
  ]
}

genesys_conversations_digital_patch_message

Update a conversation by disconnecting all of the participants Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`address`	string	No	—	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.
`conversationIds`	any[]	No	—	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.
`divisions`	any[]	No	—	Identifiers of divisions associated with this conversation
`endTime`	string	No	—	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
`externalTag`	string	No	—	The external tag associated with the conversation.
`id`	string	No	—	The globally unique identifier for the object.
`inactivityTimeout`	string	No	—	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
`maxParticipants`	integer	No	—	If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.
`name`	string	No	—	The name value
`participants`	any[]	Yes	—	The list of all participants in the conversation.
`recentTransfers`	any[]	No	—	The list of the most recent 20 transfer commands applied to this conversation.
`recordingState`	string	No	—	On update, ‘paused’ initiates a secure pause, ‘active’ resumes any paused recordings; otherwise indicates state of conversation recording.
`securePause`	boolean	No	—	True when the recording of this conversation is in secure pause status.
`selfUri`	string	No	—	The URI for this object
`startTime`	string	Yes	—	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
`state`	string	No	—	On update, ‘disconnected’ will disconnect the conversation. No other values are valid. When reading conversations, this field will never have a value present.
`utilizationLabelId`	string	No	—	An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "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."
    },
    "conversationIds": {
      "type": "array",
      "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."
    },
    "divisions": {
      "type": "array",
      "description": "Identifiers of divisions associated with this conversation"
    },
    "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"
    },
    "externalTag": {
      "type": "string",
      "description": "The external tag associated with the conversation."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "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"
    },
    "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."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "participants": {
      "type": "array",
      "description": "The list of all participants in the conversation."
    },
    "recentTransfers": {
      "type": "array",
      "description": "The list of the most recent 20 transfer commands applied to this conversation."
    },
    "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"
      ]
    },
    "securePause": {
      "type": "boolean",
      "description": "True when the recording of this conversation is in secure pause status."
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "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"
    },
    "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"
      ]
    },
    "utilizationLabelId": {
      "type": "string",
      "description": "An optional label that categorizes the conversation.  Max-utilization settings can be configured at a per-label level"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participants",
    "startTime"
  ]
}

genesys_conversations_digital_patch_message_participant

Update conversation participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`confined`	boolean	No	—	True to confine this conversation participant. Should only be used for ad-hoc conferences
`held`	boolean	No	—	True to hold this conversation participant.
`muted`	boolean	No	—	True to mute this conversation participant.
`recording`	boolean	No	—	True to enable ad-hoc recording of this participant, otherwise false to disable recording.
`resumeTime`	string	No	—	Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	The wrapup value
`wrapupSkipped`	boolean	No	—	True to skip wrap-up for this participant.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "confined": {
      "type": "boolean",
      "description": "True to confine this conversation participant.  Should only be used for ad-hoc conferences"
    },
    "held": {
      "type": "boolean",
      "description": "True to hold this conversation participant."
    },
    "muted": {
      "type": "boolean",
      "description": "True to mute this conversation participant."
    },
    "recording": {
      "type": "boolean",
      "description": "True to enable ad-hoc recording of this participant, otherwise false to disable recording."
    },
    "resumeTime": {
      "type": "string",
      "description": "Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "state": {
      "type": "string",
      "description": "The state to update to set for this participant's communications.  Possible values are: 'connected' and 'disconnected'.",
      "enum": [
        "alerting",
        "dialing",
        "contacting",
        "offering",
        "connected",
        "disconnected",
        "terminated",
        "converting",
        "uploading",
        "transmitting",
        "parked",
        "none"
      ]
    },
    "wrapup": {
      "type": "object",
      "description": "The wrapup value",
      "properties": {
        "code": {
          "type": "string",
          "description": "The user configured wrap up code id."
        },
        "name": {
          "type": "string",
          "description": "The user configured wrap up code name."
        },
        "notes": {
          "type": "string",
          "description": "Text entered by the agent to describe the call or disposition."
        },
        "tags": {
          "type": "array",
          "description": "List of tags selected by the agent to describe the call or disposition."
        },
        "durationSeconds": {
          "type": "integer",
          "description": "The length of time in seconds that the agent spent doing after call work."
        },
        "endTime": {
          "type": "string",
          "description": "The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "provisional": {
          "type": "boolean",
          "description": "Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later."
        },
        "disableEndTimeUpdates": {
          "type": "boolean",
          "description": "Prevent updates to wrapup end time when set to true."
        }
      }
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_patch_message_participant_attributes

Update the attributes on a conversation participant. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`attributes`	object	No	—	The map of attribute keys to values.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "attributes": {
      "type": "object",
      "description": "The map of attribute keys to values."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_patch_message_participant_communication

Update conversation participant’s communication by disconnecting it. This endpoint does not update wrapup. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`confined`	boolean	No	—	True to confine this conversation participant. Should only be used for ad-hoc conferences
`held`	boolean	No	—	True to hold this conversation participant.
`muted`	boolean	No	—	True to mute this conversation participant.
`recording`	boolean	No	—	True to enable ad-hoc recording of this participant, otherwise false to disable recording.
`resumeTime`	string	No	—	Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	The wrapup value
`wrapupSkipped`	boolean	No	—	True to skip wrap-up for this participant.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "confined": {
      "type": "boolean",
      "description": "True to confine this conversation participant.  Should only be used for ad-hoc conferences"
    },
    "held": {
      "type": "boolean",
      "description": "True to hold this conversation participant."
    },
    "muted": {
      "type": "boolean",
      "description": "True to mute this conversation participant."
    },
    "recording": {
      "type": "boolean",
      "description": "True to enable ad-hoc recording of this participant, otherwise false to disable recording."
    },
    "resumeTime": {
      "type": "string",
      "description": "Time to resume parked communication. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "state": {
      "type": "string",
      "description": "The state to update to set for this participant's communications.  Possible values are: 'connected' and 'disconnected'.",
      "enum": [
        "alerting",
        "dialing",
        "contacting",
        "offering",
        "connected",
        "disconnected",
        "terminated",
        "converting",
        "uploading",
        "transmitting",
        "parked",
        "none"
      ]
    },
    "wrapup": {
      "type": "object",
      "description": "The wrapup value",
      "properties": {
        "code": {
          "type": "string",
          "description": "The user configured wrap up code id."
        },
        "name": {
          "type": "string",
          "description": "The user configured wrap up code name."
        },
        "notes": {
          "type": "string",
          "description": "Text entered by the agent to describe the call or disposition."
        },
        "tags": {
          "type": "array",
          "description": "List of tags selected by the agent to describe the call or disposition."
        },
        "durationSeconds": {
          "type": "integer",
          "description": "The length of time in seconds that the agent spent doing after call work."
        },
        "endTime": {
          "type": "string",
          "description": "The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "provisional": {
          "type": "boolean",
          "description": "Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later."
        },
        "disableEndTimeUpdates": {
          "type": "boolean",
          "description": "Prevent updates to wrapup end time when set to true."
        }
      }
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_post_email_inboundmessages

Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`attributes`	object	No	—	The list of attributes to associate with the customer participant.
`flowId`	string	No	—	The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId
`fromAddress`	string	No	—	The email address of the sender of the email.
`fromName`	string	No	—	The name of the sender of the email.
`languageId`	string	No	—	The ID of the language to use for routing.
`priority`	integer	No	—	The priority to assign to the conversation for routing.
`provider`	string	Yes	—	The name of the provider that is sourcing the email such as Oracle, Salesforce, etc.
`queueId`	string	No	—	The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId
`skillIds`	any[]	No	—	The list of skill ID’s to use for routing.
`subject`	string	No	—	The subject of the email
`toAddress`	string	No	—	The email address of the recipient of the email.
`toName`	string	No	—	The name of the recipient of the email.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "attributes": {
      "type": "object",
      "description": "The list of attributes to associate with the customer participant."
    },
    "flowId": {
      "type": "string",
      "description": "The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"
    },
    "fromAddress": {
      "type": "string",
      "description": "The email address of the sender of the email."
    },
    "fromName": {
      "type": "string",
      "description": "The name of the sender of the email."
    },
    "languageId": {
      "type": "string",
      "description": "The ID of the language to use for routing."
    },
    "priority": {
      "type": "integer",
      "description": "The priority to assign to the conversation for routing."
    },
    "provider": {
      "type": "string",
      "description": "The name of the provider that is sourcing the email such as Oracle, Salesforce, etc."
    },
    "queueId": {
      "type": "string",
      "description": "The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"
    },
    "skillIds": {
      "type": "array",
      "description": "The list of skill ID's to use for routing."
    },
    "subject": {
      "type": "string",
      "description": "The subject of the email"
    },
    "toAddress": {
      "type": "string",
      "description": "The email address of the recipient of the email."
    },
    "toName": {
      "type": "string",
      "description": "The name of the recipient of the email."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "provider"
  ]
}

genesys_conversations_digital_post_email_messages

Send an email reply Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`attachments`	any[]	No	—	The attachments of the email message.
`bcc`	any[]	No	—	The recipients that were blind copied on the email message.
`cc`	any[]	No	—	The recipients that were copied on the email message.
`draftType`	string	No	—	The type of draft that need to be treated.
`emailSizeBytes`	integer	No	—	Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form.
`from`	object	Yes	—	The from value
`historyIncluded`	boolean	No	—	Indicates whether the history of previous emails of the conversation is included within the email bodies of this message.
`htmlBody`	string	No	—	The html body of the email message.
`id`	string	No	—	The globally unique identifier for the object.
`maxEmailSizeBytes`	integer	No	—	Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration
`name`	string	No	—	The name value
`replyTo`	object	No	—	Reply To
`selfUri`	string	No	—	The URI for this object
`state`	string	No	—	The state of the current draft.
`subject`	string	No	—	The subject of the email message.
`textBody`	string	Yes	—	The text body of the email message.
`time`	string	No	—	The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`to`	any[]	Yes	—	The recipients of the email message.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "attachments": {
      "type": "array",
      "description": "The attachments of the email message."
    },
    "bcc": {
      "type": "array",
      "description": "The recipients that were blind copied on the email message."
    },
    "cc": {
      "type": "array",
      "description": "The recipients that were copied on the email message."
    },
    "draftType": {
      "type": "string",
      "description": "The type of draft that need to be treated.",
      "enum": [
        "Reply",
        "ReplyAll",
        "Forward"
      ]
    },
    "emailSizeBytes": {
      "type": "integer",
      "description": "Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form."
    },
    "from": {
      "type": "object",
      "description": "The from value",
      "properties": {
        "email": {
          "type": "string",
          "description": "The email value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "historyIncluded": {
      "type": "boolean",
      "description": "Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."
    },
    "htmlBody": {
      "type": "string",
      "description": "The html body of the email message."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "maxEmailSizeBytes": {
      "type": "integer",
      "description": "Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "replyTo": {
      "type": "object",
      "description": "Reply To",
      "properties": {
        "email": {
          "type": "string",
          "description": "The email value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "state": {
      "type": "string",
      "description": "The state of the current draft.",
      "enum": [
        "Created",
        "Ready",
        "Edited"
      ]
    },
    "subject": {
      "type": "string",
      "description": "The subject of the email message."
    },
    "textBody": {
      "type": "string",
      "description": "The text body of the email message."
    },
    "time": {
      "type": "string",
      "description": "The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "to": {
      "type": "array",
      "description": "The recipients of the email message."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "from",
    "textBody",
    "to"
  ]
}

genesys_conversations_digital_post_email_messages_draft_attachments_copy

Copy attachments from an email message to the current draft. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`attachments`	any[]	Yes	—	A list of attachments that will be copied from the source message to the current draft
`sourceMessage`	object	Yes	—	Source Message

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "attachments": {
      "type": "array",
      "description": "A list of attachments that will be copied from the source message to the current draft"
    },
    "sourceMessage": {
      "type": "object",
      "description": "Source Message",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        },
        "selfUri": {
          "type": "string",
          "description": "Self Uri"
        }
      }
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "attachments",
    "sourceMessage"
  ]
}

genesys_conversations_digital_post_email_participant_communication_wrapup

Apply wrap-up for this conversation communication Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`code`	string	No	—	The user configured wrap up code id.
`disableEndTimeUpdates`	boolean	No	—	Prevent updates to wrapup end time when set to true.
`durationSeconds`	integer	No	—	The length of time in seconds that the agent spent doing after call work.
`endTime`	string	No	—	The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	No	—	The user configured wrap up code name.
`notes`	string	No	—	Text entered by the agent to describe the call or disposition.
`provisional`	boolean	No	—	Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later.
`tags`	any[]	No	—	List of tags selected by the agent to describe the call or disposition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "code": {
      "type": "string",
      "description": "The user configured wrap up code id."
    },
    "disableEndTimeUpdates": {
      "type": "boolean",
      "description": "Prevent updates to wrapup end time when set to true."
    },
    "durationSeconds": {
      "type": "integer",
      "description": "The length of time in seconds that the agent spent doing after call work."
    },
    "endTime": {
      "type": "string",
      "description": "The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "name": {
      "type": "string",
      "description": "The user configured wrap up code name."
    },
    "notes": {
      "type": "string",
      "description": "Text entered by the agent to describe the call or disposition."
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later."
    },
    "tags": {
      "type": "array",
      "description": "List of tags selected by the agent to describe the call or disposition."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_post_email_participant_replace

Replace this participant with the specified user and/or address Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`address`	string	No	—	The user ID or queue ID of the transfer target. Address like a phone number can not be used for callbacks, but they can be used for other forms of communication.
`keepInternalMessageAlive`	boolean	No	—	If true, the digital internal message will NOT be terminated.
`queueId`	string	No	—	The queue ID of the transfer target.
`transferType`	string	No	—	The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.
`userId`	string	No	—	The user ID of the transfer target.
`userName`	string	No	—	The user name of the transfer target.
`voicemail`	boolean	No	—	If true, transfer to the voicemail inbox of the participant that is being replaced.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "address": {
      "type": "string",
      "description": "The user ID or queue ID of the transfer target. Address like a phone number can not be used for callbacks, but they can be used for other forms of communication."
    },
    "keepInternalMessageAlive": {
      "type": "boolean",
      "description": "If true, the digital internal message will NOT be terminated."
    },
    "queueId": {
      "type": "string",
      "description": "The queue ID of the transfer target."
    },
    "transferType": {
      "type": "string",
      "description": "The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.",
      "enum": [
        "Attended",
        "Unattended"
      ]
    },
    "userId": {
      "type": "string",
      "description": "The user ID of the transfer target."
    },
    "userName": {
      "type": "string",
      "description": "The user name of the transfer target."
    },
    "voicemail": {
      "type": "boolean",
      "description": "If true, transfer to the voicemail inbox of the participant that is being replaced."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_post_email_reconnect

Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_digital_post_emails

Create an email conversation Parameters:

Parameter	Type	Required	Default	Description
`attributes`	object	No	—	The list of attributes to associate with the customer participant.
`direction`	string	No	—	Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based.
`externalContactId`	string	No	—	The external contact with which the email should be associated. This field is only valid for OUTBOUND email.
`flowId`	string	No	—	The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId
`fromAddress`	string	No	—	The email address of the sender of the email.
`fromName`	string	No	—	The name of the sender of the email.
`htmlBody`	string	No	—	An HTML body content of the email.
`languageId`	string	No	—	The ID of the language to use for routing.
`priority`	integer	No	—	The priority to assign to the conversation for routing.
`provider`	string	Yes	—	The name of the provider that is sourcing the emails. The Provider “PureCloud Email” is reserved for native emails.
`queueId`	string	No	—	The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId
`skillIds`	any[]	No	—	The list of skill ID’s to use for routing.
`subject`	string	No	—	The subject of the email
`textBody`	string	No	—	A text body content of the email.
`toAddress`	string	No	—	The email address of the recipient of the email.
`toName`	string	No	—	The name of the recipient of the email.
`utilizationLabel`	string	No	—	Optional. The ID of the label to controls the number of agent interactions for INBOUND communications

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attributes": {
      "type": "object",
      "description": "The list of attributes to associate with the customer participant."
    },
    "direction": {
      "type": "string",
      "description": "Specify OUTBOUND to send an email on behalf of a queue, or INBOUND to create an external conversation. An external conversation is one where the provider is not PureCloud based.",
      "enum": [
        "OUTBOUND",
        "INBOUND"
      ]
    },
    "externalContactId": {
      "type": "string",
      "description": "The external contact with which the email should be associated. This field is only valid for OUTBOUND email."
    },
    "flowId": {
      "type": "string",
      "description": "The ID of the flow to use for routing email conversation. This field is mutually exclusive with queueId"
    },
    "fromAddress": {
      "type": "string",
      "description": "The email address of the sender of the email."
    },
    "fromName": {
      "type": "string",
      "description": "The name of the sender of the email."
    },
    "htmlBody": {
      "type": "string",
      "description": "An HTML body content of the email."
    },
    "languageId": {
      "type": "string",
      "description": "The ID of the language to use for routing."
    },
    "priority": {
      "type": "integer",
      "description": "The priority to assign to the conversation for routing."
    },
    "provider": {
      "type": "string",
      "description": "The name of the provider that is sourcing the emails. The Provider \"PureCloud Email\" is reserved for native emails."
    },
    "queueId": {
      "type": "string",
      "description": "The ID of the queue to use for routing the email conversation. This field is mutually exclusive with flowId"
    },
    "skillIds": {
      "type": "array",
      "description": "The list of skill ID's to use for routing."
    },
    "subject": {
      "type": "string",
      "description": "The subject of the email"
    },
    "textBody": {
      "type": "string",
      "description": "A text body content of the email."
    },
    "toAddress": {
      "type": "string",
      "description": "The email address of the recipient of the email."
    },
    "toName": {
      "type": "string",
      "description": "The name of the recipient of the email."
    },
    "utilizationLabel": {
      "type": "string",
      "description": "Optional. The ID of the label to controls the number of agent interactions for INBOUND communications"
    }
  },
  "required": [
    "PCID",
    "provider"
  ]
}

genesys_conversations_digital_post_emails_agentless

Create an email conversation, per API Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	No	—	The identifier of the conversation. This must be an email interaction.
`fromAddress`	object	Yes	—	From Address
`htmlBody`	string	No	—	The Content of the message, in HTML. Links, images and styles are allowed
`replyToAddress`	object	No	—	Reply To Address
`senderType`	string	Yes	—	The type of email domain used to send the agentless message.
`subject`	string	No	—	The subject of the message.
`textBody`	string	No	—	The Content of the message, in plain text.
`toAddresses`	any[]	Yes	—	The recipient of the message. We currently support one recipient only.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The identifier of the conversation. This must be an email interaction."
    },
    "fromAddress": {
      "type": "object",
      "description": "From Address",
      "properties": {
        "email": {
          "type": "string",
          "description": "The email value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "htmlBody": {
      "type": "string",
      "description": "The Content of the message, in HTML. Links, images and styles are allowed"
    },
    "replyToAddress": {
      "type": "object",
      "description": "Reply To Address",
      "properties": {
        "email": {
          "type": "string",
          "description": "The email value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "senderType": {
      "type": "string",
      "description": "The type of email domain used to send the agentless message.",
      "enum": [
        "Outbound"
      ]
    },
    "subject": {
      "type": "string",
      "description": "The subject of the message."
    },
    "textBody": {
      "type": "string",
      "description": "The Content of the message, in plain text."
    },
    "toAddresses": {
      "type": "array",
      "description": "The recipient of the message. We currently support one recipient only."
    }
  },
  "required": [
    "PCID",
    "fromAddress",
    "senderType",
    "toAddresses"
  ]
}

genesys_conversations_digital_post_faxes

Create Fax Conversation Parameters:

Parameter	Type	Required	Default	Description
`addresses`	any[]	Yes	—	A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555
`contentType`	string	No	—	The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored
`coverSheet`	object	No	—	Cover Sheet
`documentId`	string	No	—	DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null
`id`	string	No	—	The globally unique identifier for the object.
`name`	string	No	—	The name value
`selfUri`	string	No	—	The URI for this object
`timeZoneOffsetMinutes`	integer	No	—	Time zone offset minutes from GMT
`workspace`	object	No	—	The workspace value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "addresses": {
      "type": "array",
      "description": "A list of outbound fax dialing addresses. E.g. +13175555555 or 3175555555"
    },
    "contentType": {
      "type": "string",
      "description": "The content type that is going to be uploaded. If Content Management document is used for faxing, contentType will be ignored",
      "enum": [
        "application/pdf",
        "image/tiff",
        "application/msword",
        "application/vnd.oasis.opendocument.text",
        "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
      ]
    },
    "coverSheet": {
      "type": "object",
      "description": "Cover Sheet",
      "properties": {
        "notes": {
          "type": "string",
          "description": "Text to be added to the coversheet"
        },
        "locale": {
          "type": "string",
          "description": "Locale, e.g. = en-US"
        }
      }
    },
    "documentId": {
      "type": "string",
      "description": "DocumentId of Content Management artifact. If Content Management document is not used for faxing, documentId should be null"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "timeZoneOffsetMinutes": {
      "type": "integer",
      "description": "Time zone offset minutes from GMT"
    },
    "workspace": {
      "type": "object",
      "description": "The workspace value",
      "properties": {
        "id": {
          "type": "string",
          "description": "The globally unique identifier for the object."
        },
        "name": {
          "type": "string",
          "description": "The current name of the workspace."
        },
        "type": {
          "type": "string",
          "description": "The type value"
        },
        "isCurrentUserWorkspace": {
          "type": "boolean",
          "description": "Is Current User Workspace"
        },
        "user": {
          "type": "object",
          "description": "The user value"
        },
        "bucket": {
          "type": "string",
          "description": "The bucket value"
        },
        "dateCreated": {
          "type": "string",
          "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "dateModified": {
          "type": "string",
          "description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "summary": {
          "type": "object",
          "description": "The summary value"
        },
        "acl": {
          "type": "array",
          "description": "The acl value"
        },
        "description": {
          "type": "string",
          "description": "The description value"
        },
        "selfUri": {
          "type": "string",
          "description": "The URI for this object"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "addresses"
  ]
}

genesys_conversations_digital_post_message_communication_messages

Send message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`communicationId`	string	Yes	—	Communication Id
`useNormalizedMessage`	boolean	No	—	If true, response removes deprecated fields (textBody, media)
`mediaIds`	any[]	No	—	The media ids associated with the text message. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
`messagingTemplate`	object	No	—	Messaging Template
`textBody`	string	Yes	—	The body of the text message. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "useNormalizedMessage": {
      "type": "boolean",
      "description": "If true, response removes deprecated fields (textBody, media)"
    },
    "mediaIds": {
      "type": "array",
      "description": "The media ids associated with the text message. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage."
    },
    "messagingTemplate": {
      "type": "object",
      "description": "Messaging Template",
      "properties": {
        "responseId": {
          "type": "string",
          "description": "Unique identifier for a Response Management response to fetch and apply pre-configured message content when sending outbound responses."
        },
        "parameters": {
          "type": "array",
          "description": "A list of Response Management response substitutions for the response's messaging template. (Deprecated) use bodyParameters instead."
        },
        "headerParameters": {
          "type": "array",
          "description": "A list of Response Management header parameter substitutions for the response's messaging template"
        },
        "bodyParameters": {
          "type": "array",
          "description": "A list of Response Management body parameter substitutions for the response's messaging template"
        },
        "buttonUrlParameters": {
          "type": "array",
          "description": "A list of Response Management button url parameter substitutions for the response's messaging template"
        },
        "carouselParameters": {
          "type": "object",
          "description": "Template parameters for carousel components"
        }
      }
    },
    "textBody": {
      "type": "string",
      "description": "The body of the text message.  Maximum character counts are: SMS - 765 characters, other channels - 2000 characters."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "textBody"
  ]
}

genesys_conversations_digital_post_message_communication_messages_media_uploads

Create a URL to upload a message media file Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`communicationId`	string	Yes	—	Communication Id
`contentLengthBytes`	integer	Yes	—	The length of the file to upload in bytes
`contentMd5`	string	No	—	Content MD5 of the file to upload
`fileName`	string	Yes	—	Name of the media file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: {^}%`]”>[~<#\|

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "contentLengthBytes": {
      "type": "integer",
      "description": "The length of the file to upload in bytes"
    },
    "contentMd5": {
      "type": "string",
      "description": "Content MD5 of the file to upload"
    },
    "fileName": {
      "type": "string",
      "description": "Name of the media file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#|"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "contentLengthBytes",
    "fileName"
  ]
}

genesys_conversations_digital_post_message_communication_socialmedia_messages

Send a social media message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`communicationId`	string	Yes	—	Communication Id
`inReplyToMessageId`	string	Yes	—	The ID of the message to which this request is replying.
`mediaIds`	any[]	No	—	The media ids associated with the text message. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.
`textBody`	string	No	—	The body of the text message. Maximum character count is 2000 characters.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "inReplyToMessageId": {
      "type": "string",
      "description": "The ID of the message to which this request is replying."
    },
    "mediaIds": {
      "type": "array",
      "description": "The media ids associated with the text message. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage."
    },
    "textBody": {
      "type": "string",
      "description": "The body of the text message.  Maximum character count is 2000 characters."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "inReplyToMessageId"
  ]
}

genesys_conversations_digital_post_message_communication_typing

Send message typing event Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`communicationId`	string	Yes	—	Communication Id
`dateSent`	string	No	—	The time when the message typing event was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`typing`	object	Yes	—	A Typing event.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "dateSent": {
      "type": "string",
      "description": "The time when the message typing event was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "typing": {
      "type": "object",
      "description": "A Typing event.",
      "properties": {
        "type": {
          "type": "string",
          "description": "Describes the type of Typing event."
        },
        "duration": {
          "type": "integer",
          "description": "The duration of the Typing event in milliseconds."
        }
      },
      "required": [
        "type"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "typing"
  ]
}

genesys_conversations_digital_post_message_inbound_open_event

Send an inbound Open Event Message Parameters:

Parameter	Type	Required	Default	Description
`integrationId`	string	Yes	—	Integration Id
`channel`	object	Yes	—	Open Channel-specific information that describes the message and the message channel/provider.
`events`	any[]	Yes	—	List of event elements.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "integrationId": {
      "type": "string",
      "description": "Integration Id"
    },
    "channel": {
      "type": "object",
      "description": "Open Channel-specific information that describes the message and the message channel/provider.",
      "properties": {
        "from": {
          "type": "object",
          "description": "Information about the recipient the message is received from."
        },
        "time": {
          "type": "string",
          "description": "Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        }
      },
      "required": [
        "from",
        "time"
      ]
    },
    "events": {
      "type": "array",
      "description": "List of event elements."
    }
  },
  "required": [
    "PCID",
    "integrationId",
    "channel",
    "events"
  ]
}

genesys_conversations_digital_post_message_inbound_open_message

Send inbound Open Message Parameters:

Parameter	Type	Required	Default	Description
`integrationId`	string	Yes	—	Integration Id
`prefetchConversationId`	boolean	No	—	Indicates whether or not to prefetch conversationId
`channel`	object	Yes	—	Open Channel-specific information that describes the message and the message channel/provider, with additional message information
`content`	any[]	No	—	List of content elements.
`metadata`	object	No	—	Additional metadata about this message to capture non-channel specific data.
`text`	string	No	—	Message text.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "integrationId": {
      "type": "string",
      "description": "Integration Id"
    },
    "prefetchConversationId": {
      "type": "boolean",
      "description": "Indicates whether or not to prefetch conversationId"
    },
    "channel": {
      "type": "object",
      "description": "Open Channel-specific information that describes the message and the message channel/provider, with additional message information",
      "properties": {
        "from": {
          "type": "object",
          "description": "Information about the recipient the message is received from."
        },
        "time": {
          "type": "string",
          "description": "Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "messageId": {
          "type": "string",
          "description": "Unique provider ID of the message."
        },
        "metadata": {
          "type": "object",
          "description": "Information about the channel."
        }
      },
      "required": [
        "from",
        "time"
      ]
    },
    "content": {
      "type": "array",
      "description": "List of content elements."
    },
    "metadata": {
      "type": "object",
      "description": "Additional metadata about this message to capture non-channel specific data."
    },
    "text": {
      "type": "string",
      "description": "Message text."
    }
  },
  "required": [
    "PCID",
    "integrationId",
    "channel"
  ]
}

genesys_conversations_digital_post_message_inbound_open_receipt

Send an inbound Open Receipt Message Parameters:

Parameter	Type	Required	Default	Description
`integrationId`	string	Yes	—	Integration Id
`channel`	object	Yes	—	Open Channel-specific information that describes the message and the message channel/provider.
`id`	string	Yes	—	The original unique message Id generated by the messaging platform, that this receipt message is referencing.
`isFinalReceipt`	boolean	No	—	Indicates if this is the last message receipt for this message, or if another message receipt can be expected.
`reasons`	any[]	No	—	List of reasons for a message receipt that indicates the message has failed. Only used with Failed status.
`status`	string	Yes	—	Message receipt status.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "integrationId": {
      "type": "string",
      "description": "Integration Id"
    },
    "channel": {
      "type": "object",
      "description": "Open Channel-specific information that describes the message and the message channel/provider.",
      "properties": {
        "to": {
          "type": "object",
          "description": "Information about the recipient the message is sent to."
        },
        "time": {
          "type": "string",
          "description": "Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        }
      },
      "required": [
        "time",
        "to"
      ]
    },
    "id": {
      "type": "string",
      "description": "The original unique message Id generated by the messaging platform, that this receipt message is referencing."
    },
    "isFinalReceipt": {
      "type": "boolean",
      "description": "Indicates if this is the last message receipt for this message, or if another message receipt can be expected."
    },
    "reasons": {
      "type": "array",
      "description": "List of reasons for a message receipt that indicates the message has failed. Only used with Failed status."
    },
    "status": {
      "type": "string",
      "description": "Message receipt status.",
      "enum": [
        "Sent",
        "Delivered",
        "Failed",
        "Published",
        "Removed"
      ]
    }
  },
  "required": [
    "PCID",
    "integrationId",
    "channel",
    "id",
    "status"
  ]
}

genesys_conversations_digital_post_message_inbound_open_structured_response

Send inbound Open Response Parameters:

Parameter	Type	Required	Default	Description
`integrationId`	string	Yes	—	Integration Id
`buttonResponse`	object	Yes	—	Button response object representing the click of a structured message button, such as a quick reply.
`channel`	object	Yes	—	Open Channel-specific information that describes the message and the message channel/provider, with additional message information
`originatingMessageId`	string	Yes	—	Id of original structured message that this messages responds to.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "integrationId": {
      "type": "string",
      "description": "Integration Id"
    },
    "buttonResponse": {
      "type": "object",
      "description": "Button response object representing the click of a structured message button, such as a quick reply.",
      "properties": {
        "id": {
          "type": "string",
          "description": "An ID assigned to the button response (Deprecated)."
        },
        "type": {
          "type": "string",
          "description": "Describes the button that resulted in the Button Response."
        },
        "text": {
          "type": "string",
          "description": "The response text from the button click."
        },
        "payload": {
          "type": "string",
          "description": "The response payload associated with the clicked button."
        }
      },
      "required": [
        "payload",
        "text",
        "type"
      ]
    },
    "channel": {
      "type": "object",
      "description": "Open Channel-specific information that describes the message and the message channel/provider, with additional message information",
      "properties": {
        "from": {
          "type": "object",
          "description": "Information about the recipient the message is received from."
        },
        "time": {
          "type": "string",
          "description": "Original time of the event. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
        },
        "messageId": {
          "type": "string",
          "description": "Unique provider ID of the message."
        },
        "metadata": {
          "type": "object",
          "description": "Information about the channel."
        }
      },
      "required": [
        "from",
        "time"
      ]
    },
    "originatingMessageId": {
      "type": "string",
      "description": "Id of original structured message that this messages responds to."
    }
  },
  "required": [
    "PCID",
    "integrationId",
    "buttonResponse",
    "channel",
    "originatingMessageId"
  ]
}

genesys_conversations_digital_post_message_participant_communication_wrapup

Apply wrap-up for this conversation communication Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`code`	string	No	—	The user configured wrap up code id.
`disableEndTimeUpdates`	boolean	No	—	Prevent updates to wrapup end time when set to true.
`durationSeconds`	integer	No	—	The length of time in seconds that the agent spent doing after call work.
`endTime`	string	No	—	The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	No	—	The user configured wrap up code name.
`notes`	string	No	—	Text entered by the agent to describe the call or disposition.
`provisional`	boolean	No	—	Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later.
`tags`	any[]	No	—	List of tags selected by the agent to describe the call or disposition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "code": {
      "type": "string",
      "description": "The user configured wrap up code id."
    },
    "disableEndTimeUpdates": {
      "type": "boolean",
      "description": "Prevent updates to wrapup end time when set to true."
    },
    "durationSeconds": {
      "type": "integer",
      "description": "The length of time in seconds that the agent spent doing after call work."
    },
    "endTime": {
      "type": "string",
      "description": "The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "name": {
      "type": "string",
      "description": "The user configured wrap up code name."
    },
    "notes": {
      "type": "string",
      "description": "Text entered by the agent to describe the call or disposition."
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later."
    },
    "tags": {
      "type": "array",
      "description": "List of tags selected by the agent to describe the call or disposition."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_post_message_participant_monitor

Listen in on the conversation from the point of view of a given participant. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_post_message_participant_replace

Replace this participant with the specified user and/or address Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`address`	string	No	—	The user ID or queue ID of the transfer target. Address like a phone number can not be used for callbacks, but they can be used for other forms of communication.
`keepInternalMessageAlive`	boolean	No	—	If true, the digital internal message will NOT be terminated.
`queueId`	string	No	—	The queue ID of the transfer target.
`transferType`	string	No	—	The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.
`userId`	string	No	—	The user ID of the transfer target.
`userName`	string	No	—	The user name of the transfer target.
`voicemail`	boolean	No	—	If true, transfer to the voicemail inbox of the participant that is being replaced.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "address": {
      "type": "string",
      "description": "The user ID or queue ID of the transfer target. Address like a phone number can not be used for callbacks, but they can be used for other forms of communication."
    },
    "keepInternalMessageAlive": {
      "type": "boolean",
      "description": "If true, the digital internal message will NOT be terminated."
    },
    "queueId": {
      "type": "string",
      "description": "The queue ID of the transfer target."
    },
    "transferType": {
      "type": "string",
      "description": "The type of transfer to perform. Attended, where the initiating agent maintains ownership of the conversation until the intended recipient accepts the transfer, or Unattended, where the initiating agent immediately disconnects. Default is Unattended.",
      "enum": [
        "Attended",
        "Unattended"
      ]
    },
    "userId": {
      "type": "string",
      "description": "The user ID of the transfer target."
    },
    "userName": {
      "type": "string",
      "description": "The user name of the transfer target."
    },
    "voicemail": {
      "type": "boolean",
      "description": "If true, transfer to the voicemail inbox of the participant that is being replaced."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_digital_post_messages

Create an outbound messaging conversation. Parameters:

Parameter	Type	Required	Default	Description
`externalContactId`	string	No	—	The external contact with which the message will be associated.
`queueId`	string	Yes	—	The ID of the queue to be associated with the message. This will determine the fromAddress of the message, unless useUserFromAddress is true and the queue is configured to use the agent’s Direct Routing address as the fromAddress.
`toAddress`	string	Yes	—	The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For open messenger type, any string within the outbound.open.messaging.to.address.characters.max limit can be used. For whatsapp messenger type, use a Whatsapp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a Whatsapp ID would be 13175555555
`toAddressMessengerType`	string	Yes	—	The messaging address messenger type.
`useExistingConversation`	boolean	No	—	An override to use an existing conversation. If set to true, an existing conversation will be used if there is one within the conversation window. If set to false, create request fails if there is a conversation within the conversation window.
`useUserFromAddress`	boolean	No	—	An override to attempt to use the user’s configured direct routing address as the fromAddress. If set to true, users configured address with ‘directrouting’ integration will be used as fromAddress. If set to false or not set, the queueId will be used for determining fromAddress.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "externalContactId": {
      "type": "string",
      "description": "The external contact with which the message will be associated."
    },
    "queueId": {
      "type": "string",
      "description": "The ID of the queue to be associated with the message. This will determine the fromAddress of the message, unless useUserFromAddress is true and the queue is configured to use the agent's Direct Routing address as the fromAddress."
    },
    "toAddress": {
      "type": "string",
      "description": "The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234.  For open messenger type, any string within the outbound.open.messaging.to.address.characters.max limit can be used. For whatsapp messenger type, use a Whatsapp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a Whatsapp ID would be 13175555555"
    },
    "toAddressMessengerType": {
      "type": "string",
      "description": "The messaging address messenger type.",
      "enum": [
        "sms",
        "open",
        "whatsapp"
      ]
    },
    "useExistingConversation": {
      "type": "boolean",
      "description": "An override to use an existing conversation.  If set to true, an existing conversation will be used if there is one within the conversation window.  If set to false, create request fails if there is a conversation within the conversation window."
    },
    "useUserFromAddress": {
      "type": "boolean",
      "description": "An override to attempt to use the user's configured direct routing address as the fromAddress.  If set to true, users configured address with 'directrouting' integration will be used as fromAddress.  If set to false or not set, the queueId will be used for determining fromAddress."
    }
  },
  "required": [
    "PCID",
    "queueId",
    "toAddress",
    "toAddressMessengerType"
  ]
}

genesys_conversations_digital_post_messages_agentless

Send an agentless outbound message Parameters:

Parameter	Type	Required	Default	Description
`useNormalizedMessage`	boolean	No	—	If true, response removes deprecated fields (textBody, messagingTemplate)
`fromAddress`	string	Yes	—	The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned SMS phone number. For a WhatsApp messenger type use the provisioned WhatsApp integration’s ID
`messagingTemplate`	object	No	—	Messaging Template
`textBody`	string	No	—	The text of the message to send. This field is required in the case of SMS messenger type. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters.
`toAddress`	string	Yes	—	The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For WhatsApp messenger type, use a WhatsApp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a WhatsApp ID would be 13175555555
`toAddressMessengerType`	string	Yes	—	The recipient messaging address messenger type.
`useExistingActiveConversation`	boolean	No	—	Use an existing active conversation to send the agentless outbound message. Set this parameter to ‘true’ to use active conversation. Default value: false

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "useNormalizedMessage": {
      "type": "boolean",
      "description": "If true, response removes deprecated fields (textBody, messagingTemplate)"
    },
    "fromAddress": {
      "type": "string",
      "description": "The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned SMS phone number. For a WhatsApp messenger type use the provisioned WhatsApp integration’s ID"
    },
    "messagingTemplate": {
      "type": "object",
      "description": "Messaging Template",
      "properties": {
        "responseId": {
          "type": "string",
          "description": "Unique identifier for a Response Management response to fetch and apply pre-configured message content when sending outbound responses."
        },
        "parameters": {
          "type": "array",
          "description": "A list of Response Management response substitutions for the response's messaging template. (Deprecated) use bodyParameters instead."
        },
        "headerParameters": {
          "type": "array",
          "description": "A list of Response Management header parameter substitutions for the response's messaging template"
        },
        "bodyParameters": {
          "type": "array",
          "description": "A list of Response Management body parameter substitutions for the response's messaging template"
        },
        "buttonUrlParameters": {
          "type": "array",
          "description": "A list of Response Management button url parameter substitutions for the response's messaging template"
        },
        "carouselParameters": {
          "type": "object",
          "description": "Template parameters for carousel components"
        }
      }
    },
    "textBody": {
      "type": "string",
      "description": "The text of the message to send. This field is required in the case of SMS messenger type. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters."
    },
    "toAddress": {
      "type": "string",
      "description": "The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For WhatsApp messenger type, use a WhatsApp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a WhatsApp ID would be 13175555555"
    },
    "toAddressMessengerType": {
      "type": "string",
      "description": "The recipient messaging address messenger type.",
      "enum": [
        "sms",
        "whatsapp",
        "open"
      ]
    },
    "useExistingActiveConversation": {
      "type": "boolean",
      "description": "Use an existing active conversation to send the agentless outbound message. Set this parameter to 'true' to use active conversation. Default value: false"
    }
  },
  "required": [
    "PCID",
    "fromAddress",
    "toAddress",
    "toAddressMessengerType"
  ]
}

genesys_conversations_digital_post_social_participant_communication_wrapup

Apply wrap-up for this conversation communication Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`code`	string	No	—	The user configured wrap up code id.
`disableEndTimeUpdates`	boolean	No	—	Prevent updates to wrapup end time when set to true.
`durationSeconds`	integer	No	—	The length of time in seconds that the agent spent doing after call work.
`endTime`	string	No	—	The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	No	—	The user configured wrap up code name.
`notes`	string	No	—	Text entered by the agent to describe the call or disposition.
`provisional`	boolean	No	—	Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later.
`tags`	any[]	No	—	List of tags selected by the agent to describe the call or disposition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "code": {
      "type": "string",
      "description": "The user configured wrap up code id."
    },
    "disableEndTimeUpdates": {
      "type": "boolean",
      "description": "Prevent updates to wrapup end time when set to true."
    },
    "durationSeconds": {
      "type": "integer",
      "description": "The length of time in seconds that the agent spent doing after call work."
    },
    "endTime": {
      "type": "string",
      "description": "The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "name": {
      "type": "string",
      "description": "The user configured wrap up code name."
    },
    "notes": {
      "type": "string",
      "description": "Text entered by the agent to describe the call or disposition."
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later."
    },
    "tags": {
      "type": "array",
      "description": "List of tags selected by the agent to describe the call or disposition."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_post_video_participant_communication_wrapup

Apply wrap-up for this conversation communication Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`participantId`	string	Yes	—	Participant Id
`communicationId`	string	Yes	—	Communication Id
`code`	string	No	—	The user configured wrap up code id.
`disableEndTimeUpdates`	boolean	No	—	Prevent updates to wrapup end time when set to true.
`durationSeconds`	integer	No	—	The length of time in seconds that the agent spent doing after call work.
`endTime`	string	No	—	The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`name`	string	No	—	The user configured wrap up code name.
`notes`	string	No	—	Text entered by the agent to describe the call or disposition.
`provisional`	boolean	No	—	Indicates if this is a pending save and should not require a code to be specified. This allows someone to save some temporary wrapup that will be used later.
`tags`	any[]	No	—	List of tags selected by the agent to describe the call or disposition.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "participantId": {
      "type": "string",
      "description": "Participant Id"
    },
    "communicationId": {
      "type": "string",
      "description": "Communication Id"
    },
    "code": {
      "type": "string",
      "description": "The user configured wrap up code id."
    },
    "disableEndTimeUpdates": {
      "type": "boolean",
      "description": "Prevent updates to wrapup end time when set to true."
    },
    "durationSeconds": {
      "type": "integer",
      "description": "The length of time in seconds that the agent spent doing after call work."
    },
    "endTime": {
      "type": "string",
      "description": "The timestamp when the wrapup was finished. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "name": {
      "type": "string",
      "description": "The user configured wrap up code name."
    },
    "notes": {
      "type": "string",
      "description": "Text entered by the agent to describe the call or disposition."
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates if this is a pending save and should not require a code to be specified.  This allows someone to save some temporary wrapup that will be used later."
    },
    "tags": {
      "type": "array",
      "description": "List of tags selected by the agent to describe the call or disposition."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_digital_post_videos_meetings

Generate a meetingId for a given conferenceId Parameters:

Parameter	Type	Required	Default	Description
`conferenceId`	string	No	—	The conferenceId for which to generate a meetingId
`ephemeral`	boolean	Yes	—	Boolean flag for ephemeral status of the created record
`expireTimeDays`	integer	No	—	Number of days the meetingId record will remain active

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conferenceId": {
      "type": "string",
      "description": "The conferenceId for which to generate a meetingId"
    },
    "ephemeral": {
      "type": "boolean",
      "description": "Boolean flag for ephemeral status of the created record"
    },
    "expireTimeDays": {
      "type": "integer",
      "description": "Number of days the meetingId record will remain active"
    }
  },
  "required": [
    "PCID",
    "ephemeral"
  ]
}

genesys_conversations_digital_put_email_messages_draft

Update conversation draft reply Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`attachments`	any[]	No	—	The attachments of the email message.
`bcc`	any[]	No	—	The recipients that were blind copied on the email message.
`cc`	any[]	No	—	The recipients that were copied on the email message.
`draftType`	string	No	—	The type of draft that need to be treated.
`emailSizeBytes`	integer	No	—	Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form.
`from`	object	Yes	—	The from value
`historyIncluded`	boolean	No	—	Indicates whether the history of previous emails of the conversation is included within the email bodies of this message.
`htmlBody`	string	No	—	The html body of the email message.
`id`	string	No	—	The globally unique identifier for the object.
`maxEmailSizeBytes`	integer	No	—	Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration
`name`	string	No	—	The name value
`replyTo`	object	No	—	Reply To
`selfUri`	string	No	—	The URI for this object
`state`	string	No	—	The state of the current draft.
`subject`	string	No	—	The subject of the email message.
`textBody`	string	Yes	—	The text body of the email message.
`time`	string	No	—	The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`to`	any[]	Yes	—	The recipients of the email message.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "attachments": {
      "type": "array",
      "description": "The attachments of the email message."
    },
    "bcc": {
      "type": "array",
      "description": "The recipients that were blind copied on the email message."
    },
    "cc": {
      "type": "array",
      "description": "The recipients that were copied on the email message."
    },
    "draftType": {
      "type": "string",
      "description": "The type of draft that need to be treated.",
      "enum": [
        "Reply",
        "ReplyAll",
        "Forward"
      ]
    },
    "emailSizeBytes": {
      "type": "integer",
      "description": "Indicates an estimation of the size of the current email as a whole, in its final, ready to be sent form."
    },
    "from": {
      "type": "object",
      "description": "The from value",
      "properties": {
        "email": {
          "type": "string",
          "description": "The email value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "historyIncluded": {
      "type": "boolean",
      "description": "Indicates whether the history of previous emails of the conversation is included within the email bodies of this message."
    },
    "htmlBody": {
      "type": "string",
      "description": "The html body of the email message."
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for the object."
    },
    "maxEmailSizeBytes": {
      "type": "integer",
      "description": "Indicates the maximum allowed size for an email to be send via SMTP server, based on the email domain configuration"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "replyTo": {
      "type": "object",
      "description": "Reply To",
      "properties": {
        "email": {
          "type": "string",
          "description": "The email value"
        },
        "name": {
          "type": "string",
          "description": "The name value"
        }
      }
    },
    "selfUri": {
      "type": "string",
      "description": "The URI for this object"
    },
    "state": {
      "type": "string",
      "description": "The state of the current draft.",
      "enum": [
        "Created",
        "Ready",
        "Edited"
      ]
    },
    "subject": {
      "type": "string",
      "description": "The subject of the email message."
    },
    "textBody": {
      "type": "string",
      "description": "The text body of the email message."
    },
    "time": {
      "type": "string",
      "description": "The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "to": {
      "type": "array",
      "description": "The recipients of the email message."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "from",
    "textBody",
    "to"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

Skills Guides

​Tools

​genesys_conversations_digital_delete_email_messages_draft_attachment

​genesys_conversations_digital_get_cobrowsesession

​genesys_conversations_digital_get_cobrowsesessions

​genesys_conversations_digital_get_email

​genesys_conversations_digital_get_email_message

​genesys_conversations_digital_get_email_messages

​genesys_conversations_digital_get_email_messages_draft

​genesys_conversations_digital_get_email_participant_communication_wrapup

​genesys_conversations_digital_get_email_participant_wrapup

​genesys_conversations_digital_get_email_participant_wrapupcodes

​genesys_conversations_digital_get_email_settings

​genesys_conversations_digital_get_emails

​genesys_conversations_digital_get_internalmessage

​genesys_conversations_digital_get_internalmessages

​genesys_conversations_digital_get_message

​genesys_conversations_digital_get_message_communication_messages_media

​genesys_conversations_digital_get_message_communication_messages_media_media_id

​genesys_conversations_digital_get_message_details

​genesys_conversations_digital_get_message_message

​genesys_conversations_digital_get_message_participant_communication_wrapup

​genesys_conversations_digital_get_message_participant_wrapup

​genesys_conversations_digital_get_message_participant_wrapupcodes

​genesys_conversations_digital_get_messages

​genesys_conversations_digital_get_messaging_integrations

​genesys_conversations_digital_get_social_participant_communication_wrapup

​genesys_conversations_digital_get_video_participant_communication_wrapup

​genesys_conversations_digital_get_videos_meeting

​genesys_conversations_digital_patch_email

​genesys_conversations_digital_patch_email_messages_draft

​genesys_conversations_digital_patch_email_participant

​genesys_conversations_digital_patch_email_participant_attributes

​genesys_conversations_digital_patch_email_participant_communication

​genesys_conversations_digital_patch_email_participant_parkingstate

​genesys_conversations_digital_patch_message

​genesys_conversations_digital_patch_message_participant

​genesys_conversations_digital_patch_message_participant_attributes

​genesys_conversations_digital_patch_message_participant_communication

​genesys_conversations_digital_post_email_inboundmessages

​genesys_conversations_digital_post_email_messages

​genesys_conversations_digital_post_email_messages_draft_attachments_copy

​genesys_conversations_digital_post_email_participant_communication_wrapup

​genesys_conversations_digital_post_email_participant_replace

​genesys_conversations_digital_post_email_reconnect

​genesys_conversations_digital_post_emails

​genesys_conversations_digital_post_emails_agentless

​genesys_conversations_digital_post_faxes

​genesys_conversations_digital_post_message_communication_messages

​genesys_conversations_digital_post_message_communication_messages_media_uploads

​genesys_conversations_digital_post_message_communication_socialmedia_messages

​genesys_conversations_digital_post_message_communication_typing

​genesys_conversations_digital_post_message_inbound_open_event

​genesys_conversations_digital_post_message_inbound_open_message

​genesys_conversations_digital_post_message_inbound_open_receipt

​genesys_conversations_digital_post_message_inbound_open_structured_response

​genesys_conversations_digital_post_message_participant_communication_wrapup

​genesys_conversations_digital_post_message_participant_monitor

​genesys_conversations_digital_post_message_participant_replace

​genesys_conversations_digital_post_messages

​genesys_conversations_digital_post_messages_agentless

​genesys_conversations_digital_post_social_participant_communication_wrapup

​genesys_conversations_digital_post_video_participant_communication_wrapup

​genesys_conversations_digital_post_videos_meetings

​genesys_conversations_digital_put_email_messages_draft

Tools

genesys_conversations_digital_delete_email_messages_draft_attachment

genesys_conversations_digital_get_cobrowsesession

genesys_conversations_digital_get_cobrowsesessions

genesys_conversations_digital_get_email

genesys_conversations_digital_get_email_message

genesys_conversations_digital_get_email_messages

genesys_conversations_digital_get_email_messages_draft

genesys_conversations_digital_get_email_participant_communication_wrapup

genesys_conversations_digital_get_email_participant_wrapup

genesys_conversations_digital_get_email_participant_wrapupcodes

genesys_conversations_digital_get_email_settings

genesys_conversations_digital_get_emails

genesys_conversations_digital_get_internalmessage

genesys_conversations_digital_get_internalmessages

genesys_conversations_digital_get_message

genesys_conversations_digital_get_message_communication_messages_media

genesys_conversations_digital_get_message_communication_messages_media_media_id

genesys_conversations_digital_get_message_details

genesys_conversations_digital_get_message_message

genesys_conversations_digital_get_message_participant_communication_wrapup

genesys_conversations_digital_get_message_participant_wrapup

genesys_conversations_digital_get_message_participant_wrapupcodes

genesys_conversations_digital_get_messages

genesys_conversations_digital_get_messaging_integrations

genesys_conversations_digital_get_social_participant_communication_wrapup

genesys_conversations_digital_get_video_participant_communication_wrapup

genesys_conversations_digital_get_videos_meeting

genesys_conversations_digital_patch_email

genesys_conversations_digital_patch_email_messages_draft

genesys_conversations_digital_patch_email_participant

genesys_conversations_digital_patch_email_participant_attributes

genesys_conversations_digital_patch_email_participant_communication

genesys_conversations_digital_patch_email_participant_parkingstate

genesys_conversations_digital_patch_message

genesys_conversations_digital_patch_message_participant

genesys_conversations_digital_patch_message_participant_attributes

genesys_conversations_digital_patch_message_participant_communication

genesys_conversations_digital_post_email_inboundmessages

genesys_conversations_digital_post_email_messages

genesys_conversations_digital_post_email_messages_draft_attachments_copy

genesys_conversations_digital_post_email_participant_communication_wrapup

genesys_conversations_digital_post_email_participant_replace

genesys_conversations_digital_post_email_reconnect

genesys_conversations_digital_post_emails

genesys_conversations_digital_post_emails_agentless

genesys_conversations_digital_post_faxes

genesys_conversations_digital_post_message_communication_messages

genesys_conversations_digital_post_message_communication_messages_media_uploads

genesys_conversations_digital_post_message_communication_socialmedia_messages

genesys_conversations_digital_post_message_communication_typing

genesys_conversations_digital_post_message_inbound_open_event

genesys_conversations_digital_post_message_inbound_open_message

genesys_conversations_digital_post_message_inbound_open_receipt

genesys_conversations_digital_post_message_inbound_open_structured_response

genesys_conversations_digital_post_message_participant_communication_wrapup

genesys_conversations_digital_post_message_participant_monitor

genesys_conversations_digital_post_message_participant_replace

genesys_conversations_digital_post_messages

genesys_conversations_digital_post_messages_agentless

genesys_conversations_digital_post_social_participant_communication_wrapup

genesys_conversations_digital_post_video_participant_communication_wrapup

genesys_conversations_digital_post_videos_meetings

genesys_conversations_digital_put_email_messages_draft