ChatParticipant

Get a chat participant

Use the select query parameter to specify which fields to include.

get/public/v1/helpdesk/chats/{chatId}/participants/{id}

Request

  • Base URL: https://api.platform.softwareone.com
  • URL: https://api.platform.softwareone.com/public/v1/helpdesk/chats/{chatId}/participants/{id}
  • Auth: none declared

Path parameters

chatIdstring required

The chat ID.

idstring required

The participant ID.

Query parameters

selectstring

Optional RQL select statement to filter fields.

Response

OK

idstring
revisioninteger
mutedboolean

Flag indicates whether participant should be notified of new messages in the chat.

status'Active' | 'Exited' | 'Deactivated'
unreadMessageCountinteger

The count of messages in the chat not read by this participant.

Changes

No recorded changes to this operation across all 1 revision of this API.