管理状態にあるUserChatのリストについてのドキュメントです。
URL https://api.channel.io/open/v5/user-chatsおよびHTTP GET経由でアクセス可能
クエリ文字列にパラメータを指定してください。
パラメータ | 例 | 要件 | 説明 | タイプ |
|---|---|---|---|---|
state | opened | 必須 | ユーザーチャット状態フィルター。利用可能な値： | Query |
sortOrder | desc | 必須 | ソート順。利用可能な値： | Query |
since | eyJjaGF0S2V5IjoiZ3Jvn0= | 任意 | 取得する最初のユーザーチャットのエンコード済みキー取得する最初のユーザーチャットのエンコード済みキー | Query |
limit | 40 | 任意 | 取得するユーザーチャットの最大数を制限します。値は1から500の間である必要があります。デフォルト値は25です。取得するユーザーチャットの最大数を制限します。値は1から500の間である必要があります。デフォルト値は25です。 | Query |
UserChatオブジェクトのセットを返します。
このエンドポイントで取得されるユーザーチャットの数は、limitクエリパラメータによって制限され、閉区間 [1, 500] の値に上限が設定されます。
取得したユーザーチャットは、stateクエリパラメータを通じて開いている状態、一時停止状態、閉じている状態でフィルタリングできます。
sinceクエリパラメータと、JSONレスポンスのルートオブジェクトに含まれるnext値を通じてページネーションがサポートされています。このエンドポイントへの連続したクエリで、前のnext値をsinceパラメータとして使用すると、最終的にすべてのユーザーチャットを取得できます。
sinceパラメータを空にすると、リストの先頭から取得を開始できます。