Zoom API Data Model
ImChatSessionsBySessionId |
Retrieve IM Chat messagesRetrieve IM Chat messages for a specified period <aside>This API only supports oauth2.</aside>
Catalog: Zoom
Schema: IMChat
This is a read-only table function. The Zoom API may not support changing the data or the Invantive SQL driver for Zoom does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Zoom API.
Select Zoom API URL: /im/chat/sessions/{sessionId}
Insert Zoom API URL: /im/chat/sessions/{sessionId}
Update Zoom API URL: /im/chat/sessions/{sessionId}
Delete Zoom API URL: /im/chat/sessions/{sessionId}
Field Selection Method: NotRequired
Select Zoom API Operation: get /im/chat/sessions/{sessionId}
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ImChatSessionsBySessionId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
from |
datetime |
☑ |
|
Start Date |
next_page_token |
string |
☐ |
|
Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. |
page_size |
int64 |
☐ |
30 |
The number of records returned within a single API call |
sessionId |
string |
☑ |
|
IM Chat Session ID |
to |
datetime |
☑ |
|
End Date |
Table Function Columns
The columns of the table function ImChatSessionsBySessionId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
from |
datetime |
|
☐ |
Start date |
next_page_token |
string |
|
☐ |
Next page token, used to paginate through large result sets. A next page token will be returned whenever the set of available result list exceeds page size. The expiration period is 15 minutes. |
page_size |
int64 |
|
☐ |
The amount of records returns within a single API call. |
session_id |
string |
|
☐ |
IM Chat session ID |
to |
datetime |
|
☐ |
End date |
16-06-2022 17:21 Version 22.1.46-BETA+3385
