Begin Event

Bot とメンバーが 1:1 トークルームを開始した際に生じる Callback イベントオブジェクト。
Begin Callback イベントが有効で、下記のいずれかのイベントが発生した場合に送信されます。

  • メンバーが Bot との 1:1 トークルームを開始したとき
  • API により、Bot がメンバーに初めてメッセージを送信したとき
  • API により、Bot とメンバー の 1:1 トークルームを作成したとき

Request {#begin-event-request}

パラメータタイプ説明
typestring"begin"
required
sourceobjectcallback メッセージの内容
required
source.userIdstringBot との 1:1 トークルームを開始したユーザーID
required
source.channelIdstringBot との 1:1 トークルーム ID
required
source.domainIdnumber1:1 トークルームのドメイン ID
required
issuedTimestringメッセージが作成された日時 (YYYY-MM-DDThh:mm:ss.SSSZ)
required

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:05Z"}

Response (トーク Bot のメッセージ受信サーバー -> メッセージサーバー) {#begin-event-response}

Callback を受け取ったボットサーバーから LINE WORKS のメッセージングサーバーへのレスポンスは、ステータスコード 200 で返してください。
Callback で送信された HTTP リクエストは、送信に失敗しても再送されません。

Response {#begin-event-response-example}

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