API Endpoint(s) and/or Zoom API Event(s)
/contact_center/engagements
/contact_center/engagements/{engagementId}
Description
There are 56 variables to an engagement, and we can make custom global variables that tie into engagements. I see no way of returning or grabbing these variables via the API. Is there a way to grab X variables along with an engagement? For example, city, country, consumer email.
This is detrimental to web chats since we want to record this information, yet there’s no way to grab it.
I don’t have a specific answer for you, but I’d recommend inspecting the response headers for your request, as that’s where Zoom stashes their x-variables (i.e., if you’re using a Medium rate limit endpoint, the only way to see your current limit usage is by inspecting response.headers["x-ratelimit-usage"]). I suspect that may be where you’ll find what you’re looking for. Let me know if this helped!
While helpful, it isn’t quite what I’m looking for. Honestly, this may turn into a feature request that I’ll submit seperately.
It seems like there is no handy way to grab all of the information tied to Engagements through the API, but there is a roundabout way to do so by sifting through all of the Variable Logs through the Variables API. I found this just yesterday.
Hey @LukasR
Could you confirm if you are getting all the fields included in the docs?
Or are you adding those manually in the UI? Note that you will only be getting the variables listed in our docs
I can confirm that. I was asking if there was something I was missing that was not easily inferrable or noticeable in the API, but I have since found a work-around.
My problem was that I wanted all of the information tied to an Engagement. This includes all, or some, of the 56 variables tied to an engagement. The Engagement API does not do this in any way, shape, or form. It only includes some default information shown in the docs. I had to use the Variable Logs in order to grab this information, which takes a much lengthier amount of time.
I’ll just be turning this into a feature request and closing the forum post. I appreciate the replies.