ZRA API missing scopes to get Conversations

[Ryo1 (Ryo)]

Hi,

Summary

I’m trying to use the APIs with server-to-server OAuth App.
But I can’t find the necessary scopes in the admin console to use the APIs.

Description

The APIs I’m using are:

• Zoom Revenue Accelerator API
• Zoom Revenue Accelerator API
• Zoom Revenue Accelerator API

The API documentation says these scopes are required:

List conversations

• zra:read:list_conversations
• zra:read:list_conversations:admin

Get conversation information

• zra:read:conversations
• zra:read:conversations:admin

Get conversation interactions

• zra:read:conversation_participants
• zra:read:conversation_participants:admin

Even after granting all Zoom RA scopes with ‘Select All’, API calls still result in errors due to insufficient scopes.

Can you please confirm what I need to do in order to access the required scopes? Thanks.

[elisa.zoom (Elisa)]

Hi @Ryo1
Thanks for reaching out to us, and sorry for the late reply here
Have you been able to access these endpoints, or is this an ongoing issue?

[Aram]

Hi @elisa.zoom, I’m having this same issue. I was directed to join the forum and post here instead of the regular Zoom support channel. Can you please provide any guidance?

Thanks!

-Aram

[elisa.zoom (Elisa)]

Hey @Aram
Thanks for reaching out to us and welcome to the Zoom Developer Forum.
I didnt hear back from the developer so was not able to follow up.
Could you please share the name of the endpoints you are trying to access and the scopes you are missing so I can take a closer look into this please?

[Aram]

I’m just an AV Engineer and not really great at APIs, so please excuse possibly not responding adequately. I’m trying to create a server to server Oauth app to run ZRA read-only scopes.

_____________________________________________________________

Read scopes I can currently select for the app (I have all selected in the app scopes):

zra:read:team_members:admin

zra:read:unassigned_team_users:admin

zra:read:team:admin

zra:read:team_hierarchical_structure:admin

zra:read:team_managers:admin

zra:read:team_list:admin

zra:read:list_conversation_comments:admin

zra:read:conversation_scorecards:admin

zra:read:list_conversation_playlists:admin

_______________________________________________________

I’m missing zra:read:list_conversations:admin, which can be added if I’m creating a “General App” type. But I need the server to server Oauth type.

Thanks for your help!

[Aram]

hi @elisa.zoom I didn’t @mention you in my response above, so you may not have seen it. Sorry!

[elisa.zoom (Elisa)]

@Aram

zra:read:list_conversations:admin

Thanks for tagging me @Aram
I have reached out to our Engineering team about thie (ZSEE-176827 internal ticket number for reference)
I will get back to you as soon as I havve an update.

[Aram]

Thanks @elisa.zoom !

[Aram]

Happy Friday @elisa.zoom ! Any developments with the internal ticket yet? Thanks again for your help! Have a great weekend if you see this too late in the day to respond.

[elisa.zoom (Elisa)]

Hey @Aram
Unfortunately, I do not have any updates at the moment. I will re engage with our engineering team and will get back to you

[elisa.zoom (Elisa)]

Hey @Aram
Thanks for your patience here!
I have an update from our Engineering team.
You need to add a permission to the role you have under your account. You need to enable the following setting to be able to see that scope in your S2S app

[Aram]

Hi @elisa.zoom I’m the system owner and I can’t edit role permissions. I can confirm all the existing role permissions are selected, both view and edit permissions. However, I don’t see the “Conversations” section. Do I need a ZRA license applied to my Zoom account in order to get the conversation scope to show up in the server to server Oauth scopes? Perhaps your engineering team can confirm? I do not currently have a ZRA license applied to my account. Once again, the frustrating ZRA license requirement in order to admin ZRA might be rearing its ugly head. I’ve complained to my AE about not being able to admin ZRA without a license. Thanks again for your help. This issue will seem silly if the answer all along was that I need ZRA on my account in order to get access to the scope. Easy answer that not a lot of people may know - because it’s counter-intuitive since a system owner shouldn’t need an extra license to admin another product SKU.

[elisa.zoom (Elisa)]

Thank you for your answer @Aram
I totally understand and I am looking into this. I am not 100% sure if this is a license issue but it might be. Let me get back to our Engineering team

[Aram]

Hi @elisa.zoom any word yet from the engineers? Thanks!

[elisa.zoom (Elisa)]

Hi @Aram
Thanks for your patience here!
Our Engineering team just confirmed that a ZRA license is needed to be able to get the right permissions and scopes in your S2S app

I will make sure to submit a note for our Docs team to make sure that this Pre Requisite is properly documented so other developers don’t have this issue in the future.
Thanks again
Elisa