TCL / Zoom API / Get chat messages reports
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "from" "1989-05-07"
CkJsonObject_UpdateString $queryParams "to" "1989-05-07"
CkJsonObject_UpdateInt $queryParams "page_size" 30
CkJsonObject_UpdateString $queryParams "next_page_token" "quis officia in reprehenderit"
CkJsonObject_UpdateString $queryParams "include_fields" "deleted_messages"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.zoom.us/v2/report/chat/sessions/:sessionId" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "from": "string [date]",
# "to": "string [date]",
# "page_size": "integer",
# "next_page_token": "string",
# "messages": [
# {
# "id": "0fbd238a0519d3abb0e4ce",
# "message": "I am good.",
# "sender": "user@example.com",
# "date_time": "2019-09-17T20:25:17Z",
# "reply_main_message_id": "{52400403-DA96-4D7B-9E05-C1C399FF0725}",
# "reply_main_message_timestamp": "1568751917976"
# },
# {
# "id": "38a0fbd205abb0e4ce19d3",
# "message": "user has sent you a file",
# "sender": "user@example.com",
# "date_time": "2019-09-17T20:25:18Z",
# "reply_main_message_id": "{52400403-DA96-4D7B-9E05-C1C399FF0726}",
# "reply_main_message_timestamp": "1568751917976",
# "files": [
# {
# "file_id": "LqfULZp2SIWBGe_GNgrRFw",
# "file_name": "example.txt",
# "file_size": 14358,
# "download_url": "https://example.com/file/download/LqfULZp2SIWBGe_GNgrRFw"
# }
# ]
# }
# ],
# "edited_messages": [
# {
# "id": "0fbd238a0519d3abb0e4ce",
# "message": "I am good.",
# "sender": "user@example.com",
# "date_time": "2019-09-17T20:25:17Z",
# "reply_main_message_id": "{52400403-DA96-4D7B-9E05-C1C399FF0725}",
# "reply_main_message_timestamp": "1568751917976"
# },
# {
# "id": "38a0fbd205abb0e4ce19d3",
# "message": "user has sent you a file",
# "sender": "user@example.com",
# "date_time": "2019-09-17T20:25:18Z",
# "reply_main_message_id": "{52400403-DA96-4D7B-9E05-C1C399FF0726}",
# "reply_main_message_timestamp": "1568751917976",
# "files": [
# {
# "file_id": "LqfULZp2SIWBGe_GNgrRFw",
# "file_name": "example.txt",
# "file_size": 14358,
# "download_url": "https://example.com/file/download/LqfULZp2SIWBGe_GNgrRFw"
# }
# ]
# }
# ],
# "deleted_messages": [
# {
# "id": "0fbd238a0519d3abb0e4ce",
# "message": "I am good.",
# "sender": "user@example.com",
# "date_time": "2019-09-17T20:25:17Z",
# "reply_main_message_id": "{52400403-DA96-4D7B-9E05-C1C399FF0725}",
# "reply_main_message_timestamp": "1568751917976"
# },
# {
# "id": "38a0fbd205abb0e4ce19d3",
# "message": "user has sent you a file",
# "sender": "user@example.com",
# "date_time": "2019-09-17T20:25:18Z",
# "reply_main_message_id": "{52400403-DA96-4D7B-9E05-C1C399FF0726}",
# "reply_main_message_timestamp": "1568751917976",
# "files": [
# {
# "file_id": "LqfULZp2SIWBGe_GNgrRFw",
# "file_name": "example.txt",
# "file_size": 14358,
# "download_url": "https://example.com/file/download/LqfULZp2SIWBGe_GNgrRFw"
# }
# ]
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set date_time [new_CkDtObj]
set from [CkJsonObject_stringOf $jResp "from"]
set v_to [CkJsonObject_stringOf $jResp "to"]
set page_size [CkJsonObject_stringOf $jResp "page_size"]
set next_page_token [CkJsonObject_stringOf $jResp "next_page_token"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "messages"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "messages[i].id"]
set message [CkJsonObject_stringOf $jResp "messages[i].message"]
set sender [CkJsonObject_stringOf $jResp "messages[i].sender"]
CkJsonObject_DtOf $jResp "messages[i].date_time" 0 $date_time
set reply_main_message_id [CkJsonObject_stringOf $jResp "messages[i].reply_main_message_id"]
set reply_main_message_timestamp [CkJsonObject_stringOf $jResp "messages[i].reply_main_message_timestamp"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "messages[i].files"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set file_id [CkJsonObject_stringOf $jResp "messages[i].files[j].file_id"]
set file_name [CkJsonObject_stringOf $jResp "messages[i].files[j].file_name"]
set file_size [CkJsonObject_IntOf $jResp "messages[i].files[j].file_size"]
set download_url [CkJsonObject_stringOf $jResp "messages[i].files[j].download_url"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "edited_messages"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "edited_messages[i].id"]
set message [CkJsonObject_stringOf $jResp "edited_messages[i].message"]
set sender [CkJsonObject_stringOf $jResp "edited_messages[i].sender"]
CkJsonObject_DtOf $jResp "edited_messages[i].date_time" 0 $date_time
set reply_main_message_id [CkJsonObject_stringOf $jResp "edited_messages[i].reply_main_message_id"]
set reply_main_message_timestamp [CkJsonObject_stringOf $jResp "edited_messages[i].reply_main_message_timestamp"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "edited_messages[i].files"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set file_id [CkJsonObject_stringOf $jResp "edited_messages[i].files[j].file_id"]
set file_name [CkJsonObject_stringOf $jResp "edited_messages[i].files[j].file_name"]
set file_size [CkJsonObject_IntOf $jResp "edited_messages[i].files[j].file_size"]
set download_url [CkJsonObject_stringOf $jResp "edited_messages[i].files[j].download_url"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "deleted_messages"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_stringOf $jResp "deleted_messages[i].id"]
set message [CkJsonObject_stringOf $jResp "deleted_messages[i].message"]
set sender [CkJsonObject_stringOf $jResp "deleted_messages[i].sender"]
CkJsonObject_DtOf $jResp "deleted_messages[i].date_time" 0 $date_time
set reply_main_message_id [CkJsonObject_stringOf $jResp "deleted_messages[i].reply_main_message_id"]
set reply_main_message_timestamp [CkJsonObject_stringOf $jResp "deleted_messages[i].reply_main_message_timestamp"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "deleted_messages[i].files"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set file_id [CkJsonObject_stringOf $jResp "deleted_messages[i].files[j].file_id"]
set file_name [CkJsonObject_stringOf $jResp "deleted_messages[i].files[j].file_name"]
set file_size [CkJsonObject_IntOf $jResp "deleted_messages[i].files[j].file_size"]
set download_url [CkJsonObject_stringOf $jResp "deleted_messages[i].files[j].download_url"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
delete_CkDtObj $date_time
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"
-d "include_fields=deleted_messages"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/chat/sessions/:sessionId
Postman Collection Item JSON
{
"name": "Get chat messages reports",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/report/chat/sessions/:sessionId?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=deleted_messages",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"chat",
"sessions",
":sessionId"
],
"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."
},
{
"key": "include_fields",
"value": "deleted_messages",
"description": "Return all edited and deleted messages. The API only returns this value if the `include_fields` query parameter contains the `edited_messages` and/or the `deleted_messages` values.\n\nTo include **both** edited and deleted messages, comma-separate both values."
}
],
"variable": [
{
"key": "sessionId",
"value": "quis officia in reprehenderit",
"description": "(Required) Chat session ID."
}
]
},
"description": "Use this API to get Zoom Chat message reports for a specified period of time. The monthly date range must be within the last six months.\n\n**Scopes:** `report_chat:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\n\n**Prerequisites:** \n* A Pro or higher plan \n* Report chat permissions"
},
"response": [
{
"name": "**HTTP Status Code:** `200` <br>\nArchived chat messages returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/report/chat/sessions/:sessionId?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=deleted_messages",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"chat",
"sessions",
":sessionId"
],
"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"
},
{
"key": "include_fields",
"value": "deleted_messages"
}
],
"variable": [
{
"key": "sessionId",
"value": "quis officia in reprehenderit",
"description": "(Required) Chat session ID."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"from\": \"string [date]\",\n \"to\": \"string [date]\",\n \"page_size\": \"integer\",\n \"next_page_token\": \"string\",\n \"messages\": [\n {\n \"id\": \"0fbd238a0519d3abb0e4ce\",\n \"message\": \"I am good.\",\n \"sender\": \"user@example.com\",\n \"date_time\": \"2019-09-17T20:25:17Z\",\n \"reply_main_message_id\": \"{52400403-DA96-4D7B-9E05-C1C399FF0725}\",\n \"reply_main_message_timestamp\": \"1568751917976\"\n },\n {\n \"id\": \"38a0fbd205abb0e4ce19d3\",\n \"message\": \"user has sent you a file\",\n \"sender\": \"user@example.com\",\n \"date_time\": \"2019-09-17T20:25:18Z\",\n \"reply_main_message_id\": \"{52400403-DA96-4D7B-9E05-C1C399FF0726}\",\n \"reply_main_message_timestamp\": \"1568751917976\",\n \"files\": [\n {\n \"file_id\": \"LqfULZp2SIWBGe_GNgrRFw\",\n \"file_name\": \"example.txt\",\n \"file_size\": 14358,\n \"download_url\": \"https://example.com/file/download/LqfULZp2SIWBGe_GNgrRFw\"\n }\n ]\n }\n ],\n \"edited_messages\": [\n {\n \"id\": \"0fbd238a0519d3abb0e4ce\",\n \"message\": \"I am good.\",\n \"sender\": \"user@example.com\",\n \"date_time\": \"2019-09-17T20:25:17Z\",\n \"reply_main_message_id\": \"{52400403-DA96-4D7B-9E05-C1C399FF0725}\",\n \"reply_main_message_timestamp\": \"1568751917976\"\n },\n {\n \"id\": \"38a0fbd205abb0e4ce19d3\",\n \"message\": \"user has sent you a file\",\n \"sender\": \"user@example.com\",\n \"date_time\": \"2019-09-17T20:25:18Z\",\n \"reply_main_message_id\": \"{52400403-DA96-4D7B-9E05-C1C399FF0726}\",\n \"reply_main_message_timestamp\": \"1568751917976\",\n \"files\": [\n {\n \"file_id\": \"LqfULZp2SIWBGe_GNgrRFw\",\n \"file_name\": \"example.txt\",\n \"file_size\": 14358,\n \"download_url\": \"https://example.com/file/download/LqfULZp2SIWBGe_GNgrRFw\"\n }\n ]\n }\n ],\n \"deleted_messages\": [\n {\n \"id\": \"0fbd238a0519d3abb0e4ce\",\n \"message\": \"I am good.\",\n \"sender\": \"user@example.com\",\n \"date_time\": \"2019-09-17T20:25:17Z\",\n \"reply_main_message_id\": \"{52400403-DA96-4D7B-9E05-C1C399FF0725}\",\n \"reply_main_message_timestamp\": \"1568751917976\"\n },\n {\n \"id\": \"38a0fbd205abb0e4ce19d3\",\n \"message\": \"user has sent you a file\",\n \"sender\": \"user@example.com\",\n \"date_time\": \"2019-09-17T20:25:18Z\",\n \"reply_main_message_id\": \"{52400403-DA96-4D7B-9E05-C1C399FF0726}\",\n \"reply_main_message_timestamp\": \"1568751917976\",\n \"files\": [\n {\n \"file_id\": \"LqfULZp2SIWBGe_GNgrRFw\",\n \"file_name\": \"example.txt\",\n \"file_size\": 14358,\n \"download_url\": \"https://example.com/file/download/LqfULZp2SIWBGe_GNgrRFw\"\n }\n ]\n }\n ]\n}"
},
{
"name": "**Error Code:**`300` <br>\nThe next page token is either invalid or has 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}}/report/chat/sessions/:sessionId?from=1989-05-07&to=1989-05-07&page_size=30&next_page_token=quis officia in reprehenderit&include_fields=deleted_messages",
"host": [
"{{baseUrl}}"
],
"path": [
"report",
"chat",
"sessions",
":sessionId"
],
"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"
},
{
"key": "include_fields",
"value": "deleted_messages"
}
],
"variable": [
{
"key": "sessionId",
"value": "quis officia in reprehenderit",
"description": "(Required) Chat session ID."
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
