Swift / Zoom API / Get a message
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
let queryParams = CkoJsonObject()
queryParams.UpdateString("to_contact", value: "quis officia in reprehenderit")
queryParams.UpdateString("to_channel", value: "quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.zoom.us/v2/chat/users/:userId/messages/:messageId", json: queryParams)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "{4C6A11E6-0145-430F-BC4D-937886AE559D}",
// "message": "reply_file",
// "sender": "jemsa@example.com",
// "date_time": "2021-05-31T07:34:50Z",
// "timestamp": 1622446490991,
// "reply_main_message_id": "{52400403-DA96-4D7B-9E05-C1C399FF0725}",
// "reply_main_message_timestamp": 1622446481695,
// "reactions": [
// {
// "emoji": "U+ 00000023-0000fe0f",
// "total_count": 1
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
let date_time = CkoDtObj()
var emoji: String?
var total_count: Int
var id: String? = jResp.StringOf("id")
var message: String? = jResp.StringOf("message")
var sender: String? = jResp.StringOf("sender")
jResp.DtOf("date_time", bLocal: false, dt: date_time)
var timestamp: Int = jResp.IntOf("timestamp").intValue
var reply_main_message_id: String? = jResp.StringOf("reply_main_message_id")
var reply_main_message_timestamp: Int = jResp.IntOf("reply_main_message_timestamp").intValue
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("reactions").intValue
while i < count_i {
jResp.I = i
emoji = jResp.StringOf("reactions[i].emoji")
total_count = jResp.IntOf("reactions[i].total_count").intValue
i = i + 1
}
}
Curl Command
curl -G -d "to_contact=quis%20officia%20in%20reprehenderit"
-d "to_channel=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/chat/users/:userId/messages/:messageId
Postman Collection Item JSON
{
"name": "Get a message",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId?to_contact=quis officia in reprehenderit&to_channel=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"messages",
":messageId"
],
"query": [
{
"key": "to_contact",
"value": "quis officia in reprehenderit",
"description": "The `userId` or email address of a Zoom Chat contact to whom you sent the message.\\n\\n**Note:** You must use this query parameter to delete a message sent to a Zoom Chat contact. "
},
{
"key": "to_channel",
"value": "quis officia in reprehenderit",
"description": "The `channelId` of the Zoom Chat channel where sent the message.\\n\\n**Note:** You must use this query parameter to delete a message sent to Zoom Chat channel."
}
],
"variable": [
{
"key": "messageId",
"value": "quis officia in reprehenderit",
"description": "(Required) Message ID"
}
]
},
"description": "Get a chat message previously sent to a contact or a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\nYou must provide one of the following query parameters:<br>\n* `to_contact` — The email address of the Zoom contact to whom you sent the message.\n* `to_channel` — The ID of the Zoom channel where you sent the message.\n\n**Scopes:** `chat_message:read`, `chat_message:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\n\n<p style=\"background-color:#e1f5fe; color:#01579b; padding:8px\"> <b>Note:</b> For an <b>account-level</b> <a href=\"https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app\">OAuth app</a>, you can only use this API for a user assigned <a href=\"https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.\">the <b>Edit</b> permission for the <b>Chat message</b> role setting</a>.</p>"
},
"response": [
{
"name": "**HTTP Status Code:** `204`<br>\nGet message successfully.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId?to_contact=quis officia in reprehenderit&to_channel=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"messages",
":messageId"
],
"query": [
{
"key": "to_contact",
"value": "quis officia in reprehenderit"
},
{
"key": "to_channel",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "messageId",
"value": "quis officia in reprehenderit",
"description": "(Required) Message ID"
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"{4C6A11E6-0145-430F-BC4D-937886AE559D}\",\n \"message\": \"reply_file\",\n \"sender\": \"jemsa@example.com\",\n \"date_time\": \"2021-05-31T07:34:50Z\",\n \"timestamp\": 1622446490991,\n \"reply_main_message_id\": \"{52400403-DA96-4D7B-9E05-C1C399FF0725}\",\n \"reply_main_message_timestamp\": 1622446481695,\n \"reactions\": [\n {\n \"emoji\": \"U+ 00000023-0000fe0f\",\n \"total_count\": 1\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\nBad request.<br>\n**Error Code:** `200`<br>\nThe contact or the channel parameter provided is invalid.<br>\nOnly the sender of this message can get it.<br>\n**Error Code:** `300`<br>Channel does not exist: $messageId<br>Must pr",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId?to_contact=quis officia in reprehenderit&to_channel=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"messages",
":messageId"
],
"query": [
{
"key": "to_contact",
"value": "quis officia in reprehenderit"
},
{
"key": "to_channel",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "messageId",
"value": "quis officia in reprehenderit",
"description": "(Required) Message ID"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\n**Error Code**: `1001`<br>\nUser does not exist: $to_contact.<br>\n**Error Code**: `4130`<br>\nChannel does not exist: $to_channel.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/chat/users/:userId/messages/:messageId?to_contact=quis officia in reprehenderit&to_channel=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"chat",
"users",
":userId",
"messages",
":messageId"
],
"query": [
{
"key": "to_contact",
"value": "quis officia in reprehenderit"
},
{
"key": "to_channel",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "messageId",
"value": "quis officia in reprehenderit",
"description": "(Required) Message ID"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
