Channel Developers

thumbnail

Get a list of User's UserChats

特定のUserUserChatを取得できます。

URL https://api.channel.io/open/v5/users/{userId}/user-chats およびHTTP GET経由でアクセス可能

クエリ文字列にパラメータを表示します。

パラメータ

要件

説明

タイプ

userId

12345

必須

UserのID

Path

sortOrder

desc

任意

ソート順(並び順)。

- 指定可能な値 : asc, desc, both

- デフォルト値 : desc(降順。最新のメッセージが先頭になります)

Query

since

500000

任意

取得を開始するメッセージのマイクロ秒単位のエポックタイムです。 sinceパラメータが指定されていない(空の)場合、取得されるリストは(orderパラメータで指定された順序における)最初のメッセージから開始されます。

Query

limit

40

任意

取得するダイレクトチャットの最大件数を指定します。

- 最小値:1

- 最大値:500

- デフォルト値:25

Query

GET https://api.channel.io/open/v5/users/12345/user-chats?states=open&sortField=updatedAt&sortOrder=desc&since=500000&limit=40

関連情報とともにUserChatのセットを返します。

JSON