# Permissões de discagem de saída

## GET /pbx/outcalls

> Retorna uma permissão de saída

```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":{"ResponseOutcallControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da permissão de saída"},"name":{"type":"string","description":"Nome da permissão de saída"},"number_format":{"type":"string","description":"Expressão que representa o número de saída desta permissão de saída"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"time_group_id":{"type":"string","description":"ID de um grupo de horários (campo id da collection time_groups)"},"source":{"type":"string","description":"Identifica a origem do número na rota de saída."},"transhipments":{"description":"Lista de operadoras","type":"array","items":{"$ref":"#/components/schemas/Transhipment"}},"icon":{"type":"string","description":"Ícone que vai ser exibido na tela de permissões de saída."}},"required":["_id","name","number_format","enabled","time_group_id","source","transhipments","icon"]},"Transhipment":{"type":"object","properties":{"type":{"type":"string","description":"Tipo do transbordo."},"trunk_id":{"type":"string","description":"Operadora associada à esta rota"},"del_initial_digits":{"type":"number","description":"Quantidade de dígitos que devem ser removidos do início do número discado"},"add_digits_before":{"type":"string","description":"Dígitos que devem ser adicionados no início do número discado"},"add_digits_after":{"type":"string","description":"Dígitos que devem ser adicionados no final do número discado"},"call_id":{"type":"string","description":"Identificador de chamadas."},"removal_starting_position":{"type":"number","description":"Posição inicial de remoção."},"number_of_digits_to_remove":{"type":"number","description":"Número de digitos para remover."}},"required":["type","trunk_id","del_initial_digits","add_digits_before","add_digits_after","call_id","removal_starting_position","number_of_digits_to_remove"]}}},"paths":{"/pbx/outcalls":{"get":{"operationId":"OutcallsController_getOutcall","summary":"Retorna uma permissão de saída","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseOutcallControllerDto"}}}}},"tags":["Permissões de discagem de saída"]}}}}
```

## POST /pbx/outcalls

> Cadastro de permissão de saída

```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":{"CreateOutcallDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da permissão de saída"},"number_format":{"type":"string","description":"Expressão que representa o número de saída desta permissão de saída"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"time_group_id":{"type":"string","description":"ID de um grupo de horários (campo id da collection time_groups)"},"source":{"type":"string","description":"Identifica a origem do número na rota de saída."},"transhipments":{"description":"Lista de operadoras","type":"array","items":{"$ref":"#/components/schemas/Transhipment"}},"icon":{"type":"string","description":"Ícone que vai ser exibido na tela de permissões de saída."}},"required":["name","number_format","enabled","time_group_id","source","transhipments","icon"]},"Transhipment":{"type":"object","properties":{"type":{"type":"string","description":"Tipo do transbordo."},"trunk_id":{"type":"string","description":"Operadora associada à esta rota"},"del_initial_digits":{"type":"number","description":"Quantidade de dígitos que devem ser removidos do início do número discado"},"add_digits_before":{"type":"string","description":"Dígitos que devem ser adicionados no início do número discado"},"add_digits_after":{"type":"string","description":"Dígitos que devem ser adicionados no final do número discado"},"call_id":{"type":"string","description":"Identificador de chamadas."},"removal_starting_position":{"type":"number","description":"Posição inicial de remoção."},"number_of_digits_to_remove":{"type":"number","description":"Número de digitos para remover."}},"required":["type","trunk_id","del_initial_digits","add_digits_before","add_digits_after","call_id","removal_starting_position","number_of_digits_to_remove"]},"ResponseOutcallControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da permissão de saída"},"name":{"type":"string","description":"Nome da permissão de saída"},"number_format":{"type":"string","description":"Expressão que representa o número de saída desta permissão de saída"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"time_group_id":{"type":"string","description":"ID de um grupo de horários (campo id da collection time_groups)"},"source":{"type":"string","description":"Identifica a origem do número na rota de saída."},"transhipments":{"description":"Lista de operadoras","type":"array","items":{"$ref":"#/components/schemas/Transhipment"}},"icon":{"type":"string","description":"Ícone que vai ser exibido na tela de permissões de saída."}},"required":["_id","name","number_format","enabled","time_group_id","source","transhipments","icon"]}}},"paths":{"/pbx/outcalls":{"post":{"operationId":"OutcallsController_createOutcall","summary":"Cadastro de permissão de saída","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOutcallDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseOutcallControllerDto"}}}}},"tags":["Permissões de discagem de saída"]}}}}
```

## PUT /pbx/outcalls

> Atualiza uma permissão de saída

```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":{"UpdateOutcallDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da permissão de saída"},"number_format":{"type":"string","description":"Expressão que representa o número de saída desta permissão de saída"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"time_group_id":{"type":"string","description":"ID de um grupo de horários (campo id da collection time_groups)"},"source":{"type":"string","description":"Identifica a origem do número na rota de saída."},"transhipments":{"description":"Lista de operadoras","type":"array","items":{"$ref":"#/components/schemas/Transhipment"}},"icon":{"type":"string","description":"Ícone que vai ser exibido na tela de permissões de saída."},"_id":{"type":"string","description":"ID da permissão de saída"}},"required":["name","number_format","enabled","time_group_id","source","transhipments","icon","_id"]},"Transhipment":{"type":"object","properties":{"type":{"type":"string","description":"Tipo do transbordo."},"trunk_id":{"type":"string","description":"Operadora associada à esta rota"},"del_initial_digits":{"type":"number","description":"Quantidade de dígitos que devem ser removidos do início do número discado"},"add_digits_before":{"type":"string","description":"Dígitos que devem ser adicionados no início do número discado"},"add_digits_after":{"type":"string","description":"Dígitos que devem ser adicionados no final do número discado"},"call_id":{"type":"string","description":"Identificador de chamadas."},"removal_starting_position":{"type":"number","description":"Posição inicial de remoção."},"number_of_digits_to_remove":{"type":"number","description":"Número de digitos para remover."}},"required":["type","trunk_id","del_initial_digits","add_digits_before","add_digits_after","call_id","removal_starting_position","number_of_digits_to_remove"]},"ResponseOutcallControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da permissão de saída"},"name":{"type":"string","description":"Nome da permissão de saída"},"number_format":{"type":"string","description":"Expressão que representa o número de saída desta permissão de saída"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"time_group_id":{"type":"string","description":"ID de um grupo de horários (campo id da collection time_groups)"},"source":{"type":"string","description":"Identifica a origem do número na rota de saída."},"transhipments":{"description":"Lista de operadoras","type":"array","items":{"$ref":"#/components/schemas/Transhipment"}},"icon":{"type":"string","description":"Ícone que vai ser exibido na tela de permissões de saída."}},"required":["_id","name","number_format","enabled","time_group_id","source","transhipments","icon"]}}},"paths":{"/pbx/outcalls":{"put":{"operationId":"OutcallsController_updateOutcall","summary":"Atualiza uma permissão de saída","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOutcallDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseOutcallControllerDto"}}}}},"tags":["Permissões de discagem de saída"]}}}}
```

## DELETE /pbx/outcalls

> Deleta uma permissão de saída

```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":{"RemoveCommonResponse":{"type":"object","properties":{"count":{"type":"number","description":"Quantidade de registros deletados"}},"required":["count"]}}},"paths":{"/pbx/outcalls":{"delete":{"operationId":"OutcallsController_deleteOneOutcall","summary":"Deleta uma permissão de saída","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Permissões de discagem de saída"]}}}}
```

## GET /pbx/outcalls/all

> Retorna lista de permissões de saída

```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":{"ResponseOutcallControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da permissão de saída"},"name":{"type":"string","description":"Nome da permissão de saída"},"number_format":{"type":"string","description":"Expressão que representa o número de saída desta permissão de saída"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"time_group_id":{"type":"string","description":"ID de um grupo de horários (campo id da collection time_groups)"},"source":{"type":"string","description":"Identifica a origem do número na rota de saída."},"transhipments":{"description":"Lista de operadoras","type":"array","items":{"$ref":"#/components/schemas/Transhipment"}},"icon":{"type":"string","description":"Ícone que vai ser exibido na tela de permissões de saída."}},"required":["_id","name","number_format","enabled","time_group_id","source","transhipments","icon"]},"Transhipment":{"type":"object","properties":{"type":{"type":"string","description":"Tipo do transbordo."},"trunk_id":{"type":"string","description":"Operadora associada à esta rota"},"del_initial_digits":{"type":"number","description":"Quantidade de dígitos que devem ser removidos do início do número discado"},"add_digits_before":{"type":"string","description":"Dígitos que devem ser adicionados no início do número discado"},"add_digits_after":{"type":"string","description":"Dígitos que devem ser adicionados no final do número discado"},"call_id":{"type":"string","description":"Identificador de chamadas."},"removal_starting_position":{"type":"number","description":"Posição inicial de remoção."},"number_of_digits_to_remove":{"type":"number","description":"Número de digitos para remover."}},"required":["type","trunk_id","del_initial_digits","add_digits_before","add_digits_after","call_id","removal_starting_position","number_of_digits_to_remove"]}}},"paths":{"/pbx/outcalls/all":{"get":{"operationId":"OutcallsController_getOutcalls","summary":"Retorna lista de permissões de saída","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseOutcallControllerDto"}}}}}},"tags":["Permissões de discagem de saída"]}}}}
```

## DELETE /pbx/outcalls/all

> Deleta todas as permissões de saída

```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":{"RemoveCommonResponse":{"type":"object","properties":{"count":{"type":"number","description":"Quantidade de registros deletados"}},"required":["count"]}}},"paths":{"/pbx/outcalls/all":{"delete":{"operationId":"OutcallsController_deleteAllOutcalls","summary":"Deleta todas as permissões de saída","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Permissões de discagem de saída"]}}}}
```

## PUT /pbx/outcalls/update\_position

> Atualiza a posição das rotas

```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":{"UpdatePositionRouteDto":{"type":"object","properties":{"old_position":{"type":"number","description":"A antiga posição"},"new_position":{"type":"number","description":"A nova posição"}},"required":["old_position","new_position"]},"ResponseUpdatePositionRouteBackendDto":{"type":"object","properties":{"sucess":{"type":"string","description":""}},"required":["sucess"]}}},"paths":{"/pbx/outcalls/update_position":{"put":{"operationId":"OutcallsController_updatePositionIncallsRoute","summary":"Atualiza a posição das rotas","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePositionRouteDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUpdatePositionRouteBackendDto"}}}}},"tags":["Permissões de discagem de saída"]}}}}
```


---

# 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/permissoes-de-discagem-de-saida.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.