第23章車両へのメッセージ送信

API名：
dynamic/message

概要：
リクエストされた車両へメッセージを送信します。

URI：
https://ドメイン名/openapi/v1/dynamic/message

メソッド：
POST

23.1POSTメソッド

23.1.1リクエスト

API使用例：

Request URL: https://ドメイン名/openapi/v1/dynamic/message?eigyousyoCode=00000001
Request Method: POST
Request Head:
　　　　content-type: application/json
　　　　Authorization: Bearer eyJ4NX…
Request Body:
"groupNameList"：["車両グループA","車両グループB"],
"eigyousyoCodeList"：[],
"saveMessageModel"：{
"messageList"：[
{
"messageType"：1,
"messagePosttime":"",
"messageTitle":"営業所からの連絡",
"message1":"目的地周辺ではこの後2時間ほど、",
"message2":"急激な雲の発達により",
"message3":"大雨となる可能性があります。",
"message4"："",
"messageKind"：1,
"vehicleMessageList"：[
{
"vehicleId"：1499,
"vehicleCode"："00000101",
"vehicleName"："車両A",
"driverName"："乗務員A",
"driverCode"："00000001",
"serialNumber"："2100000841",
"messageSeqId"：0
},
{
"vehicleId"："1677",
"vehicleCode"："00000010",
"vehicleName"："車両10",
"driverName"："テスト乗務員",
"driverCode"："00001000",
"serialNumber"："14001592",
"messageSeqId"：0
}
]
}
]
}

各リクエストパラメータは下記の通りです。


パラメータ名	必須	データ型	デフォルト	説明
eigyousyoCode	〇	String		営業所コードを指定します。(数字8桁)
groupNameList	※1	Array		車両グループの名称を指定します。
eigyousyoCodeList	※1	Array		営業所コードを指定します。
saveMessageModel	〇	Array		送信するメッセージの情報を指定します。
	messageList	〇	Array		メッセージ情報を指定します。
		messageKind	〇	Byte		メッセージの回答区分を指定します。 1：回答不要 2：回答要求 3：数値回答 4：ナビ指定 ※ナビ指定はG1車載機のみ有効です。 F1車載機の場合は、1のみ有効です。
		message1	※2	String		メッセージの本文1を指定します。全角29文字まで指定できます。(半角使用不可)
		message2	※2	String		メッセージの本文2を指定します。全角29文字まで指定できます。(半角使用不可)
		message3	※2	String		メッセージの本文3を指定します。全角29文字まで指定できます。(半角使用不可)
		message4	※2	String		メッセージの本文4を指定します。全角29文字まで指定できます。(半角使用不可)※3
		messageTitle	※2	String		メッセージのタイトルを指定します。全角29文字まで指定できます。(半角使用不可)
		messageType	〇	Byte		メッセージの送信タイプを指定します。 1：即時送信 2：出庫時送信 3：時間指定 ※4
		messagePosttime		String		messageTypeで3を選択した場合、送信する時刻を指定します。※5
		vehicleMessageList	〇	Array		メッセージを送信する車両情報を指定します。
			serialNumber		Int		車載機のシリアルナンバーを指定します。
			messageSeqId		Long		固定値0を指定します。
			vehicleId		Int		車両IDを指定します。
			vehicleCode	〇	String		車両コードを指定します。(数字8桁)
			vehicleName		String		車両名称を指定します。
			driverName		String		車両に乗務している乗務員の名称を指定します。
			driverCode		String		車両に乗務している乗務員の乗務員コードを指定します。(数字8桁)

※1　groupNameList、eigyousyoCodeListのどちらか一つを必ず指定して下さい。どちらも指定されていない場合、エラーとなります。

※2　messageTitle、message1～4のうち必ず一つを指定してください。指定されていない場合、エラーとなります。

※3　messageKindで4：ナビ指定を選択した場合、message4には緯度経度情報を指定する必要があります。緯度、経度情報はそれぞれ度分秒で指定し、緯度と経度の間をカンマで区切ってください。

指定しない場合、エラーとなります。
　フォーマット例："035.05.408,139.46.001"

※4　出庫時送信と時間指定送信は合わせて5件/日が上限となっております。

　 5件/日を超えるとエラーとなります。

※5　messagePosttimeは下記範囲内で指定してください。

現在時間≦messagePosttime≦現在時刻+24時間
上記範囲ではない場合、エラーとなります。
現在時刻はサーバの時刻を基準としています。

23.1.2レスポンス

各レスポンスパラメータは下記の通りです。


パラメータ名	データ型	説明
status	Object	ステータス情報が入ります。
	code	String	ステータスコードが入ります。詳しい内容は状態コードとエラーを参照してください。
	message	String	ステータス内容に関するメッセージが入ります。詳しい内容は状態コードとエラーを参照してください。
results	Array	リクエスト結果の情報が入ります。
	vehicleCode	String	メッセージを送信した車両の車両コードが入ります。(数字8桁)
	vehicleMessageId	Int	車両に送信したメッセージのメッセージ番号が入ります。

レスポンスの例：

{
"status":{
"code":"AF00E0000",
"message":"SUCCESS",
},
"results":[
{
"vehicleCode":"00000101",
"vehicleMessageId":1800,
},
{
"vehicleCode":"00000010",
"vehicleMessageId":1801,
}
]
}