Message Event

    メンバーが送信したメッセージが含まれた Callback イベントのオブジェクト。
    各メッセージタイプに該当するオブジェクトが message プロパティに含まれます。

    メッセージタイプ 内容 クライアントバージョン
    text テキスト 全バージョンで対応
    location 位置情報 全バージョンで対応
    sticker スタンプ v2.3 以降で対応
    image 画像 v2.3 以降で対応
    file ファイル v2.9 以降で対応

    テキスト

    メンバーが送信したテキストが含まれるオブジェクトです。

    注意

    • 「content.postback」の項目は、message action の postback または「利用開始」ボタンに対応するパラメーターです。postback action の応答は postback event ページを参照してください。

    Request - type "text"

    パラメーター タイプ 必須 説明
    type string Y "message"
    source object Y メッセージ送信者の情報
    source.accountId string Y 送信元メンバーアカウント
    source.roomId string Y 送信したトークルーム ID
    createdTime number Y メッセージが作成された日時。Unix time で表示 (単位: msec)
    content object Y メッセージの内容
    content.type string Y "text"
    content.text string Y メッセージ本文
    content.postback string N postback メッセージ (ボタンなどのテンプレート利用時)

    Request Example - type "text"

    
    POST /callback HTTP/1.1
    Host: YOUR_SERVER_HOST_NAME
    Content-type: application/json; charset=UTF-8
    X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=
    X-WORKS-BotNo: 123
    
    {
      "type": "message",
      "source": {
        "accountId": "admin@example.com",
        "roomId": "12345"
      },
      "createdTime": 1470902041851,
      "content": {
        "type": "text",
        "text": "hello"
      }
    }
    

    位置情報

    メンバーが送信した位置情報が含まれたオブジェクトです。

    Request - type "location"

    パラメーター タイプ 必須 説明
    type string Y "message"
    source object Y メッセージ送信者の情報
    source.accountId string Y 送信元メンバーアカウント
    source.roomId string Y 送信したトークルーム ID
    createdTime number Y メッセージが作成された日時。Unix time で表示 (単位: msec)
    content object Y メッセージの内容
    content.type string Y "location"
    content.address string Y メンバーが送信した位置情報(住所)
    content.latitude number Y メンバーが送信した位置情報(緯度)
    content.longitude number Y メンバーが送信した位置情報(経度)

    Request Example - type "location"

    
    POST /callback HTTP/1.1
    Host: YOUR_SERVER_HOST_NAME
    Content-type: application/json; charset=UTF-8
    X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=
    X-WORKS-BotNo: 123
    
    {
      "type": "message",
      "source": {
        "accountId": "admin@example.com",
        "roomId": "12345
      },
      "createdTime": 1508062056427,
      "content": {
        "type": "location",
        "address": "〒150-0002 東京都渋谷区渋谷2丁目15−1",
        "latitude": 35.6587750,
        "longitude": 139.7052230
      }
    }
    

    スタンプ

    メンバーが送信したスタンプ情報が含まれたオブジェクトです。
    LINE WORKS スタンプのスタンプ ID 詳細は スタンプリスト 参照。

    Request - type "sticker"

    パラメーター タイプ 必須 説明
    type string Y "message"
    source object Y メッセージ送信者の情報
    source.accountId string Y 送信元メンバーアカウント
    source.roomId string Y 送信したトークルーム ID
    createdTime number Y メッセージが作成された日時。Unix time で表示 (単位: msec)
    content object Y メッセージの内容
    content.type string Y "sticker"
    content.packageId string Y パッケージ ID
    content.stickerId string Y スタンプ ID

    Request Example - type "sticker"

    
    POST /callback HTTP/1.1
    Host: YOUR_SERVER_HOST_NAME
    Content-type: application/json; charset=UTF-8
    X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=
    X-WORKS-BotNo: 123
    
    {
      "type": "message",
      "source": {
        "accountId": "admin@example.com",
        "roomId": "12345
      },
      "createdTime": 1508062056427,
      "content": {
        "type": "sticker",
        "packageId": "1",
        "stickerId": "1"
      }
    }
    

    画像

    メンバーが送信した画像データが含まれたオブジェクトです。
    リソース ID を使った画像データのダウンロード方法については コンテンツダウンロード 参照。

    Request - type "image"

    パラメーター タイプ 必須 説明
    type string Y "message"
    source object Y メッセージ送信者の情報
    source.accountId string Y 送信元メンバーアカウント
    source.roomId string Y 送信したトークルーム ID
    createdTime number Y メッセージが作成された日時。Unix time で表示 (単位: msec)
    content object Y メッセージの内容
    content.type string Y "image"
    content.resourceId string Y リソース ID

    Request Example - type "image"

    
    POST /callback HTTP/1.1
    Host: YOUR_SERVER_HOST_NAME
    Content-type: application/json; charset=UTF-8
    X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=
    X-WORKS-BotNo: 123
    
    {
      "type": "message",
      "source": {
        "accountId": "admin@example.com",
        "roomId": "12345
      },
      "createdTime": 1508062056427,
      "content": {
        "type": "image",
        "resourceId": "WAAAQPwBexX2HnseNvvM9Zyhvp2kIRF3Ul7L7/aMVti8="
      }
    }
    

    ファイル

    メンバーが送信したファイルが含まれたオブジェクトです。
    リソース ID を使ったファイルデータのダウンロード方法については コンテンツダウンロード 参照。

    Request - type "file"

    パラメータ タイプ 必須 説明
    type string Y "message"
    source object Y メッセージ送信者の情報
    source.accountId string Y 送信元メンバーアカウント
    source.roomId string Y 送信したトークルーム ID
    createdTime number Y メッセージが作成された日時。Unix time で表示 (単位: msec)
    content object Y メッセージの内容
    content.type string Y "file"
    content.resourceId string Y リソース ID

    Request Example - type "file"

    
    POST /callback HTTP/1.1
    Host: YOUR_SERVER_HOST_NAME
    Content-type: application/json; charset=UTF-8
    X-WORKS-Signature: 9crxWhZ9aQO/9ruUM4MH3dF/WRGYRhj0vSR4cRyJfHQ=
    X-WORKS-BotNo: 123
    
    {
      "type": "message",
      "source": {
        "accountId": "admin@example.com",
        "roomId": "12345
      },
      "createdTime": 1508062056427,
      "content": {
        "type": "file",
        "resourceId": "WAAAQPwBexX2HnseNvvM9Zyhvp2kIRF3Ul7L7/aMVti8="
      }
    }
    

    Response (トーク Bot のメッセージ受信サーバー -> メッセージサーバー)

    呼び出しに成功すると HTTP 200 コードを返します。
    callback で送信された HTTP リクエストは送信に失敗しても再送しません。

    Response

    
    HTTP/1.1 200 OK
    Content-Type: application/json
    Server: YOUR_SERVER_HOST_NAME
    Content-Length: 0