This action retrieves a user's count preference of a specific group channel. The count preference allows a user to either retrieve the number of unread messages or unread mentioned messages, or both in a specific group channel.
If you want to update the total number count of a specific group channel, visit the update count preference of a channel.
The following table lists the parameters that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
user_id | string | Specifies the unique ID of a user. |
channel_url | string | Specifies the URL of a group channel. |
If successful, this action returns a user's count preference of a group channel in the response body.
Property name | Type | Description |
---|---|---|
count_preference | string | Indicates whether to only count the number of unread messages or the number of unread mentioned messages in the specified group channel. Only the preferred unread item is counted and added to the total number count. Acceptable values are the following: |
In the case of an error, an error object like below is returned. See the error codes section for more details.