Zoom Public API Documentation
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: Rate Limit Label: iq_conversation:read:admin,iq_conversation:readMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
host_id
|
string | The host user ID to query. | |
participant_id
|
string | The internal participant ID to query. | |
team_id
|
string | The Zoom specific team ID to query. | |
deal_id
|
string | The Zoom specific deal ID to query. | |
period_type
|
string | The type of period to query: * `meetingStartTime` — Queries conversations with meeting_start_time in the time period between the From and To parameters. * `iqProcessedTime` — Queries conversations with iq_processed_time in the time period between the From and To parameters. | |
from
|
string | The start date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. | |
to
|
string | The end date in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. | |
conversation_type
|
string | The type of conversations to query: * `all` — All conversations. * `meeting` — Meeting conversations. * `phone` - Phone conversations. | |
callout_type
|
string | The callout type of conversations to query: * `engagingQuestions` — Only query conversations that include engaging questions indicator. * `nextSteps` — Only query conversations that include next steps indicator. | |
indicator_id
|
string | The indicator id to query. | |
mentioned_topic_id
|
string | The mentioned topic id to query. | |
scored
|
string | Set to `true` to return scored conversations from the conversation list. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"conversations": [
{
"conversation_id": "<string>",
"host_id": "<string>",
"meeting_id": "<long>",
"meeting_uuid": "<string>",
"deal_id": "<string>",
"topic": "<string>",
"conversation_topic": "<string>",
"duration": "<integer>",
"conversation_type": "<string>",
"meeting_start_time": "<string>",
"iq_processed_time": "<string>",
"engagement_score": "<integer>",
"sentiment_score": "<integer>",
"engaging_questions_count": "<integer>",
"next_steps_count": "<integer>",
"filler_words_count": "<integer>",
"processing_analysis": "<boolean>"
},
{
"conversation_id": "<string>",
"host_id": "<string>",
"meeting_id": "<long>",
"meeting_uuid": "<string>",
"deal_id": "<string>",
"topic": "<string>",
"conversation_topic": "<string>",
"duration": "<integer>",
"conversation_type": "<string>",
"meeting_start_time": "<string>",
"iq_processed_time": "<string>",
"engagement_score": "<integer>",
"sentiment_score": "<integer>",
"engaging_questions_count": "<integer>",
"next_steps_count": "<integer>",
"filler_words_count": "<integer>",
"processing_analysis": "<boolean>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/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>?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>' -H 'Accept: application/json'
ENDPOINTS