Begin Event

봇과 사용자가 1:1 메시지방을 시작할 때 발생한다.
Begin Event는 아래와 같은 경우에 발생하며, type 속성이 "begin"인 이벤트 객체가 전송된다.

  • 사용자가 봇과의 1:1 메시지방을 생성했을 때
  • API를 이용해 봇이 사용자에게 처음으로 메시지를 보냈을 때
  • API를 이용해 봇과의 1:1 메시지방을 생성했을 때

Request {#begin-event-request}

파라미터타입필수 여부설명
typestringY"begin"으로 고정
sourceobjectYcallback 메시지를 전달한 주체
source.userIdstringY1:1 대화를 시작한 사용자 ID
source.channelIdstringY봇이 초대된 메시지방 ID
source.domainIdnumberY봇이 초대된 도메인 ID
issuedTimestringY이벤트 발생 시각(형식: YYYY-MM-DDThh:mm:ss.SSSZ)
membersarrayY조직/그룹, 1:N 메시지방에 초대된 사용자 목록

Request Example {#begin-event-request-example}

POST /callback HTTP/1.1Host: YOUR_SERVER_HOST_NAMEContent-type: application/json; charset=UTF-8X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=X-WORKS-BotId: 123{  "type": "begin",  "source": {    "userId": "user0001-e3e9-4063-1d22-04978003f354",    "channelId": "12345",    "domainId": 40029600  },  "issuedTime":"2022-01-04T05:16:05.716Z",}

Response(고객사의 메시지 수신 서버 -> 메시지 서버) {#begin-event-response}

호출에 성공하면 HTTP 상태 코드 200을 반환해야 한다.
callback에 의해 전송된 HTTP 요청은 실패해도 다시 전송하지 않는다.

Response {#begin-event-response-example}

HTTP/1.1 200 OKContent-Type: application/jsonServer: YOUR_SERVER_HOST_NAMEContent-Length: 0