Logo
Zoom Public API Documentation

Zoom Virtual Agent API

Number of APIs: 7


1. km-kbs-{kbId}-articles-{articleId} - Get Article

GET {{baseUrl}}/km/kbs/:kbId/articles/:articleId

Get a knowledge base article

Scopes: zva:read:km_kbs

Rate Limit Label: LIGHT



2. km-kbs-{kbId}-articles-{articleId} - Update Article

PUT {{baseUrl}}/km/kbs/:kbId/articles/:articleId

Update a knowledge base article.

Scopes: zva:write:km_kbs

Rate Limit Label: LIGHT



3. km-kbs-{kbId}-articles-{articleId} - Delete Article

DELETE {{baseUrl}}/km/kbs/:kbId/articles/:articleId

Delete a knowledge base article.

Scopes: zva:write:km_kbs

Rate Limit Label: LIGHT



4. km-kbs-{kbId}-articles - Get Articles

GET {{baseUrl}}/km/kbs/:kbId/articles?next_page_token=<string>&page_size=30&include_contents=false&excluded=false&language=de

Get multiple knowledge base articles.

Scopes: zva:read:km_kbs

Rate Limit Label: LIGHT



5. km-kbs-{kbId}-articles - Create Article

POST {{baseUrl}}/km/kbs/:kbId/articles

Create a knowledge base article.

Scopes: zva:write:km_kbs

Rate Limit Label: LIGHT



6. virtual_agent-report-engagements-query_details - Get ZVA Query Details

GET {{baseUrl}}/virtual_agent/report/engagements/query_details?from=<date>&to=<date>&timezone=<string>&page_size=10&next_page_token=<string>&engagement_ids=<string>

Returns a list of ZVA engagement query details.

Scopes: zva_report:read

Rate Limit Label: HEAVY



7. virtual_agent-report-engagements - Get ZVA Engagements

GET {{baseUrl}}/virtual_agent/report/engagements?from=<date>&to=<date>&timezone=<string>&page_size=10&next_page_token=<string>&include_query_detail=<boolean>

Generate a list of ZVA engagements.

Scopes: zva_report:read

Rate Limit Label: HEAVY



ENDPOINTS