# Relatório

## GET /pbx/reports/cdr

> Retorna lista de relatórios

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"ResponseReportsControllerDto":{"type":"object","properties":{"Datetime":{"type":"string","description":"ID do agente"},"Protocol":{"type":"string","description":"Nome do agente"},"CallerID":{"type":"string","description":"Número do ramal do agente"},"Source":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"Destination":{"type":"string","description":"Horário inicial de login do agente"},"Duration":{"type":"string","description":"Horário final de login do agente"},"BillableSeconds":{"type":"string","description":"ID da equipe do agente"},"Disposition":{"type":"string","description":"Tecnologia do ramal do agente"},"ContactName":{"type":"string","description":"Nome do contato"},"ContactPhoto":{"type":"string","description":"Foto do contato"}},"required":["Datetime","Protocol","CallerID","Source","Destination","Duration","BillableSeconds","Disposition","ContactName","ContactPhoto"]}}},"paths":{"/pbx/reports/cdr":{"get":{"operationId":"ReportsController_getReport","summary":"Retorna lista de relatórios","parameters":[{"name":"disposition","required":false,"in":"query","schema":{"type":"string"}},{"name":"number","required":false,"in":"query","schema":{"type":"string"}},{"name":"protocol","required":false,"in":"query","schema":{"type":"string"}},{"name":"until","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseReportsControllerDto"}}}}}},"tags":["Relatório"]}}}}
```

## GET /pbx/reports/recents

> Retona ligações recentes do agente

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"ResponseReportsControllerDto":{"type":"object","properties":{"Datetime":{"type":"string","description":"ID do agente"},"Protocol":{"type":"string","description":"Nome do agente"},"CallerID":{"type":"string","description":"Número do ramal do agente"},"Source":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"Destination":{"type":"string","description":"Horário inicial de login do agente"},"Duration":{"type":"string","description":"Horário final de login do agente"},"BillableSeconds":{"type":"string","description":"ID da equipe do agente"},"Disposition":{"type":"string","description":"Tecnologia do ramal do agente"},"ContactName":{"type":"string","description":"Nome do contato"},"ContactPhoto":{"type":"string","description":"Foto do contato"}},"required":["Datetime","Protocol","CallerID","Source","Destination","Duration","BillableSeconds","Disposition","ContactName","ContactPhoto"]}}},"paths":{"/pbx/reports/recents":{"get":{"operationId":"ReportsController_getCallsRecents","summary":"Retona ligações recentes do agente","parameters":[{"name":"from","required":false,"in":"query","description":"Ignora chamadas que iniciaram antes desta Data/hora. O formato da Data/hora segue o padrão ISO_8601","schema":{"type":"string"}},{"name":"until","required":false,"in":"query","description":"Ignora chamadas que iniciaram depois desta Data/hora. O formato da Data/hora segue o padrão ISO_8601","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"Número da página que deverá ser exibida","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Número máximo de registros a serem retornados","schema":{"type":"string"}},{"name":"extension","required":true,"in":"query","description":"Número de origem ou destino da ligação.","schema":{"type":"string"}},{"name":"disposition","required":false,"in":"query","description":"Status da chamada (opcional)","schema":{"enum":["answered","noanswer","busy"],"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseReportsControllerDto"}}}}}},"tags":["Relatório"]}}}}
```

## GET /pbx/reports/timeline/resumed

> Retorna lista de relatórios

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"ResponseReportsTimelineControllerDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ResponseTimelineControllerDto"}},"meta":{"description":"Propriedades da paginação","allOf":[{"$ref":"#/components/schemas/Meta"}]}},"required":["items","meta"]},"ResponseTimelineControllerDto":{"type":"object","properties":{"X_StartEventTimestamp":{"type":"string"},"Protocol":{"type":"string"},"X_FinalStatus":{"type":"string"},"X_DestinationNumber":{"type":"string"},"X_CallType":{"type":"string"},"X_SourceNumber":{"type":"string"}},"required":["X_StartEventTimestamp","Protocol","X_FinalStatus","X_DestinationNumber","X_CallType","X_SourceNumber"]},"Meta":{"type":"object","properties":{"totalItems":{"type":"number","description":"Total de itens"},"itemCount":{"type":"number","description":"Quantidade de itens"},"itemsPerPage":{"type":"number","description":"Quantidade de itens por páginas"},"totalPages":{"type":"number","description":"Total de páginas"},"currentPage":{"type":"number","description":"Página atual"}},"required":["totalItems","itemCount","itemsPerPage","totalPages","currentPage"]}}},"paths":{"/pbx/reports/timeline/resumed":{"get":{"operationId":"ReportsController_getReportTimelineResumedPaginated","summary":"Retorna lista de relatórios","parameters":[{"name":"limit","required":false,"in":"query","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","schema":{"type":"string"}},{"name":"status","required":false,"in":"query","schema":{"type":"string"}},{"name":"numbers","required":false,"in":"query","schema":{"type":"string"}},{"name":"protocol","required":false,"in":"query","schema":{"type":"string"}},{"name":"until","required":false,"in":"query","schema":{"type":"string"}},{"name":"from","required":false,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseReportsTimelineControllerDto"}}}}},"tags":["Relatório"]}}}}
```

## GET /pbx/reports/timeline/detailed

> Retorna lista de relatórios

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"ResponseTimelineDetailedControllerDto":{"type":"object","properties":{"X_SourceName":{"type":"string"},"X_SourceNumber":{"type":"string"},"X_SourceId":{"type":"string"},"X_DestinationName":{"type":"string"},"X_DestinationNumber":{"type":"string"},"X_DestinationId":{"type":"string"},"X_DestinationType":{"type":"string"},"X_StartEventTimestamp":{"type":"string"},"X_CallType":{"type":"string"},"X_TrunkInName":{"type":"string"},"X_TrunkInId":{"type":"string"},"X_TrunkOutName":{"type":"string"},"X_TrunkOutId":{"type":"string"},"X_FinalStatus":{"type":"string"},"X_RecordingFile":{"type":"string"},"X_RecordingStream":{"type":"string"},"X_ContactName":{"type":"string"},"X_ContactPhoto":{"type":"string"},"X_GroupSourceIds":{"type":"string"},"X_Status":{"type":"string"},"Protocol":{"type":"string"},"Duration":{"type":"string"},"BillableSeconds":{"type":"string"}},"required":["X_SourceName","X_SourceNumber","X_SourceId","X_DestinationName","X_DestinationNumber","X_DestinationId","X_DestinationType","X_StartEventTimestamp","X_CallType","X_TrunkInName","X_TrunkInId","X_TrunkOutName","X_TrunkOutId","X_FinalStatus","X_RecordingFile","X_RecordingStream","X_ContactName","X_ContactPhoto","X_GroupSourceIds","X_Status","Protocol","Duration","BillableSeconds"]}}},"paths":{"/pbx/reports/timeline/detailed":{"get":{"operationId":"ReportsController_getReportTimelineDetailedPaginated","summary":"Retorna lista de relatórios","parameters":[{"name":"protocol","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseTimelineDetailedControllerDto"}}}}}},"tags":["Relatório"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fortics.com.br/voice-api-reference/reference/relatorio.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
