トークルームの登録
POST /bots/{botId}/channels
Bot を含むトークルームを登録する。
レスポンスのトークルーム ID を指定してメッセージを送信したり、Bot が所属するトークルームのユーザーリストを取得できる。
Authorization
oauth2
Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。
Scope
bot.message
bot
Request
HTTP Request
POST
https://www.worksapis.com/v1.0/bots/{botId}/channelsPath Parameters
| Parameter | Type | Description |
|---|---|---|
| botId | integer | Bot ID required example : 2000001 format : int64 |
Header Parameters
| Header | type | Description |
|---|---|---|
| Authorization | string | Bearer {token} required |
| Content-Type | string | application/json required example : application/json |
Request Body
| Property | Type | Description |
|---|---|---|
| members | array (string) | 招待するユーザー ID リスト required minItems : 1 maxItems : 100 uniqueItems : true |
| title | string | トークルーム名 maxLength : 1000 |
Request Example
example
1{
2 "members": [
3 "d191e339-3299-44e6-7a44-04d9cb01a5e0"
4 ],
5 "title": "Example title"
6}Response
HTTP 201
OK
| Property | Type | Description |
|---|---|---|
| channelId | string | トークルーム ID required |
| title | string | トークルーム名 maxLength : 1000 |