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

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

Tools

Tool	Description
`genesys_conversations_delete_call_participant_consult`	Cancel the transfer
`genesys_conversations_delete_conversation`	Update a conversation by disconnecting all of the participants
`genesys_conversations_delete_conversation_customattribute`	Delete a custom attributes record.
`genesys_conversations_delete_conversation_participant_code`	Delete a code used to add a communication to this participant
`genesys_conversations_delete_conversation_participant_flaggedreason`	Remove flagged reason from conversation participant.
`genesys_conversations_get_analytics_conversation_details`	Get a conversation by id
`genesys_conversations_get_analytics_conversations_details`	Gets multiple conversations by id
`genesys_conversations_get_analytics_conversations_details_job_results`	Fetch a page of results for an async details job
`genesys_conversations_get_call`	Get call conversation
`genesys_conversations_get_call_participant_communication_wrapup`	Get the wrap-up for this conversation communication.
`genesys_conversations_get_call_participant_wrapup`	Get the wrap-up for this conversation participant.
`genesys_conversations_get_call_participant_wrapupcodes`	Get list of wrapup codes for this conversation participant
`genesys_conversations_get_callback`	Get callback conversation
`genesys_conversations_get_callback_participant_communication_wrapup`	Get the wrap-up for this conversation communication.
`genesys_conversations_get_callback_participant_wrapup`	Get the wrap-up for this conversation participant.
`genesys_conversations_get_callback_participant_wrapupcodes`	Get list of wrapup codes for this conversation participant
`genesys_conversations_get_callbacks`	Get the logged-in user’s active conversations and their Callback participants state.
`genesys_conversations_get_calls`	Get the logged-in user’s active conversations and their Call participants state.
`genesys_conversations_get_calls_history`	Get call history
`genesys_conversations_get_conversation`	Get conversation
`genesys_conversations_get_conversation_communication_agentchecklist`	Get checklist info for a single checklist.
`genesys_conversations_get_conversation_communication_agentchecklist_job`	Get inference job status
`genesys_conversations_get_conversation_communication_agentchecklists`	Get information of all checklists associated with a conversation.
`genesys_conversations_get_conversation_communication_internalmessage`	Get message
`genesys_conversations_get_conversation_communication_internalmessages`	Get messages for communication
`genesys_conversations_get_conversation_customattribute`	Get custom attributes by id
`genesys_conversations_get_conversation_customattributes`	Get a list of custom attributes for a conversation.
`genesys_conversations_get_conversation_participant_secureivrsession`	Fetch info on a secure session
`genesys_conversations_get_conversation_participant_secureivrsessions`	Get a list of secure sessions for this participant.
`genesys_conversations_get_conversation_participant_wrapup`	Get the wrap-up for this conversation participant.
`genesys_conversations_get_conversation_participant_wrapupcodes`	Get list of wrapup codes for this conversation participant
`genesys_conversations_get_conversation_secureattributes`	Get the secure attributes on a conversation.
`genesys_conversations_get_conversation_suggestion`	Get Suggestion.
`genesys_conversations_get_conversation_suggestions`	Get all suggestions for a conversation.
`genesys_conversations_get_conversation_summaries`	Get the summaries of the conversation.
`genesys_conversations_get_conversations`	Get active conversations for the logged in user
`genesys_conversations_get_conversations_call`	Get call conversation
`genesys_conversations_get_conversations_callback`	Get callback conversation
`genesys_conversations_get_conversations_callbacks`	Get the logged-in user’s active conversations and their Callback participants state.
`genesys_conversations_get_conversations_calls`	Get the logged-in user’s active conversations and their Call participants state.
`genesys_conversations_get_conversations_calls_history`	Get call history
`genesys_conversations_get_conversations_email`	Get email conversation
`genesys_conversations_get_conversations_emails`	Get the logged-in user’s active conversations and their Email participants state.
`genesys_conversations_get_conversations_message`	Get message conversation
`genesys_conversations_get_conversations_messages`	Get the logged-in user’s active conversations and their Message participants state.
`genesys_conversations_patch_call`	Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
`genesys_conversations_patch_call_conference`	Update a conversation by merging in other conversations to create a conference
`genesys_conversations_patch_call_participant`	Update conversation participant
`genesys_conversations_patch_call_participant_attributes`	Update the attributes on a conversation participant.
`genesys_conversations_patch_call_participant_communication`	Update conversation participant’s communication by disconnecting it. This endpoint does not update wrapup.
`genesys_conversations_patch_call_participant_consult`	Change who can speak
`genesys_conversations_patch_call_participant_user_user_id`	Update conversation participant on behalf of a user
`genesys_conversations_patch_callback`	Update a conversation by disconnecting all of the participants
`genesys_conversations_patch_callback_participant`	Update conversation participant
`genesys_conversations_patch_callback_participant_attributes`	Update the attributes on a conversation participant.
`genesys_conversations_patch_callback_participant_communication`	Update conversation participant’s communication by disconnecting it.
`genesys_conversations_patch_callbacks`	Update a scheduled callback
`genesys_conversations_patch_conversation_customattributes`	Update a single custom attributes record by amending the data with only the provided fields.
`genesys_conversations_patch_conversation_participant`	Update a participant.
`genesys_conversations_patch_conversation_participant_attributes`	Update the attributes on a conversation participant.
`genesys_conversations_patch_conversation_secureattributes`	Update the secure attributes on a conversation.
`genesys_conversations_patch_conversation_summary_engagements`	Update agent’s engagement for the summary.
`genesys_conversations_patch_conversation_summary_feedback`	Update the feedback for the summary.
`genesys_conversations_patch_conversation_utilizationlabel`	Update the utilization label on a conversation. When there is no value provided, the system default label is applied
`genesys_conversations_post_analytics_conversations_activity_query`	Query for conversation activity observations
`genesys_conversations_post_analytics_conversations_aggregates_query`	Query for conversation aggregates
`genesys_conversations_post_analytics_conversations_details_query`	Query for conversation details
`genesys_conversations_post_call`	Place a new call as part of a callback conversation.
`genesys_conversations_post_call_participant_barge`	Barge a given participant’s call creating a barged in conference of connected participants.
`genesys_conversations_post_call_participant_coach`	Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
`genesys_conversations_post_call_participant_communication_wrapup`	Apply wrap-up for this conversation communication
`genesys_conversations_post_call_participant_consult_agent`	Initiate a consult transfer to an agent
`genesys_conversations_post_call_participant_consult_contact_external`	Initiate a consult transfer to an external contact
`genesys_conversations_post_call_participant_consult_queue`	Initiate a consult transfer to a queue
`genesys_conversations_post_call_participant_monitor`	Listen in on the conversation from the point of view of a given participant.
`genesys_conversations_post_call_participant_replace`	Replace this participant with the specified user and/or address
`genesys_conversations_post_call_participant_voice_consult`	Initiate voice consult transfer
`genesys_conversations_post_call_participants`	Add participants to a conversation
`genesys_conversations_post_call_participants_user_user_id`	Add participants to a conversation on behalf of a user
`genesys_conversations_post_callback_participant_communication_wrapup`	Apply wrap-up for this conversation communication
`genesys_conversations_post_callback_participant_replace`	Replace this participant with the specified user and/or address
`genesys_conversations_post_callbacks`	Create a Callback
`genesys_conversations_post_calls`	Create a call conversation
`genesys_conversations_post_calls_user_user_id`	Create a call conversation on behalf of a user
`genesys_conversations_post_conversation_assign`	Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
`genesys_conversations_post_conversation_barge`	Barge a conversation creating a barged in conference of connected participants.
`genesys_conversations_post_conversation_cobrowse`	Creates a cobrowse session. Requires “conversation:cobrowse:add” (for web messaging) or “conversation:cobrowsevoice:add” permission.
`genesys_conversations_post_conversation_communication_agentchecklist`	Agent Checklist activation API
`genesys_conversations_post_conversation_communication_agentchecklist_agentaction`	API invoked to capture an agent action.
`genesys_conversations_post_conversation_communication_agentchecklist_jobs`	Create inference job
`genesys_conversations_post_conversation_communication_agentchecklists_finalize`	API invoked to finalize agent checklist evaluation.
`genesys_conversations_post_conversation_communication_internalmessages`	Send internal message
`genesys_conversations_post_conversation_disconnect`	Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
`genesys_conversations_post_conversation_participant_callbacks`	Create a new callback for the specified participant on the conversation.
`genesys_conversations_post_conversation_participant_digits`	Sends DTMF to the participant
`genesys_conversations_post_conversation_participant_internalmessages_users_communications`	Setup internal message communication with user
`genesys_conversations_post_conversation_participant_replace_agent`	Replace this participant with the specified agent
`genesys_conversations_post_conversation_participant_replace_contact_external`	Replace this participant with the an external contact
`genesys_conversations_post_conversation_participant_replace_queue`	Replace this participant with the specified queue
`genesys_conversations_post_conversation_participant_secureivrsessions`	Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
`genesys_conversations_post_conversation_participant_transfer`	Replace this participant by another one using the address of the destination.
`genesys_conversations_post_conversation_suggestion_engagement`	Save an engagement on the suggestion.
`genesys_conversations_post_conversation_summary_feedback`	Submit feedback for the summary.
`genesys_conversations_post_conversations_call_participant_communication_wrapup`	Apply wrap-up for this conversation communication
`genesys_conversations_post_conversations_participants_attributes_search`	Search conversations
`genesys_conversations_post_customattributes_search`	Search resources.
`genesys_conversations_post_participants_attributes_search`	Search conversations
`genesys_conversations_put_conversation_customattributes`	Create or update a single custom attributes record. Updating replaces all data with the provided fields.
`genesys_conversations_put_conversation_participant_flaggedreason`	Set flagged reason on conversation participant to indicate bad conversation quality.
`genesys_conversations_put_conversation_secureattributes`	Set the secure attributes on a conversation.
`genesys_conversations_put_conversation_tags`	Update the tags on a conversation.

genesys_conversations_delete_call_participant_consult

Cancel the transfer Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId

Show inputSchema

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

genesys_conversations_delete_conversation

Update a conversation by disconnecting all of the participants 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_delete_conversation_customattribute

Delete a custom attributes record. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`attributesId`	string	Yes	—	attributesId

Show inputSchema

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

genesys_conversations_delete_conversation_participant_code

Delete a code used to add a communication to this participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`addCommunicationCode`	string	Yes	—	addCommunicationCode

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"
    },
    "addCommunicationCode": {
      "type": "string",
      "description": "addCommunicationCode"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "addCommunicationCode"
  ]
}

genesys_conversations_delete_conversation_participant_flaggedreason

Remove flagged reason from 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_get_analytics_conversation_details

Get a conversation by id Parameters:

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

Show inputSchema

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

genesys_conversations_get_analytics_conversations_details

Gets multiple conversations by id Parameters:

Parameter	Type	Required	Default	Description
`id`	any[]	No	—	Comma-separated conversation ids

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "array",
      "description": "Comma-separated conversation ids"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_get_analytics_conversations_details_job_results

Fetch a page of results for an async details job Parameters:

Parameter	Type	Required	Default	Description
`jobId`	string	Yes	—	jobId
`cursor`	string	No	—	Indicates where to resume query results (not required for first page)
`pageSize`	integer	No	—	The desired maximum number of results

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "jobId": {
      "type": "string",
      "description": "jobId"
    },
    "cursor": {
      "type": "string",
      "description": "Indicates where to resume query results (not required for first page)"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired maximum number of results"
    }
  },
  "required": [
    "PCID",
    "jobId"
  ]
}

genesys_conversations_get_call

Get call conversation Parameters:

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

Show inputSchema

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

genesys_conversations_get_call_participant_communication_wrapup

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

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`communicationId`	string	Yes	—	communicationId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_get_call_participant_wrapup

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

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_get_call_participant_wrapupcodes

Get list of wrapup codes for this conversation participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId

Show inputSchema

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

genesys_conversations_get_callback

Get callback conversation Parameters:

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

Show inputSchema

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

genesys_conversations_get_callback_participant_communication_wrapup

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

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`communicationId`	string	Yes	—	communicationId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_get_callback_participant_wrapup

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

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "provisional": {
      "type": "boolean",
      "description": "Indicates whether or not to fetch provisional wrap-up code."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_get_callback_participant_wrapupcodes

Get list of wrapup codes for this conversation participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId

Show inputSchema

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

genesys_conversations_get_callbacks

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

Show inputSchema

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

genesys_conversations_get_calls

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

Show inputSchema

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

genesys_conversations_get_calls_history

Get call history Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size, maximum 50
`pageNumber`	integer	No	—	Page number
`interval`	string	No	—	Interval string; format is ISO-8601. Separate start and end times with forward slash ’/‘
`expand`	any[]	No	—	Which fields, if any, to expand.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size, maximum 50"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "interval": {
      "type": "string",
      "description": "Interval string; format is ISO-8601. Separate start and end times with forward slash '/'"
    },
    "expand": {
      "type": "array",
      "description": "Which fields, if any, to expand."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_get_conversation

Get 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_get_conversation_communication_agentchecklist

Get checklist info for a single checklist. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`communicationId`	string	Yes	—	Communication ID
`agentChecklistId`	string	Yes	—	Agent Checklist 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"
    },
    "agentChecklistId": {
      "type": "string",
      "description": "Agent Checklist ID"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "agentChecklistId"
  ]
}

genesys_conversations_get_conversation_communication_agentchecklist_job

Get inference job status Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`communicationId`	string	Yes	—	Communication ID
`agentChecklistId`	string	Yes	—	Agent Checklist ID
`jobId`	string	Yes	—	Inference Job 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"
    },
    "agentChecklistId": {
      "type": "string",
      "description": "Agent Checklist ID"
    },
    "jobId": {
      "type": "string",
      "description": "Inference Job ID"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "agentChecklistId",
    "jobId"
  ]
}

genesys_conversations_get_conversation_communication_agentchecklists

Get information of all checklists associated with a conversation. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`communicationId`	string	Yes	—	Communication 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"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId"
  ]
}

genesys_conversations_get_conversation_communication_internalmessage

Get message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`communicationId`	string	Yes	—	communicationId
`messageId`	string	Yes	—	messageId

Show inputSchema

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

genesys_conversations_get_conversation_communication_internalmessages

Get messages for communication Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`communicationId`	string	Yes	—	communicationId
`pageSize`	integer	No	—	Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200.
`pageNumber`	integer	No	—	Page number

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "pageSize": {
      "type": "integer",
      "description": "Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200."
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId"
  ]
}

genesys_conversations_get_conversation_customattribute

Get custom attributes by id Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`attributesId`	string	Yes	—	attributesId

Show inputSchema

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

genesys_conversations_get_conversation_customattributes

Get a list of custom attributes for a 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_get_conversation_participant_secureivrsession

Fetch info on a secure session Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`secureSessionId`	string	Yes	—	secure IVR session 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"
    },
    "secureSessionId": {
      "type": "string",
      "description": "secure IVR session ID"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "secureSessionId"
  ]
}

genesys_conversations_get_conversation_participant_secureivrsessions

Get a list of secure sessions for this 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_get_conversation_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 if the wrap-up code is provisional.

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 if the wrap-up code is provisional."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_get_conversation_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_get_conversation_secureattributes

Get the secure attributes on a 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_get_conversation_suggestion

Get Suggestion. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`suggestionId`	string	Yes	—	Suggestion ID

Show inputSchema

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

genesys_conversations_get_conversation_suggestions

Get all suggestions for a conversation. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`before`	string	No	—	The cursor that points to the start of the set of entities that has been returned.
`after`	string	No	—	The cursor that points to the end of the set of entities that has been returned.
`pageSize`	string	No	—	Number of entities to return. Maximum of 200.
`type`	string	No	—	Suggestion type to filter by.
`state`	string	No	—	Suggestion state to filter Copilot suggestions.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "before": {
      "type": "string",
      "description": "The cursor that points to the start of the set of entities that has been returned."
    },
    "after": {
      "type": "string",
      "description": "The cursor that points to the end of the set of entities that has been returned."
    },
    "pageSize": {
      "type": "string",
      "description": "Number of entities to return. Maximum of 200."
    },
    "type": {
      "type": "string",
      "description": "Suggestion type to filter by.",
      "enum": [
        "Faq",
        "Article",
        "KnowledgeArticle",
        "KnowledgeSearch",
        "CannedResponse",
        "Script",
        "SuggestedKnowledgeAnswer"
      ]
    },
    "state": {
      "type": "string",
      "description": "Suggestion state to filter Copilot suggestions.",
      "enum": [
        "Suggested",
        "Accepted",
        "Dismissed",
        "Failed",
        "Rated"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_get_conversation_summaries

Get the summaries of the 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_get_conversations

Get active conversations for the logged in user Parameters:

Parameter	Type	Required	Default	Description
`communicationType`	string	No	—	Call or Chat communication filtering

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "communicationType": {
      "type": "string",
      "description": "Call or Chat communication filtering"
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_get_conversations_call

Get call conversation Parameters:

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

Show inputSchema

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

genesys_conversations_get_conversations_callback

Get callback conversation Parameters:

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

Show inputSchema

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

genesys_conversations_get_conversations_callbacks

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

Show inputSchema

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

genesys_conversations_get_conversations_calls

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

Show inputSchema

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

genesys_conversations_get_conversations_calls_history

Get call history Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	Page size, maximum 50
`pageNumber`	integer	No	—	Page number
`interval`	string	No	—	Interval string; format is ISO-8601. Separate start and end times with forward slash ’/‘
`expand`	any[]	No	—	Which fields, if any, to expand.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "Page size, maximum 50"
    },
    "pageNumber": {
      "type": "integer",
      "description": "Page number"
    },
    "interval": {
      "type": "string",
      "description": "Interval string; format is ISO-8601. Separate start and end times with forward slash '/'"
    },
    "expand": {
      "type": "array",
      "description": "Which fields, if any, to expand."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_get_conversations_email

Get email conversation Parameters:

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

Show inputSchema

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

genesys_conversations_get_conversations_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_get_conversations_message

Get message conversation Parameters:

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

Show inputSchema

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

genesys_conversations_get_conversations_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_patch_call

Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`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	—	name
`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": "conversationId"
    },
    "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": "name"
    },
    "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_patch_call_conference

Update a conversation by merging in other conversations to create a conference Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`conversationIds`	any[]	No	—	A list of conversations to merge into this conversation to create a conference.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "conversationIds": {
      "type": "array",
      "description": "A list of conversations to merge into this conversation to create a conference."
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_patch_call_participant

Update conversation participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`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.
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	wrapup
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "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."
    },
    "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": "wrapup"
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_patch_call_participant_attributes

Update the attributes on a conversation participant. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "attributes": {
      "type": "object",
      "description": "The map of attribute keys to values."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_patch_call_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	—	conversationId
`participantId`	string	Yes	—	participantId
`communicationId`	string	Yes	—	communicationId
`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.
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	wrapup
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "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."
    },
    "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": "wrapup"
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_patch_call_participant_consult

Change who can speak Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`consultingUserId`	string	No	—	The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID
`speakTo`	string	Yes	—	Determines to whom the initiating participant is speaking.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "consultingUserId": {
      "type": "string",
      "description": "The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"
    },
    "speakTo": {
      "type": "string",
      "description": "Determines to whom the initiating participant is speaking.",
      "enum": [
        "DESTINATION",
        "OBJECT",
        "BOTH",
        "CONFERENCE"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "speakTo"
  ]
}

genesys_conversations_patch_call_participant_user_user_id

Update conversation participant on behalf of a user Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`userId`	string	Yes	—	userId
`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.
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	wrapup
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "userId": {
      "type": "string",
      "description": "userId"
    },
    "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."
    },
    "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": "wrapup"
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "userId"
  ]
}

genesys_conversations_patch_callback

Update a conversation by disconnecting all of the participants Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`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	—	name
`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": "conversationId"
    },
    "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": "name"
    },
    "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_patch_callback_participant

Update conversation participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`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.
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	wrapup
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "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."
    },
    "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": "wrapup"
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_patch_callback_participant_attributes

Update the attributes on a conversation participant. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "attributes": {
      "type": "object",
      "description": "The map of attribute keys to values."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_patch_callback_participant_communication

Update conversation participant’s communication by disconnecting it. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`communicationId`	string	Yes	—	communicationId
`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.
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	wrapup
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "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."
    },
    "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": "wrapup"
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "communicationId"
  ]
}

genesys_conversations_patch_callbacks

Update a scheduled callback Parameters:

Parameter	Type	Required	Default	Description
`agentId`	string	Yes	—	The agentId.
`callbackNumbers`	any[]	No	—	The callbackNumbers
`callbackScheduledTime`	string	No	—	The scheduled date-time for the callback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
`conversationId`	string	Yes	—	The conversationId.
`countryCode`	string	No	—	The countryCode
`queueId`	string	No	—	The identifier of the queue to be used for the callback.
`validateCallbackNumbers`	boolean	No	—	validateCallbackNumbers

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "agentId": {
      "type": "string",
      "description": "The agentId."
    },
    "callbackNumbers": {
      "type": "array",
      "description": "The callbackNumbers"
    },
    "callbackScheduledTime": {
      "type": "string",
      "description": "The scheduled date-time for the callback. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
    },
    "conversationId": {
      "type": "string",
      "description": "The conversationId."
    },
    "countryCode": {
      "type": "string",
      "description": "The countryCode"
    },
    "queueId": {
      "type": "string",
      "description": "The identifier of the queue to be used for the callback."
    },
    "validateCallbackNumbers": {
      "type": "boolean",
      "description": "validateCallbackNumbers"
    }
  },
  "required": [
    "PCID",
    "agentId",
    "conversationId"
  ]
}

genesys_conversations_patch_conversation_customattributes

Update a single custom attributes record by amending the data with only the provided fields. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`customAttributes`	object	No	—	The map of attribute values.
`divisions`	any[]	No	—	The list of division ids. Use [] if divisions aren’t used (Unassigned Division). Omitting or setting to [] clears existing values on update.
`id`	string	No	—	Unique identifier for the Custom Attributes record. IDs are created by users.
`version`	integer	No	—	The latest version of the Custom Attributes record. Optional for concurrency check.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversation ID"
    },
    "customAttributes": {
      "type": "object",
      "description": "The map of attribute values."
    },
    "divisions": {
      "type": "array",
      "description": "The list of division ids. Use [] if divisions aren't used (Unassigned Division). Omitting or setting to [] clears existing values on update."
    },
    "id": {
      "type": "string",
      "description": "Unique identifier for the Custom Attributes record. IDs are created by users."
    },
    "version": {
      "type": "integer",
      "description": "The latest version of the Custom Attributes record. Optional for concurrency check."
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_patch_conversation_participant

Update a 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.
`state`	string	No	—	The state to update to set for this participant’s communications. Possible values are: ‘connected’ and ‘disconnected’.
`wrapup`	object	No	—	wrapup
`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."
    },
    "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": "wrapup"
    },
    "wrapupSkipped": {
      "type": "boolean",
      "description": "True to skip wrap-up for this participant."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_patch_conversation_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_patch_conversation_secureattributes

Update the secure attributes on a conversation. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`attributes`	object	No	—	The map of attribute keys to values.
`version`	integer	No	—	The version used to detect conflicting updates when using PUT. Not used for PATCH.

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 map of attribute keys to values."
    },
    "version": {
      "type": "integer",
      "description": "The version used to detect conflicting updates when using PUT. Not used for PATCH."
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_patch_conversation_summary_engagements

Update agent’s engagement for the summary. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`summaryId`	string	Yes	—	Summary ID
`status`	string	No	—	Represents the engagements made by the agent in response to the generated summary
`visibility`	string	No	—	Represents the visibility of summary

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "summaryId": {
      "type": "string",
      "description": "Summary ID"
    },
    "status": {
      "type": "string",
      "description": "Represents the engagements made by the agent in response to the generated summary",
      "enum": [
        "Copied",
        "NotCopied",
        "Unknown"
      ]
    },
    "visibility": {
      "type": "string",
      "description": "Represents the visibility of summary",
      "enum": [
        "Presented",
        "NotPresented",
        "Unknown"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "summaryId"
  ]
}

genesys_conversations_patch_conversation_summary_feedback

Update the feedback for the summary. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`summaryId`	string	Yes	—	Summary ID
`rating`	string	No	—	Agent’s rating for the system-generated summary.
`summary`	string	No	—	Agent’s summary for the conversation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "summaryId": {
      "type": "string",
      "description": "Summary ID"
    },
    "rating": {
      "type": "string",
      "description": "Agent’s rating for the system-generated summary.",
      "enum": [
        "Positive",
        "Negative",
        "Unknown"
      ]
    },
    "summary": {
      "type": "string",
      "description": "Agent's summary for the conversation"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "summaryId"
  ]
}

genesys_conversations_patch_conversation_utilizationlabel

Update the utilization label on a conversation. When there is no value provided, the system default label is applied Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`utilizationLabelId`	string	No	—	The utilization label associated with the conversation.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversation ID"
    },
    "utilizationLabelId": {
      "type": "string",
      "description": "The utilization label associated with the conversation."
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_post_analytics_conversations_activity_query

Query for conversation activity observations Parameters:

Parameter	Type	Required	Default	Description
`pageSize`	integer	No	—	The desired page size
`pageNumber`	integer	No	—	The desired page number
`filter`	object	No	—	filter
`groupBy`	any[]	Yes	—	Dimension(s) to group by
`metrics`	any[]	Yes	—	List of requested metrics
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "pageSize": {
      "type": "integer",
      "description": "The desired page size"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The desired page number"
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "groupBy": {
      "type": "array",
      "description": "Dimension(s) to group by"
    },
    "metrics": {
      "type": "array",
      "description": "List of requested metrics"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    }
  },
  "required": [
    "PCID",
    "groupBy",
    "metrics"
  ]
}

genesys_conversations_post_analytics_conversations_aggregates_query

Query for conversation aggregates Parameters:

Parameter	Type	Required	Default	Description
`alternateTimeDimension`	string	No	—	Dimension to use as the alternative timestamp for data in the aggregate. Choosing “eventTime” uses the actual time of the data event.
`filter`	object	No	—	filter
`flattenMultivaluedDimensions`	boolean	No	—	Flattens any multivalued dimensions used in response groups (e.g. [‘a’,‘b’,‘c’]->‘a,b,c’)
`granularity`	string	No	—	Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H
`groupBy`	any[]	No	—	Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.
`interval`	string	Yes	—	Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`metrics`	any[]	Yes	—	Behaves like a SQL SELECT clause. Only named metrics will be retrieved.
`timeZone`	string	No	—	Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is 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
`views`	any[]	No	—	Custom derived metric views

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alternateTimeDimension": {
      "type": "string",
      "description": "Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event.",
      "enum": [
        "eventTime"
      ]
    },
    "filter": {
      "type": "object",
      "description": "filter"
    },
    "flattenMultivaluedDimensions": {
      "type": "boolean",
      "description": "Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')"
    },
    "granularity": {
      "type": "string",
      "description": "Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H"
    },
    "groupBy": {
      "type": "array",
      "description": "Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group."
    },
    "interval": {
      "type": "string",
      "description": "Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "metrics": {
      "type": "array",
      "description": "Behaves like a SQL SELECT clause. Only named metrics will be retrieved."
    },
    "timeZone": {
      "type": "string",
      "description": "Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is 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"
    },
    "views": {
      "type": "array",
      "description": "Custom derived metric views"
    }
  },
  "required": [
    "PCID",
    "interval",
    "metrics"
  ]
}

genesys_conversations_post_analytics_conversations_details_query

Query for conversation details Parameters:

Parameter	Type	Required	Default	Description
`aggregations`	any[]	No	—	Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters
`conversationFilters`	any[]	No	—	Filters that target conversation-level data
`evaluationFilters`	any[]	No	—	Filters that target evaluations
`interval`	string	Yes	—	Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
`order`	string	No	—	Sort the result set in ascending/descending order. Default is ascending
`orderBy`	string	No	—	Specify which data element within the result set to use for sorting. The options to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart
`paging`	object	No	—	paging
`resolutionFilters`	any[]	No	—	Filters that target resolutions
`segmentFilters`	any[]	No	—	Filters that target individual segments within a conversation
`surveyFilters`	any[]	No	—	Filters that target surveys

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "aggregations": {
      "type": "array",
      "description": "Include faceted search and aggregate roll-ups describing your search results. This does not function as a filter, but rather, summary data about the data matching your filters"
    },
    "conversationFilters": {
      "type": "array",
      "description": "Filters that target conversation-level data"
    },
    "evaluationFilters": {
      "type": "array",
      "description": "Filters that target evaluations"
    },
    "interval": {
      "type": "string",
      "description": "Specifies the date and time range of data being queried. Results will only include conversations that started on a day touched by the interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"
    },
    "order": {
      "type": "string",
      "description": "Sort the result set in ascending/descending order. Default is ascending",
      "enum": [
        "asc",
        "desc",
        "unordered"
      ]
    },
    "orderBy": {
      "type": "string",
      "description": "Specify which data element within the result set to use for sorting. The options  to use as a basis for sorting the results: conversationStart, segmentStart, and segmentEnd. If not specified, the default is conversationStart",
      "enum": [
        "conversationStart",
        "conversationEnd",
        "segmentStart",
        "segmentEnd"
      ]
    },
    "paging": {
      "type": "object",
      "description": "paging"
    },
    "resolutionFilters": {
      "type": "array",
      "description": "Filters that target resolutions"
    },
    "segmentFilters": {
      "type": "array",
      "description": "Filters that target individual segments within a conversation"
    },
    "surveyFilters": {
      "type": "array",
      "description": "Filters that target surveys"
    }
  },
  "required": [
    "PCID",
    "interval"
  ]
}

genesys_conversations_post_call

Place a new call as part of a callback conversation. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`callNumber`	string	Yes	—	The phone number to dial for this call.
`phoneColumn`	string	No	—	For a dialer preview or scheduled callback, the phone column associated with the phone number

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "callNumber": {
      "type": "string",
      "description": "The phone number to dial for this call."
    },
    "phoneColumn": {
      "type": "string",
      "description": "For a dialer preview or scheduled callback, the phone column associated with the phone number"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "callNumber"
  ]
}

genesys_conversations_post_call_participant_barge

Barge a given participant’s call creating a barged in conference of connected participants. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId

Show inputSchema

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

genesys_conversations_post_call_participant_coach

Listen in on the conversation from the point of view of a given participant while speaking to just the given participant. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId

Show inputSchema

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

genesys_conversations_post_call_participant_communication_wrapup

Apply wrap-up for this conversation communication Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`communicationId`	string	Yes	—	communicationId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "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_post_call_participant_consult_agent

Initiate a consult transfer to an agent Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`consultingUserId`	string	No	—	The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID
`speakTo`	string	Yes	—	Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION
`userDisplayName`	string	No	—	The name of the internal user.
`userId`	string	No	—	The id of the internal user.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "consultingUserId": {
      "type": "string",
      "description": "The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"
    },
    "speakTo": {
      "type": "string",
      "description": "Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION",
      "enum": [
        "DESTINATION",
        "OBJECT",
        "BOTH",
        "CONFERENCE"
      ]
    },
    "userDisplayName": {
      "type": "string",
      "description": "The name of the internal user."
    },
    "userId": {
      "type": "string",
      "description": "The id of the internal user."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "speakTo"
  ]
}

genesys_conversations_post_call_participant_consult_contact_external

Initiate a consult transfer to an external contact Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`consultingUserId`	string	No	—	The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID
`contactId`	string	Yes	—	The external contact id.
`phoneType`	string	Yes	—	The external contact phone type.
`speakTo`	string	Yes	—	Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "consultingUserId": {
      "type": "string",
      "description": "The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"
    },
    "contactId": {
      "type": "string",
      "description": "The external contact id."
    },
    "phoneType": {
      "type": "string",
      "description": "The external contact phone type.",
      "enum": [
        "WorkPhone",
        "CellPhone",
        "HomePhone",
        "OtherPhone"
      ]
    },
    "speakTo": {
      "type": "string",
      "description": "Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION",
      "enum": [
        "DESTINATION",
        "OBJECT",
        "BOTH",
        "CONFERENCE"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "contactId",
    "phoneType",
    "speakTo"
  ]
}

genesys_conversations_post_call_participant_consult_queue

Initiate a consult transfer to a queue Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`consultingUserId`	string	No	—	The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID
`queueId`	string	No	—	The id of the queue.
`queueName`	string	No	—	The name of the queue.
`speakTo`	string	Yes	—	Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "consultingUserId": {
      "type": "string",
      "description": "The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"
    },
    "queueId": {
      "type": "string",
      "description": "The id of the queue."
    },
    "queueName": {
      "type": "string",
      "description": "The name of the queue."
    },
    "speakTo": {
      "type": "string",
      "description": "Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION",
      "enum": [
        "DESTINATION",
        "OBJECT",
        "BOTH",
        "CONFERENCE"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "speakTo"
  ]
}

genesys_conversations_post_call_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	—	conversationId
`participantId`	string	Yes	—	participantId

Show inputSchema

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

genesys_conversations_post_call_participant_replace

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

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "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_post_call_participant_voice_consult

Initiate voice consult transfer Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`address`	string	No	—	Destination’s address or phone number.
`consultingUserId`	string	No	—	The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID
`speakTo`	string	Yes	—	Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "address": {
      "type": "string",
      "description": "Destination's address or phone number."
    },
    "consultingUserId": {
      "type": "string",
      "description": "The user ID of the person who wants to talk before completing the transfer. Could be the same of the context user ID"
    },
    "speakTo": {
      "type": "string",
      "description": "Determines to whom the initiating participant is requesting to speak. Defaults to DESTINATION",
      "enum": [
        "DESTINATION",
        "OBJECT",
        "BOTH",
        "CONFERENCE"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "speakTo"
  ]
}

genesys_conversations_post_call_participants

Add participants to a conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`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	—	name
`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": "conversationId"
    },
    "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": "name"
    },
    "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_post_call_participants_user_user_id

Add participants to a conversation on behalf of a user Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`userId`	string	Yes	—	userId
`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	—	name
`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": "conversationId"
    },
    "userId": {
      "type": "string",
      "description": "userId"
    },
    "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": "name"
    },
    "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",
    "userId",
    "participants",
    "startTime"
  ]
}

genesys_conversations_post_callback_participant_communication_wrapup

Apply wrap-up for this conversation communication Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`communicationId`	string	Yes	—	communicationId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "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_post_callback_participant_replace

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

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "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_post_callbacks

Create a Callback Parameters:

Parameter	Type	Required	Default	Description
`callbackNumbers`	any[]	Yes	—	A list of phone numbers for the callback.
`callbackScheduledTime`	string	No	—	The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
`callbackUserName`	string	No	—	The name of the party to be called back.
`callerId`	string	No	—	The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for “callerId” varies.
`callerIdName`	string	No	—	The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for “callerIdName” varies.
`countryCode`	string	No	—	The country code to be associated with the callback numbers.
`data`	object	No	—	A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { “notes”: “ready to close the deal!”, “customerPreferredName”: “Doc” }
`queueId`	string	No	—	The identifier of the queue to be used for the callback. Either queueId or routingData is required.
`routingData`	object	No	—	routingData
`scriptId`	string	No	—	The identifier of the script to be used for the callback
`validateCallbackNumbers`	boolean	No	—	Whether or not to validate the callback numbers for phone number format.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "callbackNumbers": {
      "type": "array",
      "description": "A list of phone numbers for the callback."
    },
    "callbackScheduledTime": {
      "type": "string",
      "description": "The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"
    },
    "callbackUserName": {
      "type": "string",
      "description": "The name of the party to be called back."
    },
    "callerId": {
      "type": "string",
      "description": "The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies."
    },
    "callerIdName": {
      "type": "string",
      "description": "The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies."
    },
    "countryCode": {
      "type": "string",
      "description": "The country code to be associated with the callback numbers."
    },
    "data": {
      "type": "object",
      "description": "A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }"
    },
    "queueId": {
      "type": "string",
      "description": "The identifier of the queue to be used for the callback. Either queueId or routingData is required."
    },
    "routingData": {
      "type": "object",
      "description": "routingData"
    },
    "scriptId": {
      "type": "string",
      "description": "The identifier of the script to be used for the callback"
    },
    "validateCallbackNumbers": {
      "type": "boolean",
      "description": "Whether or not to validate the callback numbers for phone number format."
    }
  },
  "required": [
    "PCID",
    "callbackNumbers"
  ]
}

genesys_conversations_post_calls

Create a call conversation Parameters:

Parameter	Type	Required	Default	Description
`attributes`	object	No	—	The list of attributes to associate with the customer participant.
`callerId`	string	No	—	The caller id phone number for this outbound call.
`callerIdName`	string	No	—	The caller id name for this outbound call.
`callFromQueueId`	string	No	—	The queue ID to call on behalf of.
`callQueueId`	string	No	—	The queue ID to call.
`callUserId`	string	No	—	The user ID to call.
`conversationIds`	any[]	No	—	The list of existing call conversations to merge into a new ad-hoc conference.
`externalContactId`	string	No	—	The external contact with which to associate the call.
`label`	string	No	—	An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level
`languageId`	string	No	—	The language skill ID to use for routing this call (if calling a queue).
`participants`	any[]	No	—	The list of participants to call to create a new ad-hoc conference.
`phoneNumber`	string	No	—	The phone number to dial.
`priority`	integer	No	—	The priority to assign to this call (if calling a queue).
`routingSkillsIds`	any[]	No	—	The skill ID’s to use for routing this call (if calling a queue).
`uuiData`	string	No	—	User to User Information (UUI) data managed by SIP session application.

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."
    },
    "callerId": {
      "type": "string",
      "description": "The caller id phone number for this outbound call."
    },
    "callerIdName": {
      "type": "string",
      "description": "The caller id name for this outbound call."
    },
    "callFromQueueId": {
      "type": "string",
      "description": "The queue ID to call on behalf of."
    },
    "callQueueId": {
      "type": "string",
      "description": "The queue ID to call."
    },
    "callUserId": {
      "type": "string",
      "description": "The user ID to call."
    },
    "conversationIds": {
      "type": "array",
      "description": "The list of existing call conversations to merge into a new ad-hoc conference."
    },
    "externalContactId": {
      "type": "string",
      "description": "The external contact with which to associate the call."
    },
    "label": {
      "type": "string",
      "description": "An optional label that categorizes the conversation.  Max-utilization settings can be configured at a per-label level"
    },
    "languageId": {
      "type": "string",
      "description": "The language skill ID to use for routing this call (if calling a queue)."
    },
    "participants": {
      "type": "array",
      "description": "The list of participants to call to create a new ad-hoc conference."
    },
    "phoneNumber": {
      "type": "string",
      "description": "The phone number to dial."
    },
    "priority": {
      "type": "integer",
      "description": "The priority to assign to this call (if calling a queue)."
    },
    "routingSkillsIds": {
      "type": "array",
      "description": "The skill ID's to use for routing this call (if calling a queue)."
    },
    "uuiData": {
      "type": "string",
      "description": "User to User Information (UUI) data managed by SIP session application."
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_post_calls_user_user_id

Create a call conversation on behalf of a user Parameters:

Parameter	Type	Required	Default	Description
`userId`	string	Yes	—	userId
`attributes`	object	No	—	The list of attributes to associate with the customer participant.
`callerId`	string	No	—	The caller id phone number for this outbound call.
`callerIdName`	string	No	—	The caller id name for this outbound call.
`callFromQueueId`	string	No	—	The queue ID to call on behalf of.
`callQueueId`	string	No	—	The queue ID to call.
`callUserId`	string	No	—	The user ID to call.
`conversationIds`	any[]	No	—	The list of existing call conversations to merge into a new ad-hoc conference.
`externalContactId`	string	No	—	The external contact with which to associate the call.
`label`	string	No	—	An optional label that categorizes the conversation. Max-utilization settings can be configured at a per-label level
`languageId`	string	No	—	The language skill ID to use for routing this call (if calling a queue).
`participants`	any[]	No	—	The list of participants to call to create a new ad-hoc conference.
`phoneNumber`	string	No	—	The phone number to dial.
`priority`	integer	No	—	The priority to assign to this call (if calling a queue).
`routingSkillsIds`	any[]	No	—	The skill ID’s to use for routing this call (if calling a queue).
`uuiData`	string	No	—	User to User Information (UUI) data managed by SIP session application.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "userId": {
      "type": "string",
      "description": "userId"
    },
    "attributes": {
      "type": "object",
      "description": "The list of attributes to associate with the customer participant."
    },
    "callerId": {
      "type": "string",
      "description": "The caller id phone number for this outbound call."
    },
    "callerIdName": {
      "type": "string",
      "description": "The caller id name for this outbound call."
    },
    "callFromQueueId": {
      "type": "string",
      "description": "The queue ID to call on behalf of."
    },
    "callQueueId": {
      "type": "string",
      "description": "The queue ID to call."
    },
    "callUserId": {
      "type": "string",
      "description": "The user ID to call."
    },
    "conversationIds": {
      "type": "array",
      "description": "The list of existing call conversations to merge into a new ad-hoc conference."
    },
    "externalContactId": {
      "type": "string",
      "description": "The external contact with which to associate the call."
    },
    "label": {
      "type": "string",
      "description": "An optional label that categorizes the conversation.  Max-utilization settings can be configured at a per-label level"
    },
    "languageId": {
      "type": "string",
      "description": "The language skill ID to use for routing this call (if calling a queue)."
    },
    "participants": {
      "type": "array",
      "description": "The list of participants to call to create a new ad-hoc conference."
    },
    "phoneNumber": {
      "type": "string",
      "description": "The phone number to dial."
    },
    "priority": {
      "type": "integer",
      "description": "The priority to assign to this call (if calling a queue)."
    },
    "routingSkillsIds": {
      "type": "array",
      "description": "The skill ID's to use for routing this call (if calling a queue)."
    },
    "uuiData": {
      "type": "string",
      "description": "User to User Information (UUI) data managed by SIP session application."
    }
  },
  "required": [
    "PCID",
    "userId"
  ]
}

genesys_conversations_post_conversation_assign

Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`id`	string	Yes	—	The globally unique identifier for this user.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversation ID"
    },
    "id": {
      "type": "string",
      "description": "The globally unique identifier for this user."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "id"
  ]
}

genesys_conversations_post_conversation_barge

Barge a conversation creating a barged in conference of connected participants. 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_post_conversation_cobrowse

Creates a cobrowse session. Requires “conversation:cobrowse:add” (for web messaging) or “conversation:cobrowsevoice:add” permission. 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_post_conversation_communication_agentchecklist

Agent Checklist activation API Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`communicationId`	string	Yes	—	Communication ID
`agentChecklistId`	string	Yes	—	Agent Checklist ID
`activationTriggerType`	string	Yes	—	Trigger type that activated this checklist.
`agentId`	string	No	—	Agent ID.
`assistantId`	string	No	—	Assistant ID.
`direction`	string	No	—	Direction of the conversation.
`intentId`	string	No	—	The intent ID if checklist was triggered by an intent.
`intentName`	string	No	—	The intent name if checklist was triggered by an intent.
`language`	string	Yes	—	Language associated with the checklist.
`mediaType`	string	No	—	Media type.
`participantId`	string	No	—	Participant ID.
`queueId`	string	No	—	Queue 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"
    },
    "agentChecklistId": {
      "type": "string",
      "description": "Agent Checklist ID"
    },
    "activationTriggerType": {
      "type": "string",
      "description": "Trigger type that activated this checklist.",
      "enum": [
        "Intent",
        "ConversationStart"
      ]
    },
    "agentId": {
      "type": "string",
      "description": "Agent ID."
    },
    "assistantId": {
      "type": "string",
      "description": "Assistant ID."
    },
    "direction": {
      "type": "string",
      "description": "Direction of the conversation.",
      "enum": [
        "Inbound",
        "Outbound"
      ]
    },
    "intentId": {
      "type": "string",
      "description": "The intent ID if checklist was triggered by an intent."
    },
    "intentName": {
      "type": "string",
      "description": "The intent name if checklist was triggered by an intent."
    },
    "language": {
      "type": "string",
      "description": "Language associated with the checklist."
    },
    "mediaType": {
      "type": "string",
      "description": "Media type.",
      "enum": [
        "Voice",
        "Message",
        "Email"
      ]
    },
    "participantId": {
      "type": "string",
      "description": "Participant ID."
    },
    "queueId": {
      "type": "string",
      "description": "Queue ID."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "agentChecklistId",
    "activationTriggerType",
    "language"
  ]
}

genesys_conversations_post_conversation_communication_agentchecklist_agentaction

API invoked to capture an agent action. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`communicationId`	string	Yes	—	Communication ID
`agentChecklistId`	string	Yes	—	Agent Checklist ID
`afterCallWork`	boolean	No	—	Boolean flag to indicate if the agent action is in ACW stage.
`checklistItems`	any[]	Yes	—	The list of checklist items and the agent action taken on each one of them.

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"
    },
    "agentChecklistId": {
      "type": "string",
      "description": "Agent Checklist ID"
    },
    "afterCallWork": {
      "type": "boolean",
      "description": "Boolean flag to indicate if the agent action is in ACW stage."
    },
    "checklistItems": {
      "type": "array",
      "description": "The list of checklist items and the agent action taken on each one of them."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "agentChecklistId",
    "checklistItems"
  ]
}

genesys_conversations_post_conversation_communication_agentchecklist_jobs

Create inference job Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`communicationId`	string	Yes	—	Communication ID
`agentChecklistId`	string	Yes	—	Agent Checklist ID
`conversationContext`	any[]	Yes	—	List of conversations on which checklist evaluation is to be done.

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"
    },
    "agentChecklistId": {
      "type": "string",
      "description": "Agent Checklist ID"
    },
    "conversationContext": {
      "type": "array",
      "description": "List of conversations on which checklist evaluation is to be done."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "agentChecklistId",
    "conversationContext"
  ]
}

genesys_conversations_post_conversation_communication_agentchecklists_finalize

API invoked to finalize agent checklist evaluation. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`communicationId`	string	Yes	—	Communication ID
`exitReason`	string	Yes	—	Exit reason provided at the time of finalizing the checklist.

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"
    },
    "exitReason": {
      "type": "string",
      "description": "Exit reason provided at the time of finalizing the checklist."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "exitReason"
  ]
}

genesys_conversations_post_conversation_communication_internalmessages

Send internal message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`communicationId`	string	Yes	—	communicationId
`text`	string	Yes	—	The body of the text message.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversationId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "text": {
      "type": "string",
      "description": "The body of the text message."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "communicationId",
    "text"
  ]
}

genesys_conversations_post_conversation_disconnect

Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation. 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_post_conversation_participant_callbacks

Create a new callback for the specified participant on the conversation. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`callbackNumbers`	any[]	No	—	A list of phone numbers for the callback.
`callbackScheduledTime`	string	No	—	The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
`callbackUserName`	string	No	—	The name of the party to be called back.
`callerId`	string	No	—	The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for “callerId” varies.
`callerIdName`	string	No	—	The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for “callerIdName” varies.
`countryCode`	string	No	—	The country code to be associated with the callback numbers.
`data`	object	No	—	A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { “notes”: “ready to close the deal!”, “customerPreferredName”: “Doc” }
`queueId`	string	No	—	The identifier of the queue to be used for the callback. Either queueId or routingData is required.
`routingData`	object	No	—	routingData
`scriptId`	string	No	—	The identifier of the script to be used for the callback
`validateCallbackNumbers`	boolean	No	—	Whether or not to validate the callback numbers for phone number format.

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"
    },
    "callbackNumbers": {
      "type": "array",
      "description": "A list of phone numbers for the callback."
    },
    "callbackScheduledTime": {
      "type": "string",
      "description": "The scheduled date-time for the callback as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ"
    },
    "callbackUserName": {
      "type": "string",
      "description": "The name of the party to be called back."
    },
    "callerId": {
      "type": "string",
      "description": "The phone number displayed to recipients when a phone call is placed as part of the callback. Must conform to the E.164 format. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerId\" varies."
    },
    "callerIdName": {
      "type": "string",
      "description": "The name displayed to recipients when a phone call is placed as part of the callback. May be overridden by other settings in the system such as external trunk settings. Telco support for \"callerIdName\" varies."
    },
    "countryCode": {
      "type": "string",
      "description": "The country code to be associated with the callback numbers."
    },
    "data": {
      "type": "object",
      "description": "A map of key-value pairs containing additional data that can be associated to the callback. These values will appear in the attributes property on the conversation participant. Example: { \"notes\": \"ready to close the deal!\", \"customerPreferredName\": \"Doc\" }"
    },
    "queueId": {
      "type": "string",
      "description": "The identifier of the queue to be used for the callback. Either queueId or routingData is required."
    },
    "routingData": {
      "type": "object",
      "description": "routingData"
    },
    "scriptId": {
      "type": "string",
      "description": "The identifier of the script to be used for the callback"
    },
    "validateCallbackNumbers": {
      "type": "boolean",
      "description": "Whether or not to validate the callback numbers for phone number format."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_post_conversation_participant_digits

Sends DTMF to the participant Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`digits`	string	No	—	A string representing the digits pressed on phone.

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"
    },
    "digits": {
      "type": "string",
      "description": "A string representing the digits pressed on phone."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_post_conversation_participant_internalmessages_users_communications

Setup internal message communication with user Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`targetUserId`	string	Yes	—	The user ID of the target.

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"
    },
    "targetUserId": {
      "type": "string",
      "description": "The user ID of the target."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "targetUserId"
  ]
}

genesys_conversations_post_conversation_participant_replace_agent

Replace this participant with the specified agent Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`keepInternalMessageAlive`	boolean	No	—	If true, the digital internal message will NOT be terminated.
`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.
`userDisplayName`	string	No	—	The name of the internal user.
`userId`	string	No	—	The id of the internal user.
`userName`	string	No	—	The userName (like user’s email) of the internal user.
`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"
    },
    "keepInternalMessageAlive": {
      "type": "boolean",
      "description": "If true, the digital internal message will NOT be terminated."
    },
    "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"
      ]
    },
    "userDisplayName": {
      "type": "string",
      "description": "The name of the internal user."
    },
    "userId": {
      "type": "string",
      "description": "The id of the internal user."
    },
    "userName": {
      "type": "string",
      "description": "The userName (like user’s email) of the internal user."
    },
    "voicemail": {
      "type": "boolean",
      "description": "If true, transfer to the voicemail inbox of the participant that is being replaced."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_post_conversation_participant_replace_contact_external

Replace this participant with the an external contact Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`contactId`	string	Yes	—	The external contact id.
`keepInternalMessageAlive`	boolean	No	—	If true, the digital internal message will NOT be terminated.
`phoneType`	string	Yes	—	The external contact phone type.
`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.

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"
    },
    "contactId": {
      "type": "string",
      "description": "The external contact id."
    },
    "keepInternalMessageAlive": {
      "type": "boolean",
      "description": "If true, the digital internal message will NOT be terminated."
    },
    "phoneType": {
      "type": "string",
      "description": "The external contact phone type.",
      "enum": [
        "WorkPhone",
        "CellPhone",
        "HomePhone",
        "OtherPhone"
      ]
    },
    "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"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId",
    "contactId",
    "phoneType"
  ]
}

genesys_conversations_post_conversation_participant_replace_queue

Replace this participant with the specified queue Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`keepInternalMessageAlive`	boolean	No	—	If true, the digital internal message will NOT be terminated.
`queueId`	string	No	—	The id of the queue.
`queueName`	string	No	—	The name of the queue.
`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.

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"
    },
    "keepInternalMessageAlive": {
      "type": "boolean",
      "description": "If true, the digital internal message will NOT be terminated."
    },
    "queueId": {
      "type": "string",
      "description": "The id of the queue."
    },
    "queueName": {
      "type": "string",
      "description": "The name of the queue."
    },
    "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"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_post_conversation_participant_secureivrsessions

Create secure IVR session. Only a participant in the conversation can invoke a secure IVR. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`disconnect`	boolean	No	—	if true, disconnect the agent after creating the session
`flowId`	string	No	—	the flow id to execute in the secure session
`sourceParticipantId`	string	No	—	requesting participant
`userData`	string	No	—	user data for the secure session

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"
    },
    "disconnect": {
      "type": "boolean",
      "description": "if true, disconnect the agent after creating the session"
    },
    "flowId": {
      "type": "string",
      "description": "the flow id to execute in the secure session"
    },
    "sourceParticipantId": {
      "type": "string",
      "description": "requesting participant"
    },
    "userData": {
      "type": "string",
      "description": "user data for the secure session"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_post_conversation_participant_transfer

Replace this participant by another one using the address of the destination. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`participantId`	string	Yes	—	participant ID
`address`	string	No	—	User’s name, queue’s name, destination’s address or phone number.
`keepInternalMessageAlive`	boolean	No	—	If true, the digital internal message will NOT be terminated.
`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.

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": "User's name, queue's name, destination's address or phone number."
    },
    "keepInternalMessageAlive": {
      "type": "boolean",
      "description": "If true, the digital internal message will NOT be terminated."
    },
    "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"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "participantId"
  ]
}

genesys_conversations_post_conversation_suggestion_engagement

Save an engagement on the suggestion. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`suggestionId`	string	Yes	—	Suggestion ID
`engagementType`	string	Yes	—	The type of engagement with the suggestion.
`feedback`	object	No	—	feedback

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "suggestionId": {
      "type": "string",
      "description": "Suggestion ID"
    },
    "engagementType": {
      "type": "string",
      "description": "The type of engagement with the suggestion.",
      "enum": [
        "Dismissed",
        "Copied",
        "Opened",
        "Feedback"
      ]
    },
    "feedback": {
      "type": "object",
      "description": "feedback"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "suggestionId",
    "engagementType"
  ]
}

genesys_conversations_post_conversation_summary_feedback

Submit feedback for the summary. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation ID
`summaryId`	string	Yes	—	Summary ID
`rating`	string	No	—	Agent’s rating for the system-generated summary.
`summary`	string	No	—	Agent’s summary for the conversation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation ID"
    },
    "summaryId": {
      "type": "string",
      "description": "Summary ID"
    },
    "rating": {
      "type": "string",
      "description": "Agent’s rating for the system-generated summary.",
      "enum": [
        "Positive",
        "Negative",
        "Unknown"
      ]
    },
    "summary": {
      "type": "string",
      "description": "Agent's summary for the conversation"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "summaryId"
  ]
}

genesys_conversations_post_conversations_call_participant_communication_wrapup

Apply wrap-up for this conversation communication Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversationId
`participantId`	string	Yes	—	participantId
`communicationId`	string	Yes	—	communicationId
`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": "conversationId"
    },
    "participantId": {
      "type": "string",
      "description": "participantId"
    },
    "communicationId": {
      "type": "string",
      "description": "communicationId"
    },
    "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_post_conversations_participants_attributes_search

Search conversations Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	cursor
`query`	any[]	No	—	query
`returnFields`	any[]	No	—	returnFields
`sort`	any[]	No	—	Multi-value sort order, list of multiple sort values
`sortBy`	string	No	—	The field in the resource that you want to sort the results by
`sortOrder`	string	No	—	The sort order for results

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "cursor"
    },
    "query": {
      "type": "array",
      "description": "query"
    },
    "returnFields": {
      "type": "array",
      "description": "returnFields"
    },
    "sort": {
      "type": "array",
      "description": "Multi-value sort order, list of multiple sort values"
    },
    "sortBy": {
      "type": "string",
      "description": "The field in the resource that you want to sort the results by"
    },
    "sortOrder": {
      "type": "string",
      "description": "The sort order for results",
      "enum": [
        "ASC",
        "DESC",
        "SCORE"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_post_customattributes_search

Search resources. Parameters:

Parameter	Type	Required	Default	Description
`expand`	any[]	No	—	Expand your search with bulk lookups
`pageNumber`	integer	No	—	The page of resources you want to retrieve
`pageSize`	integer	No	—	The number of results per page
`sort`	any[]	No	—	Multi-value sort order, list of multiple sort values
`sortBy`	string	No	—	The field in the resource that you want to sort the results by
`sortOrder`	string	No	—	The sort order for results

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "expand": {
      "type": "array",
      "description": "Expand your search with bulk lookups"
    },
    "pageNumber": {
      "type": "integer",
      "description": "The page of resources you want to retrieve"
    },
    "pageSize": {
      "type": "integer",
      "description": "The number of results per page"
    },
    "sort": {
      "type": "array",
      "description": "Multi-value sort order, list of multiple sort values"
    },
    "sortBy": {
      "type": "string",
      "description": "The field in the resource that you want to sort the results by"
    },
    "sortOrder": {
      "type": "string",
      "description": "The sort order for results",
      "enum": [
        "ASC",
        "DESC",
        "SCORE"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_post_participants_attributes_search

Search conversations Parameters:

Parameter	Type	Required	Default	Description
`cursor`	string	No	—	cursor
`query`	any[]	No	—	query
`returnFields`	any[]	No	—	returnFields
`sort`	any[]	No	—	Multi-value sort order, list of multiple sort values
`sortBy`	string	No	—	The field in the resource that you want to sort the results by
`sortOrder`	string	No	—	The sort order for results

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "cursor"
    },
    "query": {
      "type": "array",
      "description": "query"
    },
    "returnFields": {
      "type": "array",
      "description": "returnFields"
    },
    "sort": {
      "type": "array",
      "description": "Multi-value sort order, list of multiple sort values"
    },
    "sortBy": {
      "type": "string",
      "description": "The field in the resource that you want to sort the results by"
    },
    "sortOrder": {
      "type": "string",
      "description": "The sort order for results",
      "enum": [
        "ASC",
        "DESC",
        "SCORE"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

genesys_conversations_put_conversation_customattributes

Create or update a single custom attributes record. Updating replaces all data with the provided fields. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`customAttributes`	object	No	—	The map of attribute values.
`divisions`	any[]	No	—	The list of division ids. Use [] if divisions aren’t used (Unassigned Division). Omitting or setting to [] clears existing values on update.
`id`	string	No	—	Unique identifier for the Custom Attributes record. IDs are created by users.
`schemaId`	string	No	—	The id of the schema that dictates which attributes can be included. Required for create, cannot be updated.
`version`	integer	No	—	The latest version of the Custom Attributes record. Optional for concurrency check on update.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversation ID"
    },
    "customAttributes": {
      "type": "object",
      "description": "The map of attribute values."
    },
    "divisions": {
      "type": "array",
      "description": "The list of division ids. Use [] if divisions aren't used (Unassigned Division). Omitting or setting to [] clears existing values on update."
    },
    "id": {
      "type": "string",
      "description": "Unique identifier for the Custom Attributes record. IDs are created by users."
    },
    "schemaId": {
      "type": "string",
      "description": "The id of the schema that dictates which attributes can be included. Required for create, cannot be updated."
    },
    "version": {
      "type": "integer",
      "description": "The latest version of the Custom Attributes record. Optional for concurrency check on update."
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_put_conversation_participant_flaggedreason

Set flagged reason on conversation participant to indicate bad conversation quality. 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_put_conversation_secureattributes

Set the secure attributes on a conversation. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`attributes`	object	No	—	The map of attribute keys to values.
`version`	integer	No	—	The version used to detect conflicting updates when using PUT. Not used for PATCH.

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 map of attribute keys to values."
    },
    "version": {
      "type": "integer",
      "description": "The version used to detect conflicting updates when using PUT. Not used for PATCH."
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

genesys_conversations_put_conversation_tags

Update the tags on a conversation. Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	conversation ID
`externalTag`	string	Yes	—	The external tag associated with the conversation.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "conversation ID"
    },
    "externalTag": {
      "type": "string",
      "description": "The external tag associated with the conversation."
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "externalTag"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​genesys_conversations_delete_call_participant_consult

​genesys_conversations_delete_conversation

​genesys_conversations_delete_conversation_customattribute

​genesys_conversations_delete_conversation_participant_code

​genesys_conversations_delete_conversation_participant_flaggedreason

​genesys_conversations_get_analytics_conversation_details

​genesys_conversations_get_analytics_conversations_details

​genesys_conversations_get_analytics_conversations_details_job_results

​genesys_conversations_get_call

​genesys_conversations_get_call_participant_communication_wrapup

​genesys_conversations_get_call_participant_wrapup

​genesys_conversations_get_call_participant_wrapupcodes

​genesys_conversations_get_callback

​genesys_conversations_get_callback_participant_communication_wrapup

​genesys_conversations_get_callback_participant_wrapup

​genesys_conversations_get_callback_participant_wrapupcodes

​genesys_conversations_get_callbacks

​genesys_conversations_get_calls

​genesys_conversations_get_calls_history

​genesys_conversations_get_conversation

​genesys_conversations_get_conversation_communication_agentchecklist

​genesys_conversations_get_conversation_communication_agentchecklist_job

​genesys_conversations_get_conversation_communication_agentchecklists

​genesys_conversations_get_conversation_communication_internalmessage

​genesys_conversations_get_conversation_communication_internalmessages

​genesys_conversations_get_conversation_customattribute

​genesys_conversations_get_conversation_customattributes

​genesys_conversations_get_conversation_participant_secureivrsession

​genesys_conversations_get_conversation_participant_secureivrsessions

​genesys_conversations_get_conversation_participant_wrapup

​genesys_conversations_get_conversation_participant_wrapupcodes

​genesys_conversations_get_conversation_secureattributes

​genesys_conversations_get_conversation_suggestion

​genesys_conversations_get_conversation_suggestions

​genesys_conversations_get_conversation_summaries

​genesys_conversations_get_conversations

​genesys_conversations_get_conversations_call

​genesys_conversations_get_conversations_callback

​genesys_conversations_get_conversations_callbacks

​genesys_conversations_get_conversations_calls

​genesys_conversations_get_conversations_calls_history

​genesys_conversations_get_conversations_email

​genesys_conversations_get_conversations_emails

​genesys_conversations_get_conversations_message

​genesys_conversations_get_conversations_messages

​genesys_conversations_patch_call

​genesys_conversations_patch_call_conference

​genesys_conversations_patch_call_participant

​genesys_conversations_patch_call_participant_attributes

​genesys_conversations_patch_call_participant_communication

​genesys_conversations_patch_call_participant_consult

​genesys_conversations_patch_call_participant_user_user_id

​genesys_conversations_patch_callback

​genesys_conversations_patch_callback_participant

​genesys_conversations_patch_callback_participant_attributes

​genesys_conversations_patch_callback_participant_communication

​genesys_conversations_patch_callbacks

​genesys_conversations_patch_conversation_customattributes

​genesys_conversations_patch_conversation_participant

​genesys_conversations_patch_conversation_participant_attributes

​genesys_conversations_patch_conversation_secureattributes

​genesys_conversations_patch_conversation_summary_engagements

​genesys_conversations_patch_conversation_summary_feedback

​genesys_conversations_patch_conversation_utilizationlabel

​genesys_conversations_post_analytics_conversations_activity_query

​genesys_conversations_post_analytics_conversations_aggregates_query

​genesys_conversations_post_analytics_conversations_details_query

​genesys_conversations_post_call

​genesys_conversations_post_call_participant_barge

​genesys_conversations_post_call_participant_coach

​genesys_conversations_post_call_participant_communication_wrapup

​genesys_conversations_post_call_participant_consult_agent

​genesys_conversations_post_call_participant_consult_contact_external

​genesys_conversations_post_call_participant_consult_queue

​genesys_conversations_post_call_participant_monitor

Tools

genesys_conversations_delete_call_participant_consult

genesys_conversations_delete_conversation

genesys_conversations_delete_conversation_customattribute

genesys_conversations_delete_conversation_participant_code

genesys_conversations_delete_conversation_participant_flaggedreason

genesys_conversations_get_analytics_conversation_details

genesys_conversations_get_analytics_conversations_details

genesys_conversations_get_analytics_conversations_details_job_results

genesys_conversations_get_call

genesys_conversations_get_call_participant_communication_wrapup

genesys_conversations_get_call_participant_wrapup

genesys_conversations_get_call_participant_wrapupcodes

genesys_conversations_get_callback

genesys_conversations_get_callback_participant_communication_wrapup

genesys_conversations_get_callback_participant_wrapup

genesys_conversations_get_callback_participant_wrapupcodes

genesys_conversations_get_callbacks

genesys_conversations_get_calls

genesys_conversations_get_calls_history

genesys_conversations_get_conversation

genesys_conversations_get_conversation_communication_agentchecklist

genesys_conversations_get_conversation_communication_agentchecklist_job

genesys_conversations_get_conversation_communication_agentchecklists

genesys_conversations_get_conversation_communication_internalmessage

genesys_conversations_get_conversation_communication_internalmessages

genesys_conversations_get_conversation_customattribute

genesys_conversations_get_conversation_customattributes

genesys_conversations_get_conversation_participant_secureivrsession

genesys_conversations_get_conversation_participant_secureivrsessions

genesys_conversations_get_conversation_participant_wrapup

genesys_conversations_get_conversation_participant_wrapupcodes

genesys_conversations_get_conversation_secureattributes

genesys_conversations_get_conversation_suggestion

genesys_conversations_get_conversation_suggestions

genesys_conversations_get_conversation_summaries

genesys_conversations_get_conversations

genesys_conversations_get_conversations_call

genesys_conversations_get_conversations_callback

genesys_conversations_get_conversations_callbacks

genesys_conversations_get_conversations_calls

genesys_conversations_get_conversations_calls_history

genesys_conversations_get_conversations_email

genesys_conversations_get_conversations_emails

genesys_conversations_get_conversations_message

genesys_conversations_get_conversations_messages

genesys_conversations_patch_call

genesys_conversations_patch_call_conference

genesys_conversations_patch_call_participant

genesys_conversations_patch_call_participant_attributes

genesys_conversations_patch_call_participant_communication

genesys_conversations_patch_call_participant_consult

genesys_conversations_patch_call_participant_user_user_id

genesys_conversations_patch_callback

genesys_conversations_patch_callback_participant

genesys_conversations_patch_callback_participant_attributes

genesys_conversations_patch_callback_participant_communication

genesys_conversations_patch_callbacks

genesys_conversations_patch_conversation_customattributes

genesys_conversations_patch_conversation_participant

genesys_conversations_patch_conversation_participant_attributes

genesys_conversations_patch_conversation_secureattributes

genesys_conversations_patch_conversation_summary_engagements

genesys_conversations_patch_conversation_summary_feedback

genesys_conversations_patch_conversation_utilizationlabel

genesys_conversations_post_analytics_conversations_activity_query

genesys_conversations_post_analytics_conversations_aggregates_query

genesys_conversations_post_analytics_conversations_details_query

genesys_conversations_post_call

genesys_conversations_post_call_participant_barge

genesys_conversations_post_call_participant_coach

genesys_conversations_post_call_participant_communication_wrapup

genesys_conversations_post_call_participant_consult_agent

genesys_conversations_post_call_participant_consult_contact_external

genesys_conversations_post_call_participant_consult_queue

genesys_conversations_post_call_participant_monitor

genesys_conversations_post_call_participant_replace

genesys_conversations_post_call_participant_voice_consult

genesys_conversations_post_call_participants

genesys_conversations_post_call_participants_user_user_id