Zoom Revenue Accelerator API
Number of APIs: 22
1. iq-settings-indicators - Get indicators settings
GET {{baseUrl}}/iq/settings/indicators?category_id=<string>&type=guiding_sentences&page_size=30&next_page_token=<string>
Get the account's indicators settings.
Prerequisites: * The account must be a paid account.
Scopes: account:read:admin,iq_account:read:admin
Rate Limit Label: Medium
2. iq-conversations-{conversationId}-comments-{commentId} - Delete conversation's comment
DELETE {{baseUrl}}/iq/conversations/:conversationId/comments/:commentId
Delete comment from a specific conversation.
Scopes: iq_comment:write,iq_comment:write:admin
Rate Limit Label: Medium
3. iq-conversations-{conversationId}-comments-{commentId} - Edit conversation comment
PATCH {{baseUrl}}/iq/conversations/:conversationId/comments/:commentId
Edit a comment for a specific conversation.
Scopes: iq_comment:write,iq_comment:write:admin
Rate Limit Label: Medium
4. iq-conversations-{conversationId}-comments - Get conversation comments
GET {{baseUrl}}/iq/conversations/:conversationId/comments?page_size=30&next_page_token=<string>
Get comments for a specific conversation.
Scopes: iq_comment:read,iq_comment:read:admin
Rate Limit Label: Medium
5. iq-conversations-{conversationId}-comments - Add new comments to the conversation
POST {{baseUrl}}/iq/conversations/:conversationId/comments
Add new comments to a specific conversation.
Scopes: iq_comment:write,iq_comment:write:admin
Rate Limit Label: Medium
6. iq-conversations-{conversationId}-content_analysis - Get conversation content analysis
GET {{baseUrl}}/iq/conversations/:conversationId/content_analysis?analysis_type=engagingQuestions&page_size=30&next_page_token=<string>
Get the content analysis for a specific conversation.
Scopes: iq_conversation:read,iq_conversation:read:admin
Rate Limit Label: Medium
7. iq-conversations-{conversationId}-interactions - Get conversation interactions
GET {{baseUrl}}/iq/conversations/:conversationId/interactions?page_size=30&next_page_token=<string>
Get interactions for a specific conversation.
Scopes: iq_conversation:read,iq_conversation:read:admin
Rate Limit Label: Medium
8. iq-conversations-{conversationId}-scorecards - Get conversation scorecards
GET {{baseUrl}}/iq/conversations/:conversationId/scorecards?page_size=30&next_page_token=<string>
Get scorecards for a specific conversation.
Scopes: iq_coaching:read,iq_coaching:read:admin
Rate Limit Label: Medium
PATCH {{baseUrl}}/iq/conversations/:conversationId/update_host
Update conversation host id.
Prerequisite:
You must have either iq_conversation:write:admin or iq_conversation:write permissions.
Scopes: iq_conversation:write:admin,iq_conversation:write
Rate Limit Label: MEDIUM
10. iq-conversations-{conversationId} - Get conversation information
GET {{baseUrl}}/iq/conversations/:conversationId
Get information for a specific conversation.
Scopes: iq_conversation:read:admin,iq_conversation:read
Rate Limit Label: LIGHT
11. iq-conversations-{conversationId} - Delete conversation by conversation ID
DELETE {{baseUrl}}/iq/conversations/:conversationId
Delete conversation by conversation ID.
Scopes: iq_conversation:write,iq_conversation:write:admin
Rate Limit Label: Light
12. iq-conversations - List conversations
GET {{baseUrl}}/iq/conversations?host_id=<string>&participant_id=<string>&team_id=<string>&deal_id=<string>&period_type=meetingStartTime&from=<string>&to=<string>&conversation_type=all&callout_type=engagingQuestions&indicator_id=<string>&mentioned_topic_id=<string>&scored=<boolean>&page_size=30&next_page_token=<string>
List all conversations.
Scopes: iq_conversation:read:admin,iq_conversation:read
Rate Limit Label: MEDIUM
13. iq-conversations - Add conversation by file id or download url.
POST {{baseUrl}}/iq/conversations
Add conversation by file ID or third party download URL.
Scopes: iq_conversation:write:admin,iq_conversation:write
Rate Limit Label: MEDIUM
14. iq-files-multipart - Upload iq multipart file.
POST {{baseUrl}}/iq/files/multipart
Use this API to upload a multipart file.
Note:
* The base URL for this API is https://fileapi.zoom.us/v2/.
* The rate limit of this API is 20 requests per second or 2000 requests per day per IP address.
* The caller must support HTTP 30x redirects.
* The caller must retain the authorization header when redirected to a different hostname.
* Video can be in .mov, .mp4, .avi, .wmv or H.264 format.
* Transcript can be in .vtt, .json format.
* In general, when your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation.
* The caller must be a iq_listened user.
* For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for All Conversations.
*
Scopes: iq_conversation:write:admin,iq_conversation:write
15. iq-files - Upload iq file.
POST {{baseUrl}}/iq/files
Upload a file to Zoom IQ.
Prerequisite:
The caller must be an iq_licensed user.
Note:
* Base URL: https://fileapi.zoom.us/v2/.
* Rate limit: 20 requests per second or 2000 requests per day per IP address.
* The caller must support HTTP 30x redirects.
* The caller must retain the authorization header when redirected to a different hostname.
- Supported video formats:
.mov,.mp4,.avi,.wmvorH.264. - Supported transcript and file attachment format:
.json. The fileName must end withtranscript.json. - Supported metadata and file attachment format:
.json. The fileName must end withmetadata.json. - Required file upload sequence: main file, transcript file (if necessary), metadata file (if necessary).
- When your object size reaches 2 GB, you should use multipart uploads instead of uploading the object in a single operation.
- For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role with Edit permission for All Conversations.
Scopes: iq_conversation:write:admin,iq_conversation:write
16. iq-users-{userId}-conversations-playlists - Get a user's playlist
GET {{baseUrl}}/iq/users/:userId/conversations/playlists?page_size=30&next_page_token=<string>&type=All&following=false&create_by_self=false
Get all playlists for a user.
Scopes: iq_playlist:read:admin,iq_playlist:read
Rate Limit Label: MEDIUM
17. iq-users-{userId}-conversations - Add conversation by meeting record url or meeting UUID.
POST {{baseUrl}}/iq/users/:userId/conversations
Add new conversation by meeting record url or meeting UUID. If both recording url and meeting UUID are passed in the request and refer to different meetings, we ignore meeting UUID.
Scopes: iq_conversation:write,iq_conversation:write:admin
Rate Limit Label: Medium
18. iq-deals-{dealId}-activities - Get deal activities
GET {{baseUrl}}/iq/deals/:dealId/activities?conversation_topic=<string>&callout_type=engagingQuestions&indicator_id=<string>&mentioned_topic_id=<string>&page_size=30&next_page_token=<string>
Get activities for a specific deal.
Scopes: iq_deal:read:admin,iq_deal:read
Rate Limit Label: MEDIUM
19. iq-deals-{dealId}-activities - Delete activity from the deal
DELETE {{baseUrl}}/iq/deals/:dealId/activities?conversation_id=<string>&message_id=<string>
Delete specific activity from the deal. Either conversationid or messageid would be required.
Scopes: iq_deal:write,iq_deal:write:admin
Rate Limit Label: MEDIUM
20. iq-deals-{dealId} - Get deal information
GET {{baseUrl}}/iq/deals/:dealId
Get information for a specific deal.
Scopes: iq_deal:read:admin,iq_deal:read
Rate Limit Label: MEDIUM
GET {{baseUrl}}/iq/deals?deal_name=<string>&only_show_with_analytics=<boolean>&from=<string>&to=<string>&team_id=<string>&deal_stage=<string>&owner_id=<string>&page_size=30&next_page_token=<integer>&max_deal_amount=<integer>&min_deal_amount=<string>
22. iq-teams - List Account Teams
GET {{baseUrl}}/iq/teams?parent_team_id=<string>&team_name=<string>&page_size=30&next_page_token=<string>
List account teams. Filter by parent team ID or team name.
Scopes: iq_team:read:admin,iq_team:read
Rate Limit Label: MEDIUM
ENDPOINTS