トーク Bot のドメイン登録
トーク Bot の利用ドメインを登録します。
ドメイン登録を行う前に、 トーク Botのテナント登録 API を使ってトーク Bot をテナントに登録してくだい。
Bot リストへの公開 / 非公開はドメインごとに選択できます。
使用権限を 'メンバー指定' に設定した場合、トーク Bot の利用を特定メンバーのみに制限することができます。
注意
- メンバー指定は最大 150 名まで登録できます。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/domain/{domainId}
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Path Parameters
パラメーター | 必須 | 説明 |
---|---|---|
botNo | Y | トーク Bot 番号 |
domainId | Y | ドメイン ID |
Request
パラメーター | タイプ | 必須 | 説明 |
---|---|---|---|
usePublic | boolean | N | Bot リストへの公開 ● true: 公開 ● false: 非公開 (既定) |
usePermission | boolean | N | Bot の利用権限 ● true: メンバー指定 ● false: すべて (既定) |
accountIds | array |
N | usePermission が true の場合、メンバーリスト |
Request Example
simple
POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/domain/456
detail
POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/domain/456
{
"usePublic": true,
"usePermission": true,
"accountIds": ["manager@example.com"]
}
Response
呼び出しに成功すると HTTP 200 コードを返します。
Error Code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードはトーク Bot REST API エラーコードを参照してください。