Info

GET api/v1/channel/info

• Note: This is to query the info of a group. Only group members have access.

• Header

Field	Type	Remarks
ApiKey	String	ApiKey acquired from the admin
Authorization	String	Bearer ${unifiedAuthToken} , in which the unifiedAuthToken is returned by /api/v1/auth

• Request Parameters

Field	Type	Remarks
channelUuid	String	the uuid of the group chat

• Request Example

curl POST 'https://api.relationlabs.ai/api/v1/channel/info?channelUuid=4f326124812c41448bc587bf6b2eaf42' \
--header 'ApiKey: <ApiKey>' \
--header 'Authorization: bearer eyJhbGciOi1JFUzI1NiJ9.eyJqdGkiOiI0MzdiN2EzZDEwMGY0ODVkOWVhMWUzZmZl1OWE1NmEyZSIsImlzcyI6InJlbGF0aW9ubGFicy5haSIsImlhdCI6MTY2NTIxNTUzNSwic3ViIjoiZGhreXEtc3FhYWEtYWFhYWotc2d6M3EtY2FpIiwiZXhwIjoxNjY1ODIwMzM1fQ.rj7KKuIcgmvaIwZ63YHnXQ4jvvI-eR2Wo7k3YEyzMu1xo8j5ezCowKDpcW0u9zIuHPFqwD0-1XPWdPLR1d1HLFw'

• Response Parameters

Field	Type	Remarks
code	String	the Return Code
desc	String	the Return Message
data	ChannelDetailInfo	the data

The ChannelDetailInfo field consists of the following subfields:

Field	Type	Remarks
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

{
    "code": "0",
    "desc": "success",
    "data": {
        "uuid": "4f326124812c41448bc587bf6b2eaf42",
        "name": "test-group",
        "icon": "",
        "announcement": "",
        "pinAnnouncement": false,
        "openAccess": true,
        "type": "G",
        "members": [
            {
                "relationId": "dhkyq-sqaaa-aaaaj-sgz3q-cai",
                "name": "0x1e56",
                "avatar": "",
                "isAdmin": true
            },
            {
                "relationId": "qddyo-3aaaa-aaaaj-allxa-cai",
                "name": "test-user",
                "avatar": "",
                "isAdmin": false
            }
        ],
        "mute": false,
        "pin": false
    }
}

• Return Code

code	desc	Remarks
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