SQL Server / Zoom API / Get chat messages reports
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'from', '1989-05-07'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'to', '1989-05-07'
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'page_size', 30
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'next_page_token', 'quis officia in reprehenderit'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'include_fields', 'deleted_messages'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.zoom.us/v2/report/chat/sessions/:sessionId', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @date_time int
-- Use "Chilkat_9_5_0.DtObj" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.DtObj', @date_time OUT
DECLARE @id nvarchar(4000)
DECLARE @message nvarchar(4000)
DECLARE @sender nvarchar(4000)
DECLARE @reply_main_message_id nvarchar(4000)
DECLARE @reply_main_message_timestamp nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @file_id nvarchar(4000)
DECLARE @file_name nvarchar(4000)
DECLARE @file_size int
DECLARE @download_url nvarchar(4000)
DECLARE @from nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @from OUT, 'from'
DECLARE @v_to nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_to OUT, 'to'
DECLARE @page_size nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @page_size OUT, 'page_size'
DECLARE @next_page_token nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @next_page_token OUT, 'next_page_token'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'messages'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'messages[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @message OUT, 'messages[i].message'
EXEC sp_OAMethod @jResp, 'StringOf', @sender OUT, 'messages[i].sender'
EXEC sp_OAMethod @jResp, 'DtOf', @success OUT, 'messages[i].date_time', 0, @date_time
EXEC sp_OAMethod @jResp, 'StringOf', @reply_main_message_id OUT, 'messages[i].reply_main_message_id'
EXEC sp_OAMethod @jResp, 'StringOf', @reply_main_message_timestamp OUT, 'messages[i].reply_main_message_timestamp'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'messages[i].files'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @file_id OUT, 'messages[i].files[j].file_id'
EXEC sp_OAMethod @jResp, 'StringOf', @file_name OUT, 'messages[i].files[j].file_name'
EXEC sp_OAMethod @jResp, 'IntOf', @file_size OUT, 'messages[i].files[j].file_size'
EXEC sp_OAMethod @jResp, 'StringOf', @download_url OUT, 'messages[i].files[j].download_url'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'edited_messages'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'edited_messages[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @message OUT, 'edited_messages[i].message'
EXEC sp_OAMethod @jResp, 'StringOf', @sender OUT, 'edited_messages[i].sender'
EXEC sp_OAMethod @jResp, 'DtOf', @success OUT, 'edited_messages[i].date_time', 0, @date_time
EXEC sp_OAMethod @jResp, 'StringOf', @reply_main_message_id OUT, 'edited_messages[i].reply_main_message_id'
EXEC sp_OAMethod @jResp, 'StringOf', @reply_main_message_timestamp OUT, 'edited_messages[i].reply_main_message_timestamp'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'edited_messages[i].files'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @file_id OUT, 'edited_messages[i].files[j].file_id'
EXEC sp_OAMethod @jResp, 'StringOf', @file_name OUT, 'edited_messages[i].files[j].file_name'
EXEC sp_OAMethod @jResp, 'IntOf', @file_size OUT, 'edited_messages[i].files[j].file_size'
EXEC sp_OAMethod @jResp, 'StringOf', @download_url OUT, 'edited_messages[i].files[j].download_url'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'deleted_messages'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'deleted_messages[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @message OUT, 'deleted_messages[i].message'
EXEC sp_OAMethod @jResp, 'StringOf', @sender OUT, 'deleted_messages[i].sender'
EXEC sp_OAMethod @jResp, 'DtOf', @success OUT, 'deleted_messages[i].date_time', 0, @date_time
EXEC sp_OAMethod @jResp, 'StringOf', @reply_main_message_id OUT, 'deleted_messages[i].reply_main_message_id'
EXEC sp_OAMethod @jResp, 'StringOf', @reply_main_message_timestamp OUT, 'deleted_messages[i].reply_main_message_timestamp'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'deleted_messages[i].files'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @file_id OUT, 'deleted_messages[i].files[j].file_id'
EXEC sp_OAMethod @jResp, 'StringOf', @file_name OUT, 'deleted_messages[i].files[j].file_name'
EXEC sp_OAMethod @jResp, 'IntOf', @file_size OUT, 'deleted_messages[i].files[j].file_size'
EXEC sp_OAMethod @jResp, 'StringOf', @download_url OUT, 'deleted_messages[i].files[j].download_url'
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
EXEC @hr = sp_OADestroy @date_time
END
GO
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": ""
}
]
}
