Developer Hub
Relation ProtocolRelation ONE APIRelation Graph API
English
English
  • Overview
    • RelationONE
  • Developer Guide
    • Glossary
    • Service Address
    • Rate Limits
    • JS-SDK
    • Quick Start
  • Introducing Relation ONE IM
  • API
    • Introduction
    • Signature
    • Auth
    • Profile
      • Bind Address
      • Unbind Address
      • User Info
      • List Address
      • Web2 Account
    • Follows
      • Follow
      • Unfollow
      • Follower
      • Following
      • Web3 Follower
      • Web3 Following
    • Recommendation
    • Groups
      • Create
      • Join
      • Remove Members
      • Leave
      • Disband
      • Transfer Owner
      • Info
      • Members
      • Is Admin
      • Get Announcement
      • Update Announcement
    • Chats
      • Pin
      • Mute
      • List
      • Hide
    • Message
      • Send
      • Read
      • Hide
      • List
      • Unread Count
  • JS-SDK
    • Relation-Auth
      • Quick Start
      • Method
    • IM-JS-SDK
      • Quick Start
      • Static Method
      • Events
      • Method
      • Parse Message
    • Plugin-JS-SDK
      • Quick Start
  • Appendix
    • Error Code
    • Contract Address
Powered by GitBook
On this page
  1. API
  2. Groups

Members

GET api/v1/channel/members

  • Note: To query the list of members in the group chat. Only group members have access.

  • Header

Field
Type
Remarks

ApiKey

String

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

Array[MemberInfo]

the data

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": [
        {
            "relationId": "dhkyq-sqaaa-aaaaj-sgz3q-cai",
            "name": "0x1e56",
            "avatar": "",
            "isAdmin": false
        }
    ]
}
  • Return Code

code
desc
Remarks

0

success

the flag for a successful request

13102

You have been removed from the chat

You have been removed from the chat.

13103

You have left the group chat

You have left the group chat.

13104

Chat has been dismissed

This group chat has been dismissed.

PreviousInfoNextIs Admin

Last updated 2 years ago

acquired from the admin

ApiKey