Zoom Public API Documentation
List engagement notes
GET {{baseUrl}}/contact_center/engagements/:engagementId/notes?next_page_token=<string>&page_size=30
Return a list of notes under an engagement. Scopes: Rate Limit Label: contact_center_note:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>",
"notes": [
{
"note_id": "<string>",
"engagement_id": "<string>",
"channel_type": "voice",
"note": "<string>",
"last_modified_time": "<dateTime>",
"user_id": "<string>"
},
{
"note_id": "<string>",
"engagement_id": "<string>",
"channel_type": "voice",
"note": "<string>",
"last_modified_time": "<dateTime>",
"user_id": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/engagements/:engagementId/notes?next_page_token=<string>&page_size=30?next_page_token=<string>&page_size=30' -H 'Accept: application/json'
ENDPOINTS