Acompanhe quanto tempo falta para enviar novas requisições sem bloqueio através do parâmetro ‘retry-after’ existente no header que terá no retorno da nossa API.
https://api.movidesk.com/public/v1
Tickets/Merged
A API /tickets/merged é utilizada para recuperar informações sobre tickets que foram mesclados. Essa API permite dois tipos de busca: por número ou protocolo de ticket e por intervalo de datas. Dependendo do tipo de busca, diferentes parâmetros são usados e o retorno varia para atender às necessidades da consulta.
URL
GET /tickets/merged
Parâmetros de Consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
token | GUID | Obrigatório: Token de autenticação para acessar a API. |
id | string | Opcional: Número ou protocolo do ticket. Se informado, a busca será realizada apenas por este campo. |
startDate | string | Opcional: Data de início (em formato UTC) para a busca por intervalo de datas. |
endDate | string | Opcional: Data de fim (em formato UTC) para a busca por intervalo de datas. |
page | int | Opcional: Número da página para navegação em resultados paginados. |
Tipos de Busca
1. Busca por Número ou Protocolo
Nesta busca, você deve fornecer o número ou protocolo do ticket no parâmetro id. A API retornará informações sobre tickets mesclados a ele.
Regras:
- Se o campo
idfor informado, os outros parâmetros (startDate,endDate,page) serão ignorados. - Se o
idinformado não for encontrado, a API retornará um erro 404 - Not Found.
Formato de Retorno:
| Propriedade | Descrição |
|---|---|
ticketId | Número ou protocolo do ticket informado no campo id. |
mergedTickets | Quantidade de tickets mesclados ao ticket informado no campo id. |
mergedTicketsIds | Número ou protocolo dos tickets que foram mesclados ao ticket informado. |
lastUpdate | Data e hora do último evento de mescla. |
Exemplo de Retorno:
{
"ticketId": "11337799",
"mergedTickets": "1",
"mergedTicketsIds": "11344796",
"lastUpdate": "2024-05-23 11:08:13"
}
2. Busca por Data
Nesta busca, você pode informar um intervalo de datas usando os parâmetros startDate e endDate. A busca retornará uma lista de tickets que possuem outros tickets mesclados a eles.
Regras:
- Se o campo
idfor informado, a busca será feita peloide os camposstartDateeendDateserão ignorados. - Se
startDatefor maior queendDate, a API retornará um erro 400 - Bad Request. - O parâmetro
pagepode ser usado para navegar entre as páginas de resultados.
Formato de Retorno:
| Propriedade | Descrição |
|---|---|
startDate | O startDate informado na consulta. |
endDate | O endDate informado na consulta, se disponível. |
count | Número total de tickets com outros tickets mesclados no intervalo informado. |
pageNumber | Página atual e número total de páginas no formato page of totalPages. |
mergedTickets | Lista de tickets no formato da busca por id, incluindo detalhes de mescla. |
Exemplo de Retorno:
{
"startDate": "2024-05-01",
"endDate": "",
"count": "16623",
"pageNumber": "1 of 333",
"mergedTickets": [
{
"ticketId": "11337799",
"mergedTickets": "1",
"mergedTicketsIds": "11344796",
"lastUpdate": "2024-05-23 11:08:13"
},
{
"ticketId": "11503094",
"mergedTickets": "2",
"mergedTicketsIds": "11614451;11503103",
"lastUpdate": "2024-06-07 16:34:05"
},
{
"ticketId": "11552230",
"mergedTickets": "3",
"mergedTicketsIds": "11593520;11592674;11592469",
"lastUpdate": "2024-05-02 21:02:47"
}
]
}
Respostas de Erro
- 404 - Not Found: O
idinformado não foi encontrado. - 400 - Bad Request: Erro nos parâmetros informados, como
startDatemaior queendDateou consulta fora dos parâmetros esperados.
Considerações Finais
Esta API é essencial para a gestão de tickets mesclados, permitindo tanto consultas individuais quanto por períodos, facilitando a administração de casos complexos onde múltiplos tickets foram unificados.