VB6 / Zoom API / Get IM chat sessions
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("from","1989-05-07")
success = queryParams.UpdateString("to","1989-05-07")
success = queryParams.UpdateInt("page_size",30)
success = queryParams.UpdateString("next_page_token","quis officia in reprehenderit")
' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/im/chat/sessions",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "from": "2019-08-31",
' "to": "2019-09-12",
' "page_size": 30,
' "next_page_token": "vsdfjesfdhs",
' "sessions": [
' {
' "session_id": "dkhfgjd",
' "type": "Group",
' "name": "API overview meeting",
' "last_message_sent_time": "2016-12-16T05:04:08.470Z"
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim session_id As String
Dim v_type As String
Dim name As String
Dim last_message_sent_time As String
Dim from As String
from = jResp.StringOf("from")
Dim v_to As String
v_to = jResp.StringOf("to")
Dim page_size As Long
page_size = jResp.IntOf("page_size")
Dim next_page_token As String
next_page_token = jResp.StringOf("next_page_token")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("sessions")
Do While i < count_i
jResp.I = i
session_id = jResp.StringOf("sessions[i].session_id")
v_type = jResp.StringOf("sessions[i].type")
name = jResp.StringOf("sessions[i].name")
last_message_sent_time = jResp.StringOf("sessions[i].last_message_sent_time")
i = i + 1
Loop
Curl Command
curl -G -d "from=1989-05-07"
-d "to=1989-05-07"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/im/chat/sessions
Postman Collection Item JSON
{
"name": "Get IM chat sessions",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/im/chat/sessions?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"chat",
"sessions"
],
"query": [
{
"key": "from",
"value": "1989-05-07",
"description": "(Required) 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."
},
{
"key": "to",
"value": "1989-05-07",
"description": "(Required) End date."
},
{
"key": "page_size",
"value": "30",
"description": "The number of records returned within a single API call."
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit",
"description": "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."
}
]
},
"description": "Retrieve IM Chat sessions for a specified period of time. This API only supports Oauth2.<br>\n\t\n**Scopes:** `imchat:read, imchat:read:admin`<br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\n <br><br>\n <p style=\"background-color:#e1f5fe; color:#000000; padding:8px\"><b>Deprecated:</b> By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see <a href=\"https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#im-api-notice\">Announcements: IM APIs Deprecation</a>.</p>\n \n"
},
"response": [
{
"name": "**HTTP Status Code:** `200` <br>\nArchived IM chat sessions returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/im/chat/sessions?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"chat",
"sessions"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"2019-08-31\",\n \"to\": \"2019-09-12\",\n \"page_size\": 30,\n \"next_page_token\": \"vsdfjesfdhs\",\n \"sessions\": [\n {\n \"session_id\": \"dkhfgjd\",\n \"type\": \"Group\",\n \"name\": \"API overview meeting\",\n \"last_message_sent_time\": \"2016-12-16T05:04:08.470Z\"\n }\n ]\n}"
},
{
"name": "**Error Code:** `300` <br>\nThe next page token is invalid or expired. <br>\nReport requested exceeds 6 month limit.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/im/chat/sessions?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"chat",
"sessions"
],
"query": [
{
"key": "from",
"value": "1989-05-07"
},
{
"key": "to",
"value": "1989-05-07"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
