# Permissões de discagem interna

## GET /pbx/internal\_route

> Retorna uma permissão interna

```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":{"ResponseInternalRouteControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da rota interna"},"name":{"type":"string","description":"Nome da rota interna"},"extension":{"type":"string","description":"Ramal da rota interna"},"type":{"type":"string","description":"Tipo de rota interna"},"dst_type":{"type":"string","description":"Tipo do destino da rota interna"},"dst_identity":{"description":"Id e component_id do destino","type":"array","items":{"$ref":"#/components/schemas/DstIdentity"}},"position":{"type":"number","description":"Posição"},"enabled":{"type":"number","description":"Se a rota interna esta habilitada ou não"}},"required":["_id","name","extension","type","dst_type","dst_identity","position","enabled"]},"DstIdentity":{"type":"object","properties":{"id":{"type":"string","description":"ID da rota de destino"},"component_id":{"type":"string","description":"ID do componente de destino"}},"required":["id","component_id"]}}},"paths":{"/pbx/internal_route":{"get":{"operationId":"InternalRoutesController_getInternalRoute","summary":"Retorna uma permissão interna","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseInternalRouteControllerDto"}}}}},"tags":["Permissões de discagem interna"]}}}}
```

## POST /pbx/internal\_route

> Cadastro de permissão interna

```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":{"CreateInternalRouteDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da rota interna"},"extension":{"type":"string","description":"Número da rota interna"},"type":{"type":"string","description":"Indica o tipo do criador da rota interna, \"system\" ou \"user\""},"dst_type":{"type":"string","description":"Indica o tipo do destino da rota interna, \"agent\", \"campaign\", ou \"ivr\""},"dst_identity":{"description":"Objeto que indica o ID do destino da rota interna. Caso o destino seja uma URA, também será necessário repassar o component_id dentro do objeto.","allOf":[{"$ref":"#/components/schemas/DstIdentity"}]},"enabled":{"type":"number","description":"Indica se a rota está habilitada/desabilitada"}},"required":["name","extension","type","dst_type","dst_identity","enabled"]},"DstIdentity":{"type":"object","properties":{"id":{"type":"string","description":"ID da rota de destino"},"component_id":{"type":"string","description":"ID do componente de destino"}},"required":["id","component_id"]},"ResponseInternalRouteControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da rota interna"},"name":{"type":"string","description":"Nome da rota interna"},"extension":{"type":"string","description":"Ramal da rota interna"},"type":{"type":"string","description":"Tipo de rota interna"},"dst_type":{"type":"string","description":"Tipo do destino da rota interna"},"dst_identity":{"description":"Id e component_id do destino","type":"array","items":{"$ref":"#/components/schemas/DstIdentity"}},"position":{"type":"number","description":"Posição"},"enabled":{"type":"number","description":"Se a rota interna esta habilitada ou não"}},"required":["_id","name","extension","type","dst_type","dst_identity","position","enabled"]}}},"paths":{"/pbx/internal_route":{"post":{"operationId":"InternalRoutesController_createInternalRoute","summary":"Cadastro de permissão interna","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInternalRouteDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseInternalRouteControllerDto"}}}}},"tags":["Permissões de discagem interna"]}}}}
```

## PUT /pbx/internal\_route

> Atualiza uma permissão interna

```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":{"UpdateInternalRouteDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da rota interna"},"extension":{"type":"string","description":"Número da rota interna"},"type":{"type":"string","description":"Indica o tipo do criador da rota interna, \"system\" ou \"user\""},"dst_type":{"type":"string","description":"Indica o tipo do destino da rota interna, \"agent\", \"campaign\", ou \"ivr\""},"dst_identity":{"description":"Objeto que indica o ID do destino da rota interna. Caso o destino seja uma URA, também será necessário repassar o component_id dentro do objeto.","allOf":[{"$ref":"#/components/schemas/DstIdentity"}]},"enabled":{"type":"number","description":"Indica se a rota está habilitada/desabilitada"},"_id":{"type":"string","description":"ID da permissão de entrada"}},"required":["name","extension","type","dst_type","dst_identity","enabled","_id"]},"DstIdentity":{"type":"object","properties":{"id":{"type":"string","description":"ID da rota de destino"},"component_id":{"type":"string","description":"ID do componente de destino"}},"required":["id","component_id"]},"ResponseInternalRouteControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da rota interna"},"name":{"type":"string","description":"Nome da rota interna"},"extension":{"type":"string","description":"Ramal da rota interna"},"type":{"type":"string","description":"Tipo de rota interna"},"dst_type":{"type":"string","description":"Tipo do destino da rota interna"},"dst_identity":{"description":"Id e component_id do destino","type":"array","items":{"$ref":"#/components/schemas/DstIdentity"}},"position":{"type":"number","description":"Posição"},"enabled":{"type":"number","description":"Se a rota interna esta habilitada ou não"}},"required":["_id","name","extension","type","dst_type","dst_identity","position","enabled"]}}},"paths":{"/pbx/internal_route":{"put":{"operationId":"InternalRoutesController_updateInternalRoute","summary":"Atualiza uma permissão interna","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInternalRouteDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseInternalRouteControllerDto"}}}}},"tags":["Permissões de discagem interna"]}}}}
```

## DELETE /pbx/internal\_route

> Deleta uma permissão interna

```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/internal_route":{"delete":{"operationId":"InternalRoutesController_deleteOneInternalRoute","summary":"Deleta uma permissão interna","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Permissões de discagem interna"]}}}}
```

## GET /pbx/internal\_route/all

> Retorna lista de permissões internas

```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":{"ResponseInternalRouteControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da rota interna"},"name":{"type":"string","description":"Nome da rota interna"},"extension":{"type":"string","description":"Ramal da rota interna"},"type":{"type":"string","description":"Tipo de rota interna"},"dst_type":{"type":"string","description":"Tipo do destino da rota interna"},"dst_identity":{"description":"Id e component_id do destino","type":"array","items":{"$ref":"#/components/schemas/DstIdentity"}},"position":{"type":"number","description":"Posição"},"enabled":{"type":"number","description":"Se a rota interna esta habilitada ou não"}},"required":["_id","name","extension","type","dst_type","dst_identity","position","enabled"]},"DstIdentity":{"type":"object","properties":{"id":{"type":"string","description":"ID da rota de destino"},"component_id":{"type":"string","description":"ID do componente de destino"}},"required":["id","component_id"]}}},"paths":{"/pbx/internal_route/all":{"get":{"operationId":"InternalRoutesController_getInternalRoutes","summary":"Retorna lista de permissões internas","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseInternalRouteControllerDto"}}}}}},"tags":["Permissões de discagem interna"]}}}}
```

## PUT /pbx/internal\_route/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/internal_route/update_position":{"put":{"operationId":"InternalRoutesController_updatePositionInternalRoute","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 interna"]}}}}
```


---

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