Skip to content

マイルームメッセージ投稿API

マイルームメッセージ投稿APIは、自身のマイルームにメッセージを投稿するAPIです。

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

非公開メッセージとして投稿されます。

※ システム管理者が許可している場合のみ利用できます。

リクエスト内容

フィールド名フィールド値備考
actionsend_message_to_myroom必須

「マイルームメッセージ投稿API」であることを示します。
access_tokenAPIアクセスキー必須

個人のAPIアクセスキーの取得方法はこちらを参照してください。
messageメッセージ内容にしたい文字列必須

指定した内容でメッセージを投稿できます。
最大50万文字程度指定できます。
※ コメントとしてメッセージを投稿する場合は、コメント元メッセージの分だけ最大値が小さくなります。
reference_idコメント元メッセージのシステムID任意
未指定時:コメント元の指定なし

指定したメッセージに対するコメントとしてメッセージを投稿できます。
コメント元のメッセージのシステムIDの取得方法はこちらを参照してください。
enable_webhookonoff任意
未指定時:on

チャット設定のWebhook機能を利用するかどうかを選択できます。
onを指定すると、設定済みのWebhookが送信されます。
offを指定すると、設定済みでもWebhookは送信されません。
Webhook機能についてはメッセージ連動Webhookをご覧ください。

リクエストの例

sh
curl -X POST "https://your.domain/cgi-bin/chatlk/userApi.cgi"
-F "action=send_message_to_myroom"
-F "access_token=(APIアクセスキー)"
-F "message=メッセージ"
-F "reference_id=(メッセージのシステムID)"
-F "enable_webhook=on"

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

レスポンス内容

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

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

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

レスポンス内容の例

jsonc
// Content-Type: application/json
{
  "result": "ok",
  "server_time": "2025-01-20T12:30:45",
  "id": "1dh8rzlse5no"
}