Searches Omnichannel messages for an audit and records the search in the audit log. This endpoint requires a license that includes the auditing module. Dates use ISO 8601 format. Requests are limited to ten per minute.
This endpoint replaces the deprecated auditGetOmnichannelMessages real-time method, which remains available until 9.0.0.
Permission required:
can-audit
Changelog
| Version | Description |
|---|---|
| 8.8.0 | Added |
The user ID.
The authentication token.
{
"startDate": "2026-08-01T00:00:00Z",
"endDate": "2026-08-20T23:59:59.999Z",
"users": [
"dana.reyes"
],
"msg": "refund",
"type": "u",
"visitor": "8f4c2d1e9a7b6c5d3e2f1a0b"
}The beginning of the period to search, as an ISO date string.
The end of the period to search, as an ISO date string.
The usernames associated with the audit search.
The text to search for in the messages.
The audit type recorded in the audit log.
The ID of the Omnichannel visitor to audit.
The ID of the Omnichannel agent to audit.
OK
{
"messages": [
{
"_id": "5RQ4SBL3NuZKsqxaF",
"rid": "pMtJcZDsvKLnGKQ2C",
"msg": "I would like to request a refund",
"ts": "2026-08-14T16:02:51.006Z",
"u": {
"_id": "8f4c2d1e9a7b6c5d3e2f1a0b",
"username": "guest-482",
"name": "Alex Doe"
}
}
],
"success": true
}The Omnichannel messages matching the audit search.
Bad Request
Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}Forbidden
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}