POST/bots/{botId}/domains/{domainId}

ドメインに Bot を登録する。
ドメイン登録を行う前に、Bot のテナント登録 を使用し Bot をテナントに登録する必要がある。
Bot のテナント登録 で allowDomains パラメータを指定した場合、指定されたドメインのみ登録できる。
Bot リストへの公開/非公開はドメインごとに選択できる。
公開すると Bot 招待リストに表示され、ユーザーが当該 Bot を招待できる。

注意

  • 管理者画面でドメインに Bot を登録した場合、ユーザーにサービス通知が送信されますが、API でドメインに Bot を登録した場合はユーザーにサービス通知は送信されません。
  • 同一の Bot に対して、Bot の テナント登録、更新、部分更新、削除、ドメイン登録、ドメイン更新、ドメイン部分更新、ドメイン削除、利用ユーザーの登録、利用ユーザーの削除 API を同時に呼び出さないでください。

Authorization

oauth2

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

Scope

bot

HTTP Request

POSThttps://www.worksapis.com/v1.0/bots/{botId}/domains/{domainId}

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 
domainId integer 

ドメイン ID


required
example : 10000001
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
visible boolean 

組織図での Bot 公開可否


default : false 
allowToSelectedMember boolean 

メンバーを指定した利用権限の付与の可否

  • true : メンバー指定
  • false : すべて

default : false 

Request Example

example

1{2  "visible": true,3  "allowToSelectedMember": true4}

Response

HTTP 201

OK

PropertyTypeDescription
domainId integer 

Bot のドメイン ID


format : int64
readOnly : true 
visible boolean 

組織図での Bot 公開可否


default : false 
allowToSelectedMember boolean 

メンバーを指定した利用権限の付与の可否

  • true : メンバー指定
  • false : すべて

default : false 

Response Example

example

1{2  "domainId": 10000001,3  "visible": true,4  "allowToSelectedMember": true5}