ユーザー所属ルームメッセージ投稿API

ユーザー所属ルームメッセージ投稿APIは、自身が所属する特定のルームにメッセージを投稿するAPIです。

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

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

リクエスト内容

フィールド名	フィールド値	備考
action	send_message_to_room	必須 「ユーザー所属ルームメッセージ投稿API」であることを示します。
access_token	APIアクセスキー	必須 個人のAPIアクセスキーの取得方法はこちらを参照してください。
room_id	送信対象のルームシステムID	必須 指定した送信対象のルームにメッセージを投稿できます。 ルームシステムIDの取得には、ルームシステムIDの取得方法、もしくはユーザー所属ルーム一覧取得APIをご利用ください。
message	メッセージ内容にしたい文字列	必須 指定した内容でメッセージを投稿できます。 最大50万文字程度指定できます。 ※ コメントとしてメッセージを投稿する場合は、コメント元メッセージの分だけ最大値が小さくなります。
mentioned_user_ids	ユーザーのシステムID｜everyone	任意 未指定時：メンション先の指定なし メンションを送信できます。 指定したユーザーにメンションしたい場合は、ユーザーシステムIDの取得方法を参考にユーザーのシステムIDを指定してください。 ルームに所属しているユーザー全員にメンションする場合は、everyoneを指定してください。 メンション先は複数指定可能です。（*1） チャットボットのシステムIDを指定することでWebhook機能が利用できます。 チャットボットのWebhook機能についてはチャットボット連動Webhookをご覧ください。
reference_id	コメント元メッセージのシステムID	任意 未指定時：コメント元の指定なし 指定したメッセージに対するコメントとしてメッセージを投稿できます。 コメント元のメッセージのシステムIDの取得方法はこちらを参照してください。
enable_webhook	on｜off	任意 未指定時：on チャット設定のWebhook機能を利用するかどうかを選択できます。 onを指定すると、設定済みのWebhookが送信されます。 offを指定すると、設定済みでもWebhookは送信されません。 Webhook機能についてはメッセージ連動Webhookをご覧ください。

コメントに関する制限事項

V6.7 R1.0より前に投稿されたメンションが含まれるメッセージにコメントをした場合、コメント元メッセージのメンション部分は太字になりません。

制限事項ページ

リクエストの例

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

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

*1 メンション先を複数指定する場合は、上記の例のようにmentioned_user_idsを複数指定してください。

メンションメッセージについて

メンション先を指定した場合、メンションは必ずメッセージの先頭（１行目）で投稿されます。

以下は、「サンプルユーザー１」と「サンプルユーザー２」をメンション先に指定して
「メッセージ内容」という内容で投稿したメッセージです。

レスポンス内容

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

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

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

レスポンス内容の例

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