GET/bots/{botId}/domains

봇이 등록되어 있는 도메인 목록을 조회한다.

등록된 도메인이 50개를 초과할 때는 이전 조회 결과에서 받은 cursor 파라미터를 입력하여 다음 도메인 목록을 계속해서 조회할 수 있다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증을 참고한다.

Scope

bot
bot.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
botId integer 

봇 ID


required
example : 2000001
format : int64 

Query Parameters

ParameterTypeDescription
cursor string 

다음 목록 조회 시 사용하는 커서값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 
count integer 

목록 조회 개수


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) 

도메인 목록

 
responseMetaData object (responseMetaData) 

응답과 관련된 메타 데이터

 

BotDomain

PropertyTypeDescription
domainId integer 

도메인 ID


format : int64
readOnly : true 
visible boolean 

클라이언트 조직도에 봇 항목 공개 여부


default : false 
allowToSelectedMember boolean 

지정한 구성원에게 봇 사용 권한 등록 여부


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}