# URAS/Fluxos

## GET /pbx/flow

> Retorna uma URA/fluxo

```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":{"ResponseFlowControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do fluxo"},"name":{"type":"string","description":"Nome do fluxo"},"flow":{"description":"Lista de componentes que compoem o fluxo","type":"array","items":{"$ref":"#/components/schemas/Flow"}}},"required":["_id","name","flow"]},"Flow":{"type":"object","properties":{"component":{"type":"string","description":"Tipo do componente"},"component_id":{"type":"string","description":"Id do componente"},"name":{"type":"string","description":"Nome do componente"},"message":{"type":"string","description":"Mensagem que será falada quando o recurso de tts estiver ativado"},"direct_access":{"type":"boolean","description":"Permite acesso aos ramais internos ou não através da URA"},"audio_messages":{"description":"Lista de áudios da URA","type":"array","items":{"type":"string"}},"max_attempts":{"description":"Configurações de número máximo de tentativas, redirecionamento em caso de falha, timeout, etc.","type":"array","items":{"$ref":"#/components/schemas/MaxAttempts"}},"options":{"description":"Lista de opções","type":"array","items":{"$ref":"#/components/schemas/Options"}},"next_component":{"description":"Lista dos component_id dos proximos components","type":"array","items":{"type":"string"}},"continue":{"type":"boolean","description":"Continue"},"audio_after_call":{"type":"string","description":"Id do Áudio"},"conditions":{"description":"Lista de condições","type":"array","items":{"$ref":"#/components/schemas/Condition"}},"timeout":{"type":"number","description":"Tempo limite de espera"},"questions":{"description":"Lista de Question","type":"array","items":{"$ref":"#/components/schemas/Question"}}},"required":["component","component_id","name","message","direct_access","audio_messages","max_attempts","options","next_component","continue","audio_after_call","conditions","timeout","questions"]},"MaxAttempts":{"type":"object","properties":{"value":{"type":"number","description":"Número máximo de tentativas inválidas na URA"},"redirect":{"type":"string","description":"Destino para onde a ligação será roteada, caso o número máximo de tentativas tenha sido atingido"},"timeout_between_attempts":{"type":"number","description":"Timeout entre as tentativas de digitação da opção da URA"},"audios_on_retry":{"description":"Id dos Áudios que serão reproduzidos em cada tentativa quando o timeout for atingido","type":"array","items":{"type":"string"}},"audios_on_invalid":{"description":"Id dos Áudios que serão reproduzidos em cada tentativa inválida de digitação","type":"array","items":{"type":"string"}}},"required":["value","redirect","timeout_between_attempts","audios_on_retry","audios_on_invalid"]},"Options":{"type":"object","properties":{"num":{"type":"number","description":"Valor da opção da URA"},"description":{"type":"string","description":"Descrição da opção"},"redirect":{"type":"string","description":"Id do Destino para onde a ligação será roteada, caso a opção seja digitada"},"option_fail":{"type":"boolean","description":""}},"required":["num","description","redirect","option_fail"]},"Condition":{"type":"object","properties":{"redirect":{"type":"string","description":"String vazia ou Id do proximo component"},"time_group_id":{"type":"string","description":"Id do time group"}},"required":["redirect","time_group_id"]},"Question":{"type":"object","properties":{"audio_messages":{"description":"Lista de áudios da URA","type":"array","items":{"type":"string"}},"max_attempts":{"description":"Configurações de número máximo de tentativas, redirecionamento em caso de falha, timeout, etc.","type":"array","items":{"$ref":"#/components/schemas/MaxAttempts"}},"valid_notes":{"description":"Lista das notas possiveis","type":"array","items":{"type":"number"}}},"required":["audio_messages","max_attempts","valid_notes"]}}},"paths":{"/pbx/flow":{"get":{"operationId":"FlowController_getFlow","summary":"Retorna uma URA/fluxo","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseFlowControllerDto"}}}}},"tags":["URAS/Fluxos"]}}}}
```

## POST /pbx/flow

> Cadastro de URA/fluxo

```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":{"CreateFlowDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome do fluxo"},"flow":{"description":"Lista de componentes que compoem o fluxo","type":"array","items":{"$ref":"#/components/schemas/Flow"}}},"required":["name","flow"]},"Flow":{"type":"object","properties":{"component":{"type":"string","description":"Tipo do componente"},"component_id":{"type":"string","description":"Id do componente"},"name":{"type":"string","description":"Nome do componente"},"message":{"type":"string","description":"Mensagem que será falada quando o recurso de tts estiver ativado"},"direct_access":{"type":"boolean","description":"Permite acesso aos ramais internos ou não através da URA"},"audio_messages":{"description":"Lista de áudios da URA","type":"array","items":{"type":"string"}},"max_attempts":{"description":"Configurações de número máximo de tentativas, redirecionamento em caso de falha, timeout, etc.","type":"array","items":{"$ref":"#/components/schemas/MaxAttempts"}},"options":{"description":"Lista de opções","type":"array","items":{"$ref":"#/components/schemas/Options"}},"next_component":{"description":"Lista dos component_id dos proximos components","type":"array","items":{"type":"string"}},"continue":{"type":"boolean","description":"Continue"},"audio_after_call":{"type":"string","description":"Id do Áudio"},"conditions":{"description":"Lista de condições","type":"array","items":{"$ref":"#/components/schemas/Condition"}},"timeout":{"type":"number","description":"Tempo limite de espera"},"questions":{"description":"Lista de Question","type":"array","items":{"$ref":"#/components/schemas/Question"}}},"required":["component","component_id","name","message","direct_access","audio_messages","max_attempts","options","next_component","continue","audio_after_call","conditions","timeout","questions"]},"MaxAttempts":{"type":"object","properties":{"value":{"type":"number","description":"Número máximo de tentativas inválidas na URA"},"redirect":{"type":"string","description":"Destino para onde a ligação será roteada, caso o número máximo de tentativas tenha sido atingido"},"timeout_between_attempts":{"type":"number","description":"Timeout entre as tentativas de digitação da opção da URA"},"audios_on_retry":{"description":"Id dos Áudios que serão reproduzidos em cada tentativa quando o timeout for atingido","type":"array","items":{"type":"string"}},"audios_on_invalid":{"description":"Id dos Áudios que serão reproduzidos em cada tentativa inválida de digitação","type":"array","items":{"type":"string"}}},"required":["value","redirect","timeout_between_attempts","audios_on_retry","audios_on_invalid"]},"Options":{"type":"object","properties":{"num":{"type":"number","description":"Valor da opção da URA"},"description":{"type":"string","description":"Descrição da opção"},"redirect":{"type":"string","description":"Id do Destino para onde a ligação será roteada, caso a opção seja digitada"},"option_fail":{"type":"boolean","description":""}},"required":["num","description","redirect","option_fail"]},"Condition":{"type":"object","properties":{"redirect":{"type":"string","description":"String vazia ou Id do proximo component"},"time_group_id":{"type":"string","description":"Id do time group"}},"required":["redirect","time_group_id"]},"Question":{"type":"object","properties":{"audio_messages":{"description":"Lista de áudios da URA","type":"array","items":{"type":"string"}},"max_attempts":{"description":"Configurações de número máximo de tentativas, redirecionamento em caso de falha, timeout, etc.","type":"array","items":{"$ref":"#/components/schemas/MaxAttempts"}},"valid_notes":{"description":"Lista das notas possiveis","type":"array","items":{"type":"number"}}},"required":["audio_messages","max_attempts","valid_notes"]},"ResponseFlowControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do fluxo"},"name":{"type":"string","description":"Nome do fluxo"},"flow":{"description":"Lista de componentes que compoem o fluxo","type":"array","items":{"$ref":"#/components/schemas/Flow"}}},"required":["_id","name","flow"]}}},"paths":{"/pbx/flow":{"post":{"operationId":"FlowController_create","summary":"Cadastro de URA/fluxo","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFlowDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseFlowControllerDto"}}}}},"tags":["URAS/Fluxos"]}}}}
```

## PUT /pbx/flow

> Atualiza uma URA/fluxo

```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":{"UpdateFlowDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome do fluxo"},"flow":{"description":"Lista de componentes que compoem o fluxo","type":"array","items":{"$ref":"#/components/schemas/Flow"}},"_id":{"type":"string","description":"ID do fluxo"}},"required":["name","flow","_id"]},"Flow":{"type":"object","properties":{"component":{"type":"string","description":"Tipo do componente"},"component_id":{"type":"string","description":"Id do componente"},"name":{"type":"string","description":"Nome do componente"},"message":{"type":"string","description":"Mensagem que será falada quando o recurso de tts estiver ativado"},"direct_access":{"type":"boolean","description":"Permite acesso aos ramais internos ou não através da URA"},"audio_messages":{"description":"Lista de áudios da URA","type":"array","items":{"type":"string"}},"max_attempts":{"description":"Configurações de número máximo de tentativas, redirecionamento em caso de falha, timeout, etc.","type":"array","items":{"$ref":"#/components/schemas/MaxAttempts"}},"options":{"description":"Lista de opções","type":"array","items":{"$ref":"#/components/schemas/Options"}},"next_component":{"description":"Lista dos component_id dos proximos components","type":"array","items":{"type":"string"}},"continue":{"type":"boolean","description":"Continue"},"audio_after_call":{"type":"string","description":"Id do Áudio"},"conditions":{"description":"Lista de condições","type":"array","items":{"$ref":"#/components/schemas/Condition"}},"timeout":{"type":"number","description":"Tempo limite de espera"},"questions":{"description":"Lista de Question","type":"array","items":{"$ref":"#/components/schemas/Question"}}},"required":["component","component_id","name","message","direct_access","audio_messages","max_attempts","options","next_component","continue","audio_after_call","conditions","timeout","questions"]},"MaxAttempts":{"type":"object","properties":{"value":{"type":"number","description":"Número máximo de tentativas inválidas na URA"},"redirect":{"type":"string","description":"Destino para onde a ligação será roteada, caso o número máximo de tentativas tenha sido atingido"},"timeout_between_attempts":{"type":"number","description":"Timeout entre as tentativas de digitação da opção da URA"},"audios_on_retry":{"description":"Id dos Áudios que serão reproduzidos em cada tentativa quando o timeout for atingido","type":"array","items":{"type":"string"}},"audios_on_invalid":{"description":"Id dos Áudios que serão reproduzidos em cada tentativa inválida de digitação","type":"array","items":{"type":"string"}}},"required":["value","redirect","timeout_between_attempts","audios_on_retry","audios_on_invalid"]},"Options":{"type":"object","properties":{"num":{"type":"number","description":"Valor da opção da URA"},"description":{"type":"string","description":"Descrição da opção"},"redirect":{"type":"string","description":"Id do Destino para onde a ligação será roteada, caso a opção seja digitada"},"option_fail":{"type":"boolean","description":""}},"required":["num","description","redirect","option_fail"]},"Condition":{"type":"object","properties":{"redirect":{"type":"string","description":"String vazia ou Id do proximo component"},"time_group_id":{"type":"string","description":"Id do time group"}},"required":["redirect","time_group_id"]},"Question":{"type":"object","properties":{"audio_messages":{"description":"Lista de áudios da URA","type":"array","items":{"type":"string"}},"max_attempts":{"description":"Configurações de número máximo de tentativas, redirecionamento em caso de falha, timeout, etc.","type":"array","items":{"$ref":"#/components/schemas/MaxAttempts"}},"valid_notes":{"description":"Lista das notas possiveis","type":"array","items":{"type":"number"}}},"required":["audio_messages","max_attempts","valid_notes"]},"ResponseFlowControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do fluxo"},"name":{"type":"string","description":"Nome do fluxo"},"flow":{"description":"Lista de componentes que compoem o fluxo","type":"array","items":{"$ref":"#/components/schemas/Flow"}}},"required":["_id","name","flow"]}}},"paths":{"/pbx/flow":{"put":{"operationId":"FlowController_update","summary":"Atualiza uma URA/fluxo","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFlowDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseFlowControllerDto"}}}}},"tags":["URAS/Fluxos"]}}}}
```

## DELETE /pbx/flow

> Deleta uma URA/fluxo

```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/flow":{"delete":{"operationId":"FlowController_deleteOne","summary":"Deleta uma URA/fluxo","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["URAS/Fluxos"]}}}}
```

## GET /pbx/flow/all

> Retorna lista de URAS/fluxos

```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":{"ResponseFlowControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do fluxo"},"name":{"type":"string","description":"Nome do fluxo"},"flow":{"description":"Lista de componentes que compoem o fluxo","type":"array","items":{"$ref":"#/components/schemas/Flow"}}},"required":["_id","name","flow"]},"Flow":{"type":"object","properties":{"component":{"type":"string","description":"Tipo do componente"},"component_id":{"type":"string","description":"Id do componente"},"name":{"type":"string","description":"Nome do componente"},"message":{"type":"string","description":"Mensagem que será falada quando o recurso de tts estiver ativado"},"direct_access":{"type":"boolean","description":"Permite acesso aos ramais internos ou não através da URA"},"audio_messages":{"description":"Lista de áudios da URA","type":"array","items":{"type":"string"}},"max_attempts":{"description":"Configurações de número máximo de tentativas, redirecionamento em caso de falha, timeout, etc.","type":"array","items":{"$ref":"#/components/schemas/MaxAttempts"}},"options":{"description":"Lista de opções","type":"array","items":{"$ref":"#/components/schemas/Options"}},"next_component":{"description":"Lista dos component_id dos proximos components","type":"array","items":{"type":"string"}},"continue":{"type":"boolean","description":"Continue"},"audio_after_call":{"type":"string","description":"Id do Áudio"},"conditions":{"description":"Lista de condições","type":"array","items":{"$ref":"#/components/schemas/Condition"}},"timeout":{"type":"number","description":"Tempo limite de espera"},"questions":{"description":"Lista de Question","type":"array","items":{"$ref":"#/components/schemas/Question"}}},"required":["component","component_id","name","message","direct_access","audio_messages","max_attempts","options","next_component","continue","audio_after_call","conditions","timeout","questions"]},"MaxAttempts":{"type":"object","properties":{"value":{"type":"number","description":"Número máximo de tentativas inválidas na URA"},"redirect":{"type":"string","description":"Destino para onde a ligação será roteada, caso o número máximo de tentativas tenha sido atingido"},"timeout_between_attempts":{"type":"number","description":"Timeout entre as tentativas de digitação da opção da URA"},"audios_on_retry":{"description":"Id dos Áudios que serão reproduzidos em cada tentativa quando o timeout for atingido","type":"array","items":{"type":"string"}},"audios_on_invalid":{"description":"Id dos Áudios que serão reproduzidos em cada tentativa inválida de digitação","type":"array","items":{"type":"string"}}},"required":["value","redirect","timeout_between_attempts","audios_on_retry","audios_on_invalid"]},"Options":{"type":"object","properties":{"num":{"type":"number","description":"Valor da opção da URA"},"description":{"type":"string","description":"Descrição da opção"},"redirect":{"type":"string","description":"Id do Destino para onde a ligação será roteada, caso a opção seja digitada"},"option_fail":{"type":"boolean","description":""}},"required":["num","description","redirect","option_fail"]},"Condition":{"type":"object","properties":{"redirect":{"type":"string","description":"String vazia ou Id do proximo component"},"time_group_id":{"type":"string","description":"Id do time group"}},"required":["redirect","time_group_id"]},"Question":{"type":"object","properties":{"audio_messages":{"description":"Lista de áudios da URA","type":"array","items":{"type":"string"}},"max_attempts":{"description":"Configurações de número máximo de tentativas, redirecionamento em caso de falha, timeout, etc.","type":"array","items":{"$ref":"#/components/schemas/MaxAttempts"}},"valid_notes":{"description":"Lista das notas possiveis","type":"array","items":{"type":"number"}}},"required":["audio_messages","max_attempts","valid_notes"]}}},"paths":{"/pbx/flow/all":{"get":{"operationId":"FlowController_getFlows","summary":"Retorna lista de URAS/fluxos","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseFlowControllerDto"}}}}}},"tags":["URAS/Fluxos"]}}}}
```

## DELETE /pbx/flow/all

> Deleta todas as URAS/fluxos

```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/flow/all":{"delete":{"operationId":"FlowController_deleteAll","summary":"Deleta todas as URAS/fluxos","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["URAS/Fluxos"]}}}}
```


---

# 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/uras-fluxos.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.