/genesys-chat | Type: Application | PCID required: Yes
Tools
genesys_chat_delete_chats_room_message
Delete a message in a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomId |
messageId | string | Yes | — | messageId |
genesys_chat_delete_chats_room_messages_pin
Remove a pinned message from a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
pinnedMessageId | string | Yes | — | pinnedMessageId |
genesys_chat_delete_chats_room_participant
Remove a user from a room. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
userId | string | Yes | — | userId |
genesys_chat_delete_chats_user_message
Delete a message to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
messageId | string | Yes | — | messageId |
genesys_chat_delete_chats_user_messages_pin
Remove a pinned message from a 1on1 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
pinnedMessageId | string | Yes | — | pinnedMessageId |
genesys_chat_delete_chats_users_me_settings
Delete a user’s chat settingsgenesys_chat_get_chats_message
Get a message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | messageId |
genesys_chat_get_chats_room
Get a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
genesys_chat_get_chats_room_message
Get messages by id(s) from a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
messageIds | string | Yes | — | messageIds, comma separated |
genesys_chat_get_chats_room_messages
Get a room’s message history Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
limit | string | No | — | The maximum number of messages to retrieve |
before | string | No | — | The cutoff date for messages to retrieve |
after | string | No | — | The beginning date for messages to retrieve |
excludeMetadata | boolean | No | — | Whether to exclude metadata for messages |
genesys_chat_get_chats_room_participant
Get a room participant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
participantJid | string | Yes | — | participantJid |
genesys_chat_get_chats_room_participants
Get room participants in a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
notify | boolean | No | — | Whether to get users to notify |
genesys_chat_get_chats_settings
Get Chat Settings.genesys_chat_get_chats_thread_messages
Get history by thread Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
threadId | string | Yes | — | threadId |
limit | string | No | — | The maximum number of messages to retrieve |
before | string | No | — | The cutoff date for messages to retrieve |
after | string | No | — | The beginning date for messages to retrieve |
excludeMetadata | boolean | No | — | Whether to exclude metadata for messages |
genesys_chat_get_chats_user
Get information for a 1on1 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
genesys_chat_get_chats_user_message
Get messages by id(s) from a 1on1 Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
messageIds | string | Yes | — | messageIds, comma separated |
genesys_chat_get_chats_user_messages
Get 1on1 History between a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
limit | string | No | — | The maximum number of messages to retrieve |
before | string | No | — | The cutoff date for messages to retrieve |
after | string | No | — | The beginning date for messages to retrieve |
excludeMetadata | boolean | No | — | Whether to exclude metadata for messages |
genesys_chat_get_chats_user_settings
Get a user’s chat settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
genesys_chat_get_chats_users_me_settings
Get a user’s chat settingsgenesys_chat_patch_chats_room
Set properties for a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
description | string | No | — | Room’s description |
ownerIds | any[] | No | — | Room’s owners |
pinnedMessageIds | any[] | No | — | Room’s pinned messages |
subject | string | No | — | Room’s subject |
genesys_chat_patch_chats_room_message
Edit a message in a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomId |
messageId | string | Yes | — | messageId |
mentions | any[] | No | — | user ids to be notified |
message | string | Yes | — | The body of the message |
threadId | string | No | — | The thread id of the message |
genesys_chat_patch_chats_settings
Patch Chat Settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageRetentionPeriodDays | integer | No | — | Retention time for messages in days, expressed as int in the range [10,3650] |
reactionsEnabled | boolean | No | — | Reactions enabled for org |
genesys_chat_patch_chats_user_message
Edit a message to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
messageId | string | Yes | — | messageId |
mentions | any[] | No | — | user ids to be notified |
message | string | Yes | — | The body of the message |
threadId | string | No | — | The thread id of the message |
genesys_chat_patch_chats_user_settings
Update a user’s chat settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | User ID |
mobile | object | Yes | — | Settings for mobile devices |
genesys_chat_patch_chats_users_me_settings
Update a user’s chat settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mentionsOnly | boolean | No | — | Whether or not to enable notifications for mentions only |
mobile | object | Yes | — | Settings for mobile devices |
muted | boolean | No | — | Whether or not to enable muting notifications |
notifyOnReactions | boolean | No | — | Whether 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomId |
mentions | any[] | No | — | user ids to be notified |
message | string | Yes | — | The body of the message |
threadId | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
pinnedMessageIds | any[] | Yes | — | Ids of the messages to pin |
genesys_chat_post_chats_room_participant
Join a room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
roomJid | string | Yes | — | roomJid |
userId | string | Yes | — | userId |
genesys_chat_post_chats_rooms
Create an adhoc room Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Room’s description |
subject | string | Yes | — | Room’s subject |
userIds | any[] | No | — | Users to add to the room |
genesys_chat_post_chats_user_messages
Send a message to a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
mentions | any[] | No | — | user ids to be notified |
message | string | Yes | — | The body of the message |
threadId | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
userId | string | Yes | — | userId |
pinnedMessageIds | any[] | Yes | — | Ids of the messages to pin |
genesys_chat_post_chats_users_me_settings
Create a user’s chat settings Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
mentionsOnly | boolean | No | — | Whether or not to enable notifications for mentions only |
muted | boolean | Yes | — | Whether or not to enable muting notifications |
notifyOnReactions | boolean | No | — | Whether 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | Yes | — | messageId |
reactions | any[] | Yes | — | Reactions to update |
genesys_chat_put_chats_settings
Update Chat Settings. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageRetentionPeriodDays | integer | No | — | Retention time for messages in days, expressed as int in the range [10,3650] |
reactionsEnabled | boolean | No | — | Reactions enabled for org |

