Get IM chat messages

Retrieve IM chat messages for a specified period of time.

Scopes: imchat:read

Rate Limit Label: Medium

Please see our announcements page related to this deprecation.

{ "from": "string [date]", "messages": [ { "action": "string", "action_time": "string [date-time]", "date_time": "string [date-time]", "message": "string", "sender": "string" } ], "next_page_token": "string", "page_size": "integer", "session_id": "string", "to": "string [date]" }

请求参数

Path 参数

sessionId

string

必需

IM chat session ID.

Query 参数

from

string <date>

必需

Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.

string <date>

End date.

必需

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

返回响应

🟢200**HTTP Status Code:** `200` <br> Archived IM chat messages returned.

application/json

Body

Pagination object.

from

string <date>

可选

Start date.

session_id

string

可选

IM chat session ID.

string <date>

End date.

可选

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of the available result list exceeds the page size. The expiration period is 15 minutes.

page_size

integer

可选

The amount of records returns within a single API call.

<= 300

默认值:

messages

array [object {5}]

可选

Array of session objects.

action

string

可选

IM chat message action.

action_time

string <date-time>

可选

Action time.

date_time

string <date-time>

可选

IM chat message sent time.

message

string

可选

IM chat message content.

sender

string

可选

IM chat message sender.

🔵300**Error Code:**`300` <br> The next page token is either invalid or has expired.<br> Report requested exceeds 6 month limit.