# Permissões de discagem de entrada

## GET /pbx/incalls

> Retorna uma permissão de entrada

```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":{"ResponseIncallControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da permissão de entrada"},"name":{"type":"string","description":"Nome da permissão de entrada"},"did":{"type":"string","description":"DDR da permissão de entrada"},"dst":{"type":"string","description":"Destino da rota de entrada neste horário"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"tags":{"description":"Lista de tags","type":"array","items":{"type":"string"}},"source_numbers":{"description":"Lista de expressões de números de origem","type":"array","items":{"type":"string"}},"trunk_id":{"type":"string","description":"Operadora associada a esta rota (campo id da collection voice_trunks)"},"route_by_time":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/routeByTime"}},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, group, ivr, outcall, by_did]"},"direct_whatsapp_agent":{"type":"boolean","description":"Receber ligações do whatsapp"}},"required":["_id","name","did","dst","enabled","tags","source_numbers","trunk_id","route_by_time","audio_ids","dst_type","direct_whatsapp_agent"]},"routeByTime":{"type":"object","properties":{"time_group_id":{"type":"string","description":"ID de um grupo de horário "},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, campaign, ivr, did]"},"dst":{"type":"string","description":"Destino da rota de entrada neste horário"}},"required":["time_group_id","audio_ids","dst_type","dst"]}}},"paths":{"/pbx/incalls":{"get":{"operationId":"IncallsController_getIncall","summary":"Retorna uma permissão de entrada","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseIncallControllerDto"}}}}},"tags":["Permissões de discagem de entrada"]}}}}
```

## POST /pbx/incalls

> Cadastro de permissão de entrada

```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":{"CreateIncallDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da permissão de entrada"},"did":{"type":"string","description":"DDR da permissão de entrada"},"dst":{"type":"string","description":"Destino default da permissão de entrada"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"tags":{"description":"Lista de tags","type":"array","items":{"type":"string"}},"source_numbers":{"description":"Lista de expressões de números de origem","type":"array","items":{"type":"string"}},"trunk_id":{"type":"string","description":"Operadora associada à esta rota (campo id da collection voice_trunks)"},"route_by_time":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/routeByTime"}},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, campaign, ivr, did]"},"direct_whatsapp_agent":{"type":"boolean","description":"Receber ligações do whatsapp"}},"required":["name","did","dst","enabled","tags","source_numbers","trunk_id","route_by_time","audio_ids","dst_type","direct_whatsapp_agent"]},"routeByTime":{"type":"object","properties":{"time_group_id":{"type":"string","description":"ID de um grupo de horário "},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, campaign, ivr, did]"},"dst":{"type":"string","description":"Destino da rota de entrada neste horário"}},"required":["time_group_id","audio_ids","dst_type","dst"]},"ResponseIncallControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da permissão de entrada"},"name":{"type":"string","description":"Nome da permissão de entrada"},"did":{"type":"string","description":"DDR da permissão de entrada"},"dst":{"type":"string","description":"Destino da rota de entrada neste horário"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"tags":{"description":"Lista de tags","type":"array","items":{"type":"string"}},"source_numbers":{"description":"Lista de expressões de números de origem","type":"array","items":{"type":"string"}},"trunk_id":{"type":"string","description":"Operadora associada a esta rota (campo id da collection voice_trunks)"},"route_by_time":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/routeByTime"}},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, group, ivr, outcall, by_did]"},"direct_whatsapp_agent":{"type":"boolean","description":"Receber ligações do whatsapp"}},"required":["_id","name","did","dst","enabled","tags","source_numbers","trunk_id","route_by_time","audio_ids","dst_type","direct_whatsapp_agent"]}}},"paths":{"/pbx/incalls":{"post":{"operationId":"IncallsController_createIncall","summary":"Cadastro de permissão de entrada","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIncallDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseIncallControllerDto"}}}}},"tags":["Permissões de discagem de entrada"]}}}}
```

## PUT /pbx/incalls

> Atualiza uma permissão de entrada

```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":{"UpdateIncallDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da permissão de entrada"},"did":{"type":"string","description":"DDR da permissão de entrada"},"dst":{"type":"string","description":"Destino default da permissão de entrada"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"tags":{"description":"Lista de tags","type":"array","items":{"type":"string"}},"source_numbers":{"description":"Lista de expressões de números de origem","type":"array","items":{"type":"string"}},"trunk_id":{"type":"string","description":"Operadora associada à esta rota (campo id da collection voice_trunks)"},"route_by_time":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/routeByTime"}},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, campaign, ivr, did]"},"direct_whatsapp_agent":{"type":"boolean","description":"Receber ligações do whatsapp"},"_id":{"type":"string","description":"ID da permissão de entrada"}},"required":["name","did","dst","enabled","tags","source_numbers","trunk_id","route_by_time","audio_ids","dst_type","direct_whatsapp_agent","_id"]},"routeByTime":{"type":"object","properties":{"time_group_id":{"type":"string","description":"ID de um grupo de horário "},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, campaign, ivr, did]"},"dst":{"type":"string","description":"Destino da rota de entrada neste horário"}},"required":["time_group_id","audio_ids","dst_type","dst"]},"ResponseIncallControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da permissão de entrada"},"name":{"type":"string","description":"Nome da permissão de entrada"},"did":{"type":"string","description":"DDR da permissão de entrada"},"dst":{"type":"string","description":"Destino da rota de entrada neste horário"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"tags":{"description":"Lista de tags","type":"array","items":{"type":"string"}},"source_numbers":{"description":"Lista de expressões de números de origem","type":"array","items":{"type":"string"}},"trunk_id":{"type":"string","description":"Operadora associada a esta rota (campo id da collection voice_trunks)"},"route_by_time":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/routeByTime"}},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, group, ivr, outcall, by_did]"},"direct_whatsapp_agent":{"type":"boolean","description":"Receber ligações do whatsapp"}},"required":["_id","name","did","dst","enabled","tags","source_numbers","trunk_id","route_by_time","audio_ids","dst_type","direct_whatsapp_agent"]}}},"paths":{"/pbx/incalls":{"put":{"operationId":"IncallsController_updateIncall","summary":"Atualiza uma permissão de entrada","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIncallDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseIncallControllerDto"}}}}},"tags":["Permissões de discagem de entrada"]}}}}
```

## DELETE /pbx/incalls

> Deleta uma permissão de entrada

```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/incalls":{"delete":{"operationId":"IncallsController_deleteOneIncall","summary":"Deleta uma permissão de entrada","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 entrada"]}}}}
```

## GET /pbx/incalls/all

> Retorna lista de permissões de entrada

```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":{"ResponseIncallControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da permissão de entrada"},"name":{"type":"string","description":"Nome da permissão de entrada"},"did":{"type":"string","description":"DDR da permissão de entrada"},"dst":{"type":"string","description":"Destino da rota de entrada neste horário"},"enabled":{"type":"number","description":"Flag que indica se a rota está ativa (1) ou não (0)"},"tags":{"description":"Lista de tags","type":"array","items":{"type":"string"}},"source_numbers":{"description":"Lista de expressões de números de origem","type":"array","items":{"type":"string"}},"trunk_id":{"type":"string","description":"Operadora associada a esta rota (campo id da collection voice_trunks)"},"route_by_time":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/routeByTime"}},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, group, ivr, outcall, by_did]"},"direct_whatsapp_agent":{"type":"boolean","description":"Receber ligações do whatsapp"}},"required":["_id","name","did","dst","enabled","tags","source_numbers","trunk_id","route_by_time","audio_ids","dst_type","direct_whatsapp_agent"]},"routeByTime":{"type":"object","properties":{"time_group_id":{"type":"string","description":"ID de um grupo de horário "},"audio_ids":{"description":"Ids dos áudios da playlist system","type":"array","items":{"type":"string"}},"dst_type":{"type":"string","description":"Tipo do destino [agent, campaign, ivr, did]"},"dst":{"type":"string","description":"Destino da rota de entrada neste horário"}},"required":["time_group_id","audio_ids","dst_type","dst"]}}},"paths":{"/pbx/incalls/all":{"get":{"operationId":"IncallsController_getIncalls","summary":"Retorna lista de permissões de entrada","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseIncallControllerDto"}}}}}},"tags":["Permissões de discagem de entrada"]}}}}
```

## DELETE /pbx/incalls/all

> Deleta todas as permissões de entrada

```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/incalls/all":{"delete":{"operationId":"IncallsController_deleteAllIncalls","summary":"Deleta todas as permissões de entrada","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Permissões de discagem de entrada"]}}}}
```

## PUT /pbx/incalls/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/incalls/update_position":{"put":{"operationId":"IncallsController_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 entrada"]}}}}
```


---

# 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-entrada.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.