# Desvios

## GET /pbx/forwards

> Retorna lista de Desvios paginada

```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":{"ResponseForwardControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do desvio"},"agent_id":{"type":"string","description":"ID do agente ao qual a regra de desvio está associada."},"conditions":{"description":"Lista de condições dos desvios","allOf":[{"$ref":"#/components/schemas/ConditionsDto"}]}},"required":["_id","agent_id","conditions"]},"ConditionsDto":{"type":"object","properties":{"always":{"type":"string","description":"Desvio sempre"},"busy":{"type":"string","description":"Desvio quando ocupado"},"noanswer":{"type":"string","description":"Desvio quando não tiver resposta"}},"required":["always","busy","noanswer"]}}},"paths":{"/pbx/forwards":{"get":{"operationId":"ForwardsController_getForwards","summary":"Retorna lista de Desvios paginada","parameters":[{"name":"limit","required":false,"in":"query","description":"Quantidade de registros por página","schema":{"default":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Número da página de registros que deverá ser exibida","schema":{"default":1,"type":"number"}},{"name":"sort","required":false,"in":"query","description":"Indica como deve ser a ordenação dos contatos internos: asc ou desc","schema":{"default":"ASC","enum":["asc","desc"],"type":"string"}},{"name":"sort_field","required":false,"in":"query","description":"Indica por qual campo deve ser a ordenação","schema":{"default":"agent_id","type":"string"}},{"name":"search_fields","required":false,"in":"query","description":"Indica o campo a ser filtrado.","schema":{"type":"string"}},{"name":"search_values","required":false,"in":"query","description":"Lista de valores correspondentes aos campos filtrados.","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseForwardControllerDto"}}}}}},"tags":["Desvios"]}}}}
```

## POST /pbx/forwards

> Cadastro de desvio

```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":{"CreateForwardDto":{"type":"object","properties":{"agent_id":{"type":"string","description":"ID do agente ao qual a regra de desvio está associada."},"conditions":{"description":"Lista de condições dos desvios","allOf":[{"$ref":"#/components/schemas/ConditionsDto"}]}},"required":["agent_id","conditions"]},"ConditionsDto":{"type":"object","properties":{"always":{"type":"string","description":"Desvio sempre"},"busy":{"type":"string","description":"Desvio quando ocupado"},"noanswer":{"type":"string","description":"Desvio quando não tiver resposta"}},"required":["always","busy","noanswer"]},"ResponseForwardControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do desvio"},"agent_id":{"type":"string","description":"ID do agente ao qual a regra de desvio está associada."},"conditions":{"description":"Lista de condições dos desvios","allOf":[{"$ref":"#/components/schemas/ConditionsDto"}]}},"required":["_id","agent_id","conditions"]}}},"paths":{"/pbx/forwards":{"post":{"operationId":"ForwardsController_createForward","summary":"Cadastro de desvio","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateForwardDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForwardControllerDto"}}}}},"tags":["Desvios"]}}}}
```

## PUT /pbx/forwards

> Atualiza uma desvio

```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":{"UpdateForwardDto":{"type":"object","properties":{"agent_id":{"type":"string","description":"ID do agente ao qual a regra de desvio está associada."},"conditions":{"description":"Lista de condições dos desvios","allOf":[{"$ref":"#/components/schemas/ConditionsDto"}]},"_id":{"type":"string","description":"ID do desvio"}},"required":["agent_id","conditions","_id"]},"ConditionsDto":{"type":"object","properties":{"always":{"type":"string","description":"Desvio sempre"},"busy":{"type":"string","description":"Desvio quando ocupado"},"noanswer":{"type":"string","description":"Desvio quando não tiver resposta"}},"required":["always","busy","noanswer"]},"ResponseForwardControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do desvio"},"agent_id":{"type":"string","description":"ID do agente ao qual a regra de desvio está associada."},"conditions":{"description":"Lista de condições dos desvios","allOf":[{"$ref":"#/components/schemas/ConditionsDto"}]}},"required":["_id","agent_id","conditions"]}}},"paths":{"/pbx/forwards":{"put":{"operationId":"ForwardsController_updateForward","summary":"Atualiza uma desvio","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateForwardDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForwardControllerDto"}}}}},"tags":["Desvios"]}}}}
```

## DELETE /pbx/forwards

> Deleta Desvios

```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":{"DeleteForwardDto":{"type":"object","properties":{"ids":{"type":"string","description":"IDs dos desvios"}},"required":["ids"]},"ResponseDeleteForwardControllerDto":{"type":"object","properties":{"success":{"type":"boolean","description":"Se a operação foi bem sucedida"},"count":{"type":"number","description":"Quantidade de registro deletados"},"message":{"type":"string","description":"Messagem caso ocorra algum erro"}},"required":["success","count","message"]}}},"paths":{"/pbx/forwards":{"delete":{"operationId":"ForwardsController_deleteForward","summary":"Deleta Desvios","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteForwardDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDeleteForwardControllerDto"}}}}},"tags":["Desvios"]}}}}
```


---

# 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/desvios.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.