Pular para o conteúdo

POST /v1/csat/recovery/search

POST
/v1/csat/recovery/search
curl --request POST \
--url https://seu-endereco-da-api/v1/csat/recovery/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "period": "7", "status": "open", "trigger": "low_rating", "cursor": "example" }'

Permissão que a Chave de acesso precisa: Resgatar cliente insatisfeito (csat:recover).

Media typeapplication/json
object
period
string
Allowed values: 7 30 90
status
string
Allowed values: open pending in_progress resolved
trigger
string
Allowed values: low_rating no_reply
cursor
string
>= 1 characters
Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
ticketId
required
string
conversationId
required
string
nullable
contactId
required
string
nullable
contactName
required
string
nullable
departmentId
required
string
nullable
departmentName
required
string
nullable
rating
required
number
nullable
comment
required
string
nullable
trigger
required
string
Allowed values: low_rating no_reply
agentName
required
string
nullable
ownerUserId
required
string
nullable
ownerName
required
string
nullable
dueAt
required
string format: date-time
overdue
required
boolean
status
required
string
Allowed values: pending in_progress resolved
outcome
required
string
nullable
recovered
required

Whether this closed case counted as a recovered customer

boolean
firstContactAt
required
string format: date-time
nullable
resolvedAt
required
string format: date-time
nullable
matching
required

How many items the filter matches, beyond the page returned

number
summary
required
object
waiting
required
number
inProgress
required
number
overdue
required
number
recoveredInPeriod
required
number
averageFirstContactMinutes
required
number
nullable
outcomes
required
Array<string>
recoveredOutcomes
required

The outcome labels that count as a recovered customer

Array<string>
nextCursor
required

Pass it back to load the next page, null when the queue ended

string
nullable

Example

{
"items": [
{
"trigger": "low_rating",
"status": "pending"
}
]
}