DataFlex / Zoom API / Get chat messages reports
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
Variant vDate_time
Handle hoDate_time
String sId
String sMessage
String sSender
String sReply_main_message_id
String sReply_main_message_timestamp
Integer j
Integer iCount_j
String sFile_id
String sFile_name
Integer iFile_size
String sDownload_url
String sFrom
String sV_to
String sPage_size
String sNext_page_token
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "from" "1989-05-07" To iSuccess
Get ComUpdateString Of hoQueryParams "to" "1989-05-07" To iSuccess
Get ComUpdateInt Of hoQueryParams "page_size" 30 To iSuccess
Get ComUpdateString Of hoQueryParams "next_page_token" "quis officia in reprehenderit" To iSuccess
Get ComUpdateString Of hoQueryParams "include_fields" "deleted_messages" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/report/chat/sessions/:sessionId" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get Create (RefClass(cComChilkatDtObj)) To hoDate_time
If (Not(IsComObjectCreated(hoDate_time))) Begin
Send CreateComObject of hoDate_time
End
Get ComStringOf Of hoJResp "from" To sFrom
Get ComStringOf Of hoJResp "to" To sV_to
Get ComStringOf Of hoJResp "page_size" To sPage_size
Get ComStringOf Of hoJResp "next_page_token" To sNext_page_token
Move 0 To i
Get ComSizeOfArray Of hoJResp "messages" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "messages[i].id" To sId
Get ComStringOf Of hoJResp "messages[i].message" To sMessage
Get ComStringOf Of hoJResp "messages[i].sender" To sSender
Get pvComObject of hoDate_time to vDate_time
Get ComDtOf Of hoJResp "messages[i].date_time" False vDate_time To iSuccess
Get ComStringOf Of hoJResp "messages[i].reply_main_message_id" To sReply_main_message_id
Get ComStringOf Of hoJResp "messages[i].reply_main_message_timestamp" To sReply_main_message_timestamp
Move 0 To j
Get ComSizeOfArray Of hoJResp "messages[i].files" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "messages[i].files[j].file_id" To sFile_id
Get ComStringOf Of hoJResp "messages[i].files[j].file_name" To sFile_name
Get ComIntOf Of hoJResp "messages[i].files[j].file_size" To iFile_size
Get ComStringOf Of hoJResp "messages[i].files[j].download_url" To sDownload_url
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "edited_messages" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "edited_messages[i].id" To sId
Get ComStringOf Of hoJResp "edited_messages[i].message" To sMessage
Get ComStringOf Of hoJResp "edited_messages[i].sender" To sSender
Get pvComObject of hoDate_time to vDate_time
Get ComDtOf Of hoJResp "edited_messages[i].date_time" False vDate_time To iSuccess
Get ComStringOf Of hoJResp "edited_messages[i].reply_main_message_id" To sReply_main_message_id
Get ComStringOf Of hoJResp "edited_messages[i].reply_main_message_timestamp" To sReply_main_message_timestamp
Move 0 To j
Get ComSizeOfArray Of hoJResp "edited_messages[i].files" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "edited_messages[i].files[j].file_id" To sFile_id
Get ComStringOf Of hoJResp "edited_messages[i].files[j].file_name" To sFile_name
Get ComIntOf Of hoJResp "edited_messages[i].files[j].file_size" To iFile_size
Get ComStringOf Of hoJResp "edited_messages[i].files[j].download_url" To sDownload_url
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "deleted_messages" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "deleted_messages[i].id" To sId
Get ComStringOf Of hoJResp "deleted_messages[i].message" To sMessage
Get ComStringOf Of hoJResp "deleted_messages[i].sender" To sSender
Get pvComObject of hoDate_time to vDate_time
Get ComDtOf Of hoJResp "deleted_messages[i].date_time" False vDate_time To iSuccess
Get ComStringOf Of hoJResp "deleted_messages[i].reply_main_message_id" To sReply_main_message_id
Get ComStringOf Of hoJResp "deleted_messages[i].reply_main_message_timestamp" To sReply_main_message_timestamp
Move 0 To j
Get ComSizeOfArray Of hoJResp "deleted_messages[i].files" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "deleted_messages[i].files[j].file_id" To sFile_id
Get ComStringOf Of hoJResp "deleted_messages[i].files[j].file_name" To sFile_name
Get ComIntOf Of hoJResp "deleted_messages[i].files[j].file_size" To iFile_size
Get ComStringOf Of hoJResp "deleted_messages[i].files[j].download_url" To sDownload_url
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
