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

Gets the details of a message room with a specified 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}

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 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

Domain ID

 
channelId string 

Message room ID

 
title string 

Message room name


maxLength : 1000 
channelType object (channelType) 
 

channelType

PropertyTypeDescription
type string 

Message room type

  • "SINGLE_USER": 1:1 message room
  • "MULTI_USERS": 1:N message room "ORGUNIT", Team message room
  • "GROUP": Group message room
 
orgUnitId string 

Team ID. It is returned only for a team message room.

 
groupId string 

Group ID. It is returned only for a group message room.

 

Response Example

example

1{2  "domainId": 10000001,3  "channelId": "12345a12-b12c-12d3-e123fghijkl",4  "title": "Example title",5  "channelType": {6    "type": "MULTI_USERS"7  }8}