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

Tools

ToolDescription
genesys_chat_delete_chats_room_messageDelete a message in a room
genesys_chat_delete_chats_room_messages_pinRemove a pinned message from a room
genesys_chat_delete_chats_room_participantRemove a user from a room.
genesys_chat_delete_chats_user_messageDelete a message to a user
genesys_chat_delete_chats_user_messages_pinRemove a pinned message from a 1on1
genesys_chat_delete_chats_users_me_settingsDelete a user’s chat settings
genesys_chat_get_chats_messageGet a message
genesys_chat_get_chats_roomGet a room
genesys_chat_get_chats_room_messageGet messages by id(s) from a room
genesys_chat_get_chats_room_messagesGet a room’s message history
genesys_chat_get_chats_room_participantGet a room participant
genesys_chat_get_chats_room_participantsGet room participants in a room
genesys_chat_get_chats_settingsGet Chat Settings.
genesys_chat_get_chats_thread_messagesGet history by thread
genesys_chat_get_chats_userGet information for a 1on1
genesys_chat_get_chats_user_messageGet messages by id(s) from a 1on1
genesys_chat_get_chats_user_messagesGet 1on1 History between a user
genesys_chat_get_chats_user_settingsGet a user’s chat settings
genesys_chat_get_chats_users_me_settingsGet a user’s chat settings
genesys_chat_patch_chats_roomSet properties for a room
genesys_chat_patch_chats_room_messageEdit a message in a room
genesys_chat_patch_chats_settingsPatch Chat Settings.
genesys_chat_patch_chats_user_messageEdit a message to a user
genesys_chat_patch_chats_user_settingsUpdate a user’s chat settings
genesys_chat_patch_chats_users_me_settingsUpdate a user’s chat settings
genesys_chat_post_chats_room_messagesSend a message to a room
genesys_chat_post_chats_room_messages_pinsAdd pinned messages for a room, up to a maximum of 5 pinned messages
genesys_chat_post_chats_room_participantJoin a room
genesys_chat_post_chats_roomsCreate an adhoc room
genesys_chat_post_chats_user_messagesSend a message to a user
genesys_chat_post_chats_user_messages_pinsAdd pinned messages for a 1on1, up to a maximum of 5 pinned messages
genesys_chat_post_chats_users_me_settingsCreate a user’s chat settings
genesys_chat_put_chats_message_reactionsUpdate reactions to a message
genesys_chat_put_chats_settingsUpdate Chat Settings.

genesys_chat_delete_chats_room_message

Delete a message in a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomId
messageIdstringYesmessageId

genesys_chat_delete_chats_room_messages_pin

Remove a pinned message from a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
pinnedMessageIdstringYespinnedMessageId

genesys_chat_delete_chats_room_participant

Remove a user from a room. Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
userIdstringYesuserId

genesys_chat_delete_chats_user_message

Delete a message to a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId
messageIdstringYesmessageId

genesys_chat_delete_chats_user_messages_pin

Remove a pinned message from a 1on1 Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId
pinnedMessageIdstringYespinnedMessageId

genesys_chat_delete_chats_users_me_settings

Delete a user’s chat settings

genesys_chat_get_chats_message

Get a message Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesmessageId

genesys_chat_get_chats_room

Get a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid

genesys_chat_get_chats_room_message

Get messages by id(s) from a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
messageIdsstringYesmessageIds, comma separated

genesys_chat_get_chats_room_messages

Get a room’s message history Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
limitstringNoThe maximum number of messages to retrieve
beforestringNoThe cutoff date for messages to retrieve
afterstringNoThe beginning date for messages to retrieve
excludeMetadatabooleanNoWhether to exclude metadata for messages

genesys_chat_get_chats_room_participant

Get a room participant Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
participantJidstringYesparticipantJid

genesys_chat_get_chats_room_participants

Get room participants in a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
notifybooleanNoWhether to get users to notify

genesys_chat_get_chats_settings

Get Chat Settings.

genesys_chat_get_chats_thread_messages

Get history by thread Parameters:
ParameterTypeRequiredDefaultDescription
threadIdstringYesthreadId
limitstringNoThe maximum number of messages to retrieve
beforestringNoThe cutoff date for messages to retrieve
afterstringNoThe beginning date for messages to retrieve
excludeMetadatabooleanNoWhether to exclude metadata for messages

genesys_chat_get_chats_user

Get information for a 1on1 Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId

genesys_chat_get_chats_user_message

Get messages by id(s) from a 1on1 Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId
messageIdsstringYesmessageIds, comma separated

genesys_chat_get_chats_user_messages

Get 1on1 History between a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId
limitstringNoThe maximum number of messages to retrieve
beforestringNoThe cutoff date for messages to retrieve
afterstringNoThe beginning date for messages to retrieve
excludeMetadatabooleanNoWhether to exclude metadata for messages

genesys_chat_get_chats_user_settings

Get a user’s chat settings Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID

genesys_chat_get_chats_users_me_settings

Get a user’s chat settings

genesys_chat_patch_chats_room

Set properties for a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
descriptionstringNoRoom’s description
ownerIdsany[]NoRoom’s owners
pinnedMessageIdsany[]NoRoom’s pinned messages
subjectstringNoRoom’s subject

genesys_chat_patch_chats_room_message

Edit a message in a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomId
messageIdstringYesmessageId
mentionsany[]Nouser ids to be notified
messagestringYesThe body of the message
threadIdstringNoThe thread id of the message

genesys_chat_patch_chats_settings

Patch Chat Settings. Parameters:
ParameterTypeRequiredDefaultDescription
messageRetentionPeriodDaysintegerNoRetention time for messages in days, expressed as int in the range [10,3650]
reactionsEnabledbooleanNoReactions enabled for org

genesys_chat_patch_chats_user_message

Edit a message to a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId
messageIdstringYesmessageId
mentionsany[]Nouser ids to be notified
messagestringYesThe body of the message
threadIdstringNoThe thread id of the message

genesys_chat_patch_chats_user_settings

Update a user’s chat settings Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesUser ID
mobileobjectYesSettings for mobile devices

genesys_chat_patch_chats_users_me_settings

Update a user’s chat settings Parameters:
ParameterTypeRequiredDefaultDescription
mentionsOnlybooleanNoWhether or not to enable notifications for mentions only
mobileobjectYesSettings for mobile devices
mutedbooleanNoWhether or not to enable muting notifications
notifyOnReactionsbooleanNoWhether or not to enable notifications for reactions on a user’s own messages

genesys_chat_post_chats_room_messages

Send a message to a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomId
mentionsany[]Nouser ids to be notified
messagestringYesThe body of the message
threadIdstringNoThe thread id of the message

genesys_chat_post_chats_room_messages_pins

Add pinned messages for a room, up to a maximum of 5 pinned messages Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
pinnedMessageIdsany[]YesIds of the messages to pin

genesys_chat_post_chats_room_participant

Join a room Parameters:
ParameterTypeRequiredDefaultDescription
roomJidstringYesroomJid
userIdstringYesuserId

genesys_chat_post_chats_rooms

Create an adhoc room Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoRoom’s description
subjectstringYesRoom’s subject
userIdsany[]NoUsers to add to the room

genesys_chat_post_chats_user_messages

Send a message to a user Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId
mentionsany[]Nouser ids to be notified
messagestringYesThe body of the message
threadIdstringNoThe thread id of the message

genesys_chat_post_chats_user_messages_pins

Add pinned messages for a 1on1, up to a maximum of 5 pinned messages Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYesuserId
pinnedMessageIdsany[]YesIds of the messages to pin

genesys_chat_post_chats_users_me_settings

Create a user’s chat settings Parameters:
ParameterTypeRequiredDefaultDescription
mentionsOnlybooleanNoWhether or not to enable notifications for mentions only
mutedbooleanYesWhether or not to enable muting notifications
notifyOnReactionsbooleanNoWhether or not to enable notifications for reactions on a user’s own messages

genesys_chat_put_chats_message_reactions

Update reactions to a message Parameters:
ParameterTypeRequiredDefaultDescription
messageIdstringYesmessageId
reactionsany[]YesReactions to update

genesys_chat_put_chats_settings

Update Chat Settings. Parameters:
ParameterTypeRequiredDefaultDescription
messageRetentionPeriodDaysintegerNoRetention time for messages in days, expressed as int in the range [10,3650]
reactionsEnabledbooleanNoReactions enabled for org