Chat Channel Scopes

API and Webhooks
1

I have a valid token and am able to call other endpoints however when trying to obtain a list of channels for this user via https://api.zoom.us/v2/chat/users/me/channels

I get the following returned:

{
“code”: 4700,
“message”: “Invalid access token, does not contain scopes: [chat_channel:read, chat_channel:write, zms:chat_channel:read, zms:chat_channel:write]”
}

However I do not see in the list of scopes for my application where I can specify any of these scopes? I have request all possible scopes in the list as follows:

account:master account:read:admin account:write:admin billing:master contact:read:admin dashboard:master dashboard_crc:read:admin dashboard_home:read:admin dashboard_im:read:admin dashboard_meetings:read:admin dashboard_webinars:read:admin dashboard_zr:read:admin group:master group:read:admin group:write:admin h323:read:admin h323:write:admin imchat:bot imchat:read:admin imchat:write:admin imcontact:read:admin imgroup:master imgroup:read:admin imgroup:write:admin meeting:master meeting:read:admin meeting:write:admin pac:master pac:read:admin pac:write:admin phone:read:admin phone:write:admin recording:master recording:read:admin recording:write:admin report:master report:read:admin role:master role:read:admin role:write:admin room:read:admin scim2 sip_phone:read:admin sip_phone:write:admin tracking_fields:master tracking_fields:read:admin tracking_fields:write:admin tsp:master tsp:read:admin tsp:write:admin user:master user:read:admin user:write:admin webinar:master webinar:read:admin webinar:write:admin

I am using oAuth flow using grant_type = authorization_code

I have also tried this from the test widget on https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels (even generating a new token) and I get the same response.

How do I add these additional scopes?

2

I have even tried to specify the scopes in the install URL but get the following:

Invalid scope: as current client hasn’t this approved scope! (4,700)

However it does actually still return a valid access_token but without the channels scopes!

3

Hey @ian,

I am guessing you are using an Account Level OAuth App. To use the Chat and Channels APIs, you must use a User-Managed OAuth app.

11%20AM
11%20AM1618×458 43.9 KB

Let me know if this helps!

Thanks,
Tommy

4

Make sense Tommy, although I was hoping that Zoom supported admin consent on behalf of users so that individual users did not have to install the app individually. We have 12k+ employee and I was hoping that account level app would solve this issue.

Is this something that you are looking to support at some stage?

5

Hey @ian,

We understand the limitation here, and will have Account Level Chat / Channel APIs sometime in the future.

You can keep an eye on our releases here.

Although, sending Chatbots messages is Account Level, and there are some special features like listing channels and members of a channel.

Can you share your use case so I can try to come up with a solution in the meantime?

Thanks,
Tommy

6

@Ian is right, it’s pretty limiting without account-level-oauth being able to get this information.

We’re looking to get specific channel information and I can’t seem to do that since I run into the same issue Ian ran into.

1 Like
7

Hey @harris,

Yes, we are developing account level Chat APIs and should have them released in the coming months.

Stay update here: https://marketplace.zoom.us/docs/changelog

Thanks,
Tommy

8

Totally agree with @ian and harris, having account level access to “Chat Channels” and “Chat messages” endpoints will be a tremendous addition.

While calling the API today, I found that new permissions got listed as part of an error message; to be more specific chat_channel:write:admin and chat_channel:read:admin @tommy is there a way to add those scopes to an existing application or is that part of the incoming changes you have mentioned?

By the way @tommy , are “IM Chat Session” identifiers (from v1) going to match Chat Channel identifiers (from v2)? I am wondering to know if we are going to be able to get members for a given old session id.

Regards and thanks in advance for any related information.

9

Hey @emata_zoom,

Yes I am also very excited for the Account Level Chat / Channel endpoint release! :slight_smile:

You will be able to add the scopes to an existing Chatbot or Account Level OAuth app.

Not sure, can you send me an example of a v1 identifier?

Thanks,
Tommy

10

Hi @tommy,

Here is a example of a session in API v1:

{
  "last_message_sent_time": "2019-09-01T09:59:22Z",
  "name": "user@domain",
  "session_id": "80b1889a6c82fb4484f7a0b702e517e3b8429ba17e566e201d64818eb924d508",
  "type": "1:1"
}

We also use that session id to get all the messages within the session (channel). So, we are wondering if we will be able to use that same session id to get the members of each 1:1 or “multi party” conversation.

Best regards.

11

Hey @emata_zoom,

I am guessing that is the id in our new Chat Messages endpoints.

Can you test them to see if it matches?

Thanks,
Tommy

12

Hi @tommy

Unfortunately we can’t test that now because we only have an account level app token. Looking forward to test those new endpoints as soon as you release account level access for Chat and Channels v2 :grinning:

Regards.

1 Like
13

Sounds good @emata_zoom! :slight_smile:

-Tommy