GET/bots/{botId}/domains

Bot が登録されているドメインリストを取得する。

Authorization

oauth2

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

Scope

bot
bot.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 

Query Parameters

ParameterTypeDescription
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

取得数


required
default : 50
minimum : 1
maximum : 100
example : 60
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
domains array (BotDomain) 

トーク Bot のドメインリスト

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

BotDomain

PropertyTypeDescription
domainId integer 

Bot のドメイン ID


format : int64
readOnly : true 
visible boolean 

組織図での Bot 公開可否


default : false 
allowToSelectedMember boolean 

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

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

default : false 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリストが存在する場合のカーソル値


required 

Response Example

example

1{2  "domains": [3    {4      "domainId": 10000001,5      "visible": true,6      "allowToSelectedMember": true7    }8  ],9  "responseMetaData": {10    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="11  }12}