05-09-2023 05:55 AM
Hi community!
I would like to know how I can get the status field via the WebEx API. I only found the pre-configured status fields in person details like 'active', 'call', 'DoNotDisturb', ect.
https://developer.webex.com/docs/api/v1/people/get-person-details
How can I get to the free-form field user status text in WebEx?
Cheers,
Lraec
05-09-2023 06:46 AM
The /v1/people API you mentioned is the only API that provides the status field currently. This returns the Control Hub status of the fetched user if their webex availability is not enabled. If it is enabled, then the status field will reflect that presence/availability status, as long as the user making the GET request is in the same org as the user being fetched. If the user who is making the GET request is not in the same org as the user being fetched, then it will return status as "unknown".
Not sure what you mean by "free-form field user status", but above is how the status field works.
05-09-2023 06:50 AM
Hi Raffaele! I mean the 'What is your status?' field. I added a screenshot btw. I want to get the information out of this text field over the API.
05-09-2023 07:24 AM
Screenshot is hard to make out because it's not in English, but I think you're referring to the availability status on the webex app, right? The closest that the status field on the /people API can give is your current availability status (active, do not disturb, etc.). It won't return whatever custom status you set in the "What's your status" field. There is no way through API to get that currently.
There are plans for the future to make an API for just user status/availability, and that may include this. But there is no timeline on when that API will be made public, it is still in the planning stage.
Discover and save your favorite ideas. Come back to expert answers, step-by-step guides, recent topics, and more.
New here? Get started with these tips. How to use Community New member guide