Chilkat Online Tools

Swift / Zoom API / Get user’s IM messages

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("chat_user", value: "quis officia in reprehenderit")
    queryParams.UpdateString("channel", value: "quis officia in reprehenderit")
    queryParams.UpdateString("date", value: "quis officia in reprehenderit")
    queryParams.UpdateInt("page_size", value: 30)
    queryParams.UpdateString("next_page_token", 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/im/users/:userId/chat/messages", 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)

    // {
    //   "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

    let date_time = CkoDtObj()
    var id: String?
    var message: String?
    var sender: String?
    var timstamp: String?

    var date: String? = jResp.StringOf("date")
    var page_size: String? = jResp.StringOf("page_size")
    var next_page_token: String? = jResp.StringOf("next_page_token")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("messages").intValue
    while i < count_i {
        jResp.I = i
        id = jResp.StringOf("messages[i].id")
        message = jResp.StringOf("messages[i].message")
        sender = jResp.StringOf("messages[i].sender")
        jResp.DtOf("messages[i].date_time", bLocal: false, dt: date_time)
        timstamp = jResp.StringOf("messages[i].timstamp")
        i = i + 1
    }


}

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}"
    }
  ]
}