MessageHook Profile

目次

API	機能概要
Message Hook Get Channel API	チャンネル一覧を取得する。
Message Hook Send Message API	メッセージを投稿する。
Message Hook Received Message API	投稿されたメッセージを受信する。
Message Hook Get Message API	直近に投稿されたメッセージを取得する。

機能概要

メッセージ送受信の機能を提供するAPI。

Message Hook Get Channel API

インターフェース名称	Version	種別
Message Hook Get Channel API	2.0.0	同期I/F

概要

チャンネル一覧を取得する。

リクエスト

HTTPメソッド	URI
GET	/gotapi/messageHook/channel

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名		データ型	省略	設定値
処理結果	result		number	-	0:正常応答 0以外:異常応答
バージョン	version		string	-	Managerのバージョン
プロダクト	product		string	-	Managerの名前
チャンネル	channels		array	-	チャンネルを格納する配列
チャンネル識別子		id	string	-	チャンネルを識別するID
チャンネル名		name	string	-	チャンネルの名前
チャンネルタイプ		type	String	-	チャンネルのタイプ ・facebook ・line ・slack など

リクエストサンプル

GET http://localhost:4035/gotapi/messageHook/channel?serviceId=XXXX

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    “result”:0,
    “channels” : [
         {
             “id” : “xxxxxxxx”,
             “name” : “名前”,
             “type” : “slack”
         },
         {
             “id” : “xxxxxxxx”,
             “name” : “名前”,
             “type” : “slack”
         }
    ]
}

Message Hook Send Message API

インターフェース名称	Version	種別
Message Hook Send Message API	2.0.0	同期I/F

概要

メッセージを投稿する。

リクエスト

HTTPメソッド	URI
POST	/gotapi/messageHook/message

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス
チャンネルID	channelId	string	-	メッセージの投稿先チャンネルID。
テキスト	text	string	○	送信する文言。 リソースURIが指定されていない時は省略できない。
リソースURI	resource	string	○	画像、音声、映像などのリソースへのURI。 テキストが指定されていない時は省略できない。
マイムタイプ	mimeType	string	○	送信するリソースのタイプ。 リソースURIが指定されている時は省略できない。

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名	データ型	省略	設定値
処理結果	result	int	-	0:正常応答 0以外:異常応答
バージョン名	version	string	-	Managerのバージョン名
プロダクト名	product	string	-	Managerのプロダクト名

リクエストサンプル

POST http://localhost:4035/gotapi/messageHook/message?servieId=XXXX&channelId=channel1&text=メッセージ

レスポンスサンプル

{
    "product":"Device Connect Manager",
    "version":"x.x",
    "result": 0
}

Message Hook Received Message API

インターフェース名称	Version	種別
Message Hook Received Message API	2.0.0	非同期I/F(イベントI/F)

概要

メッセージを受信する。

イベント情報

イベント名	Content-Type
/gotapi/messageHook/message	application/json

メッセージ

論理名	物理名		データ型	省略	設定値
メッセージ	message		object	-	メッセージ情報
メッセンジャータイプ		messagerType	string	-	メッセンジャーのタイプ ・facebook ・line ・slack など
送信元ID		from	number	-	送信元ID
チャンネルID		channelId	string	-	チャンネルを識別ID
タイムスタンプ		timeStamp	int	-	投稿した時間
メッセージ		text	string	○	送られてきたメッセージ。 リソースURIが指定されていない時は省略されない。
リソースURI		resource	string	○	送られてきたメッセージのリソースへのURI。 メッセージが指定されていない時は省略されない。。
マイムタイプ		mimeType	string	○	リソースのタイプ。 メッセージが指定されていない時は省略されない。
メッセージタイプ		messageType	string	○	normal, direct, mention の文字列（複数になる場合がある”direct, mention”など） ・normal: 通常メッセージ ・direct: ダイレクトメッセージ ・mention: メンション付きメッセージ ＃メンション付きのメッセージtextはメンション部分が削除されます。

メッセージサンプル

{
    “message” : {
         “messengerType”: “xxxx”,
         “from” : “abcdef”,
         “timeStamp” : 1234567890,
         “channelId” : “1”,
         “text” :  “ライトをつけて”,
         “resource” : “http://org.deviceconnect/test.png“,
         “mimeType” : “image/png”,
         “messageType” : “direct”
     }
}

Message Hook Get Message API

インターフェース名称	Version	種別
Message Hook Get Message API	2.0.0	同期I/F

概要

直近に受信したメッセージの一覧を取得する。

リクエスト

HTTPメソッド	URI
GET	/gotapi/messageHook/message

論理名	物理名	データ型	省略	設定値
サービスID	serviceId	string	-	取得対象スマートデバイス

レスポンス

Content-Type	形式	HTTPステータス
application/json	JSON	200

論理名	物理名		データ型	省略	設定値
処理結果	result		number	-	0:正常応答 0以外:異常応答
バージョン	version		string	-	Managerのバージョン
プロダクト	product		string	-	Managerの名前
メッセージ	messages		array	-	メッセージ情報
メッセンジャータイプ		messagerType	string	-	メッセンジャーのタイプ ・facebook ・line ・slack など
送信元ID		from	number	-	送信元ID
チャンネルID		channelId	string	-	チャンネルを識別ID
タイムスタンプ		timeStamp	number	-	投稿した時間
メッセージ		text	string	○	送られてきたメッセージのテキスト。 リソースURIが指定されていない時は省略されない。
リソースURI		resource	string	○	送られてきたメッセージのリソースへのURI。 メッセージが指定されていない時は省略されない。
マイムタイプ		mimeType	string	○	リソースのタイプ。 メッセージが指定されていない時は省略されない。
メッセージタイプ		messageType	string	○	normal, direct, mention の文字列（複数になる場合がある”direct, mention”など） ・normal: 通常メッセージ ・direct: ダイレクトメッセージ ・mention: メンション付きメッセージ ＃メンション付きのメッセージのtextはメンション部分が削除されます。

リクエストサンプル

GET http://localhost:4035/gotapi/messageHook/message?serviceId=XXXX

レスポンスサンプル

{
    “result” : 0,
    “messages” : [
        {
            “messengerType”: “facebook”,
            “from” : “abcdef”,
            “timeStamp” : 1234567890,
            “channelId” : “1”,
            “text” :  “ライトをつけて”,
            “resource” : “http://www.gclue.io/a.png“,
            “mimeType” : “image/png”,
            “messageType” : “direct”
        }
    ]
}