delphiDll / Zoom API / Get user’s IM messages
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
date_time: HCkDtObj;
id: PWideChar;
message: PWideChar;
sender: PWideChar;
timstamp: PWideChar;
date: PWideChar;
page_size: PWideChar;
next_page_token: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'chat_user','quis officia in reprehenderit');
CkJsonObject_UpdateString(queryParams,'channel','quis officia in reprehenderit');
CkJsonObject_UpdateString(queryParams,'date','quis officia in reprehenderit');
CkJsonObject_UpdateInt(queryParams,'page_size',30);
CkJsonObject_UpdateString(queryParams,'next_page_token','quis officia in reprehenderit');
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.zoom.us/v2/im/users/:userId/chat/messages',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "date": "string [date]",
// "page_size": "integer",
// "next_page_token": "string",
// "messages": [
// {
// "id": "string",
// "message": "string",
// "sender": "string",
// "date_time": "string [date-time]",
// "timstamp": "Long"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
date_time := CkDtObj_Create();
date := CkJsonObject__stringOf(jResp,'date');
page_size := CkJsonObject__stringOf(jResp,'page_size');
next_page_token := CkJsonObject__stringOf(jResp,'next_page_token');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'messages');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
id := CkJsonObject__stringOf(jResp,'messages[i].id');
message := CkJsonObject__stringOf(jResp,'messages[i].message');
sender := CkJsonObject__stringOf(jResp,'messages[i].sender');
CkJsonObject_DtOf(jResp,'messages[i].date_time',False,date_time);
timstamp := CkJsonObject__stringOf(jResp,'messages[i].timstamp');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
CkDtObj_Dispose(date_time);
Curl Command
curl -G -d "chat_user=quis%20officia%20in%20reprehenderit"
-d "channel=quis%20officia%20in%20reprehenderit"
-d "date=quis%20officia%20in%20reprehenderit"
-d "page_size=30"
-d "next_page_token=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/im/users/:userId/chat/messages
Postman Collection Item JSON
{
"name": "Get user’s IM messages",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/im/users/:userId/chat/messages?chat_user=quis officia in reprehenderit&channel=quis officia in reprehenderit&date=quis officia in reprehenderit&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"users",
":userId",
"chat",
"messages"
],
"query": [
{
"key": "chat_user",
"value": "quis officia in reprehenderit",
"description": "Chat user's ID or email address."
},
{
"key": "channel",
"value": "quis officia in reprehenderit",
"description": "IM Channel's ID."
},
{
"key": "date",
"value": "quis officia in reprehenderit",
"description": "IM message's query date time, format as yyyy-MM-dd."
},
{
"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."
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address."
}
]
},
"description": "Get IM Chat messages for a specified period of time. This API only supports Oauth2.<br>\n**Scopes:** `imchat:read`<br>\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\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"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nUser's IM messages returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/im/users/:userId/chat/messages?chat_user=quis officia in reprehenderit&channel=quis officia in reprehenderit&date=quis officia in reprehenderit&page_size=30&next_page_token=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"im",
"users",
":userId",
"chat",
"messages"
],
"query": [
{
"key": "chat_user",
"value": "quis officia in reprehenderit"
},
{
"key": "channel",
"value": "quis officia in reprehenderit"
},
{
"key": "date",
"value": "quis officia in reprehenderit"
},
{
"key": "page_size",
"value": "30"
},
{
"key": "next_page_token",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"date\": \"string [date]\",\n \"page_size\": \"integer\",\n \"next_page_token\": \"string\",\n \"messages\": [\n {\n \"id\": \"string\",\n \"message\": \"string\",\n \"sender\": \"string\",\n \"date_time\": \"string [date-time]\",\n \"timstamp\": \"Long\"\n }\n ]\n}"
}
]
}
