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

봇의 도메인 정보를 등록한다.
봇 도메인은 봇 등록 API에서 사용할 수 있는 도메인 범위에 지정되어야 등록할 수 있다.
봇은 해당 도메인 내에서 공개 혹은 비공개 상태로 사용할 수 있다.
공개 상태로 설정하면 클라이언트의 봇 초대 목록에 노출되어 사용자가 해당 봇을 초대할 수 있다.

주의

  • Admin 페이지의 서비스 > Bot에서 도메인에 봇을 추가하면 사용자에게 서비스 알림이 전송되지만, API로 봇 도메인을 등록하면 사용자에게 서비스 알림이 전송되지 않는다.
  • 동일한 봇의 등록, 수정, 부분 수정, 삭제, 도메인 등록, 도메인 수정, 도메인 부분 수정, 도메인 삭제, 허용 사용자 추가, 허용 사용자 삭제 API를 동시에 호출해서는 안 된다.

Authorization

oauth2

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

Scope

bot

HTTP Request

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

Path Parameters

ParameterTypeDescription
botId integer 

봇 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 

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


default : false 
allowToSelectedMember boolean 

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


default : false 

Request Example

example

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

Response

HTTP 201

OK

PropertyTypeDescription
domainId integer 

도메인 ID


format : int64
readOnly : true 
visible boolean 

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


default : false 
allowToSelectedMember boolean 

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


default : false 

Response Example

example

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