IDを持つUserChatのメッセージリストを取得する方法です。
URL https://api.channel.io/open/v5/user-chats/{userChatId}/messagesおよびHTTP GET経由でアクセス可能
この方法は現在、application/jsonのみサポートしています。
パラメータ | 例 | 要件 | 説明 | タイプ |
|---|---|---|---|---|
userChatId | 5e65fa8bc2409f0c1fd3 | 必須 |
| Path |
since | eyJjaGF0S2V5IjoiZ3Jvn0= | 任意 | 取得する最初のメッセージのエンコード済みキー | Qeury |
limit | 25 | 任意 | 取得するメッセージの最大数を制限 | Query |
sortOrder | desc(or asc) | 必須 | メッセージの表示順序（降順は最新のメッセージを最初に表示） | Query |
GET https://api.channel.io/open/v5/user-chats/5e65fa8bc2409f0c1fd3/messages?limit=10
メッセージと関連情報を返します。
JSON
このエンドポイントで取得されるメッセージ数は、limitクエリパラメータによって制限され、閉区間 [1, 500] の値に上限が設定されています。
ページネーションは、sinceクエリパラメータとJSONレスポンスのルートオブジェクトに含まれるnext値を通じてサポートされます。このエンドポイントへの連続したクエリで、前のnext値をsinceパラメータとして使用すると、最終的にチャット内の全メッセージを取得できます。
sinceパラメータを空のままにした場合、取得されるリストは最初のメッセージ（orderパラメータで指定された順序）から開始されます。