Info
GET api/v1/channel/info
Note: This is to query the info of a group. Only group members have access.
Header
ApiKey
String
Authorization
String
Bearer ${unifiedAuthToken} , in which the unifiedAuthToken is returned by /api/v1/auth
Request Parameters
channelUuid
String
the uuid of the group chat
Request Example
Response Parameters
code
String
the Return Code
desc
String
the Return Message
data
ChannelDetailInfo
the data
The ChannelDetailInfo field consists of the following subfields:
uuid
String
the uuid of the group chat
name
String
the name of the group chat
icon
String
the icon of the group chat
announcement
String
the announcement of the group chat
pinAnnouncement
boolean
Whether the announcement is sticked on top. True-yes, false-no. The default value is false.
openAccess
boolean
Whether the group has open access. true-yes, false-no. The default value is true, meaning anyone can join the group chat.
type
String
Group Chat Type, enumerated as: G-Regular Group Chat, P-p2p Group Chat
mute
boolean
Whether to mute it. The default value is false.
pin
boolean
Whether it should be sticked on top. True-yes, false-no. The default value is false.
members
Array[MemberInfo]
information on the group members
The MemberInfo field consists of the following subfields: | relationId | String | relationId | | name | String | name | | avatar | String | avatar | | isAdmin | boolean | if this is the admin |
Response Body
Return Code
0
success
the flag for a successful request
13102
You have been removed from the chat
removed from this chat
13103
You have left the group chat
left this chat
13104
Chat has been dismissed
dismissed this chat
Last updated