No HostKey in 'get a meeting' return | RestAPI | /v1/meetings

[peter gumrich]

Hi, we are switching to the REST API from the XML API

We need to retrieve the HostKey for meetings. In the documentation it states that the Meetings - Get a Meeting | Webex for Developers GET call will return the HostKey as a string. However, in our case the output contain all fields except the host key. 

Does anyone have an idea what might cause the host key to be omitted from the "get a meeting" call? 

Thanks and best regards, 

Peter

[sandiban]

Hi @peter gumrich,
Thanks for your patience so far!
Could you please confirm who is making this /get-a-meeting API Request? Is it an invitee of the meeting or, a normal User in that Org who is making this API Request? Then the "hostKey" won't show in the Response either.
This hostKey value is only specific for the Host of the meeting and to maintain security, if someone else query the API like, an invitee of the meeting - then this value won't appear there.
If you ask the Host of the meeting to make the same API query, then "hostKey" should be available in the Response.

Hopefully this answers your query. Please let us know for any further assistance.
Regards!
Sandip

Please Note: If you think the solution provided above was helpful and satisfactory, please accept it as a Solution! However if you want to discuss it further and get yourself unblocked, please don't hesitate to reply back on this thread and we'll try to answer those queries by the soonest. In that case, once all of your queries are cleared - finally you can mark it as "Accepted as Solution"

[peter gumrich]

Hi Sandip, 

thank you very much for your reply! We have created a service app, since we need to query many organizational accounts with the following Scopes - is there a scope that might need to be added?: 

meeting:recordings_read

meeting:admin_preferences_write

meeting:admin_schedule_write

meeting:admin_preferences_read

meeting:schedules_read

meeting:participants_read

meeting:admin_participants_read

meeting:preferences_write

meeting:recordings_write

meeting:preferences_read

meeting:admin_recordings_read

meeting:transcripts_read

meeting:schedules_write

spark:kms

meeting:admin_recordings_write

meeting:participants_write

meeting:admin_schedule_read

meeting:admin_transcripts_read

Best regards and many thanks, 

Peter

[sandiban]

Thanks @peter gumrich for following up!
So, I'm not entirely sure which API you're going to use when you say you need to query many Organization Accounts, but looks like possibly you're going to work with Meeting APIs mostly.
Probably you'll try to check the meeting details or, attendees or, other meeting related information hosted by the Users from entire organization.

Yes, if that's the case - then I can find mostly Admin level and User level Meeting scopes are already added.
But let me share you a Documentation which would give you more clarity regarding which Scope including User-level as well as Admin-level, which scope is required for which Meeting APIs - https://developer.webex.com/docs/meetings#meetings-api-scopes

This above documentation would give you more clear picture regarding which one to use when rather than just guessing and keep adding scopes for a specific requirement.
hope this helps!

Please let us know for any further assistance.

Regards!
Sandip

Please Note: If you think the solution provided above was helpful and satisfactory, please accept it as a Solution! However if you want to discuss it further and get yourself unblocked, please don't hesitate to reply back on this thread and we'll try to answer those queries by the soonest. In that case, once all of your queries are cleared - finally you can mark it as "Accepted as Solution"

[sandiban]

Please Note: If you think the solution provided above was helpful and satisfactory, please accept it as a Solution! However if you want to discuss it further and get yourself unblocked, please don't hesitate to reply back on this thread and we'll try to answer those queries by the soonest. In that case, once all of your queries are cleared - finally you can mark it as "Accepted as Solution"

[peter gumrich]

Hi Sandip, 

Thank you for your reply. We based our selection of scopes on this resource. However, when we initially tested using a service app, we did get a host key within the "get a meeting" API response. We did not change the list of scopes, yet do not get this key any more within the response. 

We have tested a great range of other possibly or even tangentially related scopes without any success. The meeting is created by the same service app. Do you happen to know, it if it is "in principle" possible to retrieve the host key via a service app? 

Out company schedules about 80-100 meetings a day, which are used by trainers for cisco and other training delivery. Due to the host key changing whenever participants join a meeting early, we need to query the host key often to send it out to trainers. This is not manually doable. It would be very unfortunate, if this were not realizable via a service app we can run through our CRM.  

Best regards, Peter

[sandiban · Accepted solution]

Hello @peter gumrich,
Thanks for your patience so far!
Yes, it doesn't matter if you're using the Full Admin Scopes or, even Compliance Officer scopes in your Request, it'd never show the "hostKey" parameter value if you try to get the meeting details through API which is actually hosted by someone else.
And, it's not even just "hostKey", there are also few other parameters like "password", "webLink", "sipAddress" etc which would also not show in the Response if someone else try to get these details of the meeting, on behalf of the Host.
These fields are only available to the Host of the meeting, not anyone else. This is the way the API is designed.
And, if someone else who is Full Admin or, Compliance Officer tries to check it. in the Response it'd show as "The value is hidden by portal".

Hope this helps!
However if you've any further queries, please let us know.

Regards!
Sandip

[peter gumrich]

Hi Sandip, 

Thank you very much for your response. It is a little confusing, since the Service App can create meetings in any account, and the host key is returned when creating the event, it is just missing when checking on the host key later. From a security perspective there does not seem so much gained by hiding the HK from a service app that is able to create and update meetings ^^. But it is good to know that we don't have to go this route. I guess we have to use integrations then and create new refresh tokens periodically.

Thanks, Peter