GET/bots/{botId}/channels/{channelId}/members

Gets a list of members of a message room with a bot included.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

bot.message
bot
bot.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/bots/{botId}/channels/{channelId}/members

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 
channelId string 

Message room ID

Note

  • Select Channel ID from the drawer menu in a message room to view the channelId.

required
example : 12345a12-b12c-12d3-e123fghijkl 

Query Parameters

ParameterTypeDescription
count integer 

Number of items in a list


default : 50
minimum : 1
maximum : 100
example : 60
format : int64 
cursor string 

Cursor value for pagination


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
members array (string) 

List of members

 
responseMetaData object (responseMetaData) 

Response metadata

 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination


required 

Response Example

example

1{2  "members": [3    "560dd110-b4f9-44a4-1322-04bac6fff134",4    "a3d99c51-62bd-4968-1390-041849ad14a5"5  ],6  "responseMetaData": {7    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTYzOTY2ODU2NCwib2Zmc2V0IjoyLCJsaW1pdCI6Mr0="8  }9}