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

Bot が参加しているトークルームの情報を取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

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 

チャンネル ID (= トークルーム ID)

参考
トークルーム画面のメニューにある「チャンネル ID」からも、channelId を確認できます。


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

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

ドメイン ID

 
channelId string 

トークルーム ID

 
title string 

トークルーム名


maxLength : 1000 
channelType object (channelType) 
 

channelType

PropertyTypeDescription
type string 

トークルームのタイプ

  • SINGLE_USER : 1:1 トークルーム
  • MULTI_USERS : 1:N トークルーム
  • ORGUNIT : 組織のトークルーム
  • GROUP : グループのトークルーム
 
orgUnitId string 

組織 ID (組織のトークルームの場合にのみ含まれる)

 
groupId string 

グループ ID (グループのトークルームの場合にのみ含まれる)

 

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}