コンタクト通知投稿API

コンタクト通知投稿APIは、送信者のユーザーと送信先のユーザーのコンタクトにシステム通知メッセージを投稿するAPIです。

投稿されたメッセージはリアルタイムに通知され、アプリにもプッシュ通知されます。

※ 「コンタクト通知投稿API」が利用可能に設定されているAPIアクセスキーを使用する必要があります。

V6.8R1.1以前でシステム通知API(chatPushMessageモジュールを使ったAPI)をご利用になっていた場合

chatPushMessageモジュールは廃止予定のため非推奨となります。
「リクエスト先のURL」に記載されている補足説明をご確認ください。

リクエスト内容

フィールド名	フィールド値	備考
action	send_system_notice_to_contact	必須 「コンタクト通知投稿API」であることを示します。
access_token	APIアクセスキー	必須 システム管理者のAPIアクセスキーの取得方法はこちらを参照してください。
user_id	送信対象のユーザーシステムID	必須 指定した送信対象のユーザーと送信者(from_user_id)のコンタクトにメッセージを投稿できます。 ユーザーシステムIDの取得方法はこちらを参照してください。
from_user_id	送信者のユーザーシステムID	必須 指定した送信者と送信対象のユーザー(user_id)のコンタクトにメッセージを投稿できます。 ユーザーシステムIDの取得方法はこちらを参照してください。
title	タイトルにしたい文字列	必須 指定したタイトルで通知メッセージを投稿できます。 最大300文字まで指定できます。
message	内容にしたい文字列	任意 未指定時：通知メッセージの内容なし 指定した内容で通知メッセージを投稿できます。 最大50万文字程度指定できます。

リクエストの例

curl -X POST "https://your.domain/cgi-bin/chatlk/managerApi.cgi"
-F "action=send_system_notice_to_contact"
-F "access_token=(APIアクセスキー)"
-F "user_id=(ユーザーシステムID)"
-F "from_user_id=(ユーザーシステムID)"
-F "title=タイトル"
-F "message=メッセージ"

※ リクエスト先のURLは、お客様の環境に書き換えてください。
　 詳しくはリクエスト先のURLを参照してください。

レスポンス内容

フィールド名	フィールド値、意味
result	ok=成功、ng=失敗
server_time	成功した時のサーバー時間
id	投稿したメッセージのシステムID

※ result以外の値はresult=okのときのみ含まれます。

※ result=ngのときのレスポンスについては共通仕様を参照してください。

レスポンス内容の例

// Content-Type: application/json
{
  "result": "ok",
  "server_time": "2018-09-03T13:50:43",
  "id": "1dh8rzlse5no"
}