groupIdでGroup内メッセージリストを取得できます。
URL https://api.channel.io/open/v5/groups/{groupId}/messagesおよびHTTP GET経由でアクセス可能
この方法は現在application/jsonのみサポートしています。
パラメータ | 例 | 要件 | 説明 | タイプ |
|---|---|---|---|---|
groupId | 1234 | 必須 |
| Path |
since | 1401231818 | 任意 | 取得する最初のメッセージのUnixタイムスタンプ値 | Query |
limit | 25 | 任意 | 結果の最大数を制限
| Query |
sortOrder | desc | 必須 | メッセージの順序(降順は最新のメッセージが先頭
| Query |
GET https://api.channel.io/open/v5/groups/1234/messages?since=1401231818&limit=25&sortOrder=asc
groupNameでGroup内メッセージリストを取得できます。
URL(https://api.channel.io/open/v5/groups/@{groupName}/messages)およびHTTP GET経由でアクセス可能
この方法は現在application/jsonのみをサポートしています。
パラメータ | 例 | 要件 | 説明 | タイプ |
|---|---|---|---|---|
groupName | justGroup | 必須 |
| Path |
since | 1401231818 | 任意 | 取得する最初のメッセージのUnixタイムスタンプ値 | Query |
limit | 25 | 任意 | 結果の最大数を制限する(範囲[1, 500]) デフォルト値 : 25 | Query |
sortOrder | desc | 必須 | メッセージの順序(降順は最新のメッセージが先) - 利用可能な値 : asc, desc, both - デフォルト値 : desc | Query |
GET https://api.channel.io/open/v5/groups/@justGroup/messages?since=1401231818&limit=25&sortOrder=asc
グループ内のメッセージと関連情報を返します。
このエンドポイントで取得されるメッセージ数は、limitクエリパラメータによって制限され、閉区間 [1, 500] の値に上限が設定されています。
ページネーションはsinceクエリパラメータと、JSONレスポンスのルートオブジェクトに含まれる next 値を通じてサポートされます。このエンドポイントへの連続したクエリでpreviousのnext値をsinceパラメータとして使用すると、最終的にチャット内の全メッセージを取得できます。
sinceパラメータを空のままにした場合、取得されるリストは最初のメッセージから開始されます(orderパラメータで指定された順序に従います)。