Get Announcement
GET api/v1/channel/announcement/get
Note: Get Announcement of a group. Only group members have access.
Header
Field
Type
Remarks
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/announcement/get?channelUuid=4f326124812c41448bc587bf6b2eaf42' \
--header 'ApiKey: <ApiKey>' \
--header 'Authorization: bearer eyJhbGciOi1JFUzI1NiJ9.eyJqdGkiOiI0MzdiN2EzZDEwMGY0ODVkOWVhMWUzZmZlOWE1NmEyZSIsImlzcyI6InJlbGF0aW9ubGFicy5haSIsImlhdCI6MTY2NTIxNTUzNSwic3ViIjoiZGhreXEtc3FhYWEtYWFhYWotc2d6M3EtY2FpIiwiZXhwIjoxNjY11ODIwMzM1fQ.rj7KKuIcgmvaIwZ63YHnXQ4jvvI-eR2Wo7k3YEy1zMuxo8j5ezCowKDpcW0u9zIuHPFqwD0-1XPWdPLR1d1HLFw' \
--header 'Content-Type: application/json'
Response Parameters
Field
Type
Remarks
code
String
the Return Code
desc
String
the Return Message
data
Announcement
the announcement
The Announcement field consists of the following subfields:
Field
Type
Remarks
announcement
String
the announcement
pinAnnouncement
boolean
Whether it should be sticked on top. True-yes,False-no.
Response Body
{
"code": "0",
"desc": "success",
"data": {
"announcement": "1234",
"pinAnnouncement": true
}
}
Return Code
code
desc
Remarks
0
success
the flag for a successful request
13108
Not the member of this group
not a member of current group
Last updated