# Models

## The CreateAgentDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CreateAgentDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"},"use_main_login":{"type":"string","description":"Usar login como e-mail de recuperação"},"email_forgot_password":{"type":"string","description":"E-mail para recuperar senha"}},"required":["name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips","use_main_login","email_forgot_password"]}}}}
```

## The ResponseAgentControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseAgentControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do agente"},"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"}},"required":["_id","name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips"]}}}}
```

## The RemoveCommonResponse object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"RemoveCommonResponse":{"type":"object","properties":{"count":{"type":"number","description":"Quantidade de registros deletados"}},"required":["count"]}}}}
```

## The ResetPasswordAgentDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResetPasswordAgentDto":{"type":"object","properties":{"id":{"type":"string","description":"ID do agente"}},"required":["id"]}}}}
```

## The ResponseResetPasswordControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseResetPasswordControllerDto":{"type":"object","properties":{"message":{"type":"string","description":"Mensagem"}},"required":["message"]}}}}
```

## The PauseManageQueueMemberDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"PauseManageQueueMemberDto":{"type":"object","properties":{"agent_id":{"type":"string","description":"Id do agente"},"pause_id":{"type":"string","description":"Id da pausa"},"metadata":{"type":"object","description":"Objeto de informações extras"}},"required":["agent_id","pause_id","metadata"]}}}}
```

## The ResponseAgentStatisticsController object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseAgentStatisticsController":{"type":"object","properties":{"paused":{"type":"number","description":""},"cumulative_time":{"type":"number","description":""},"_id":{"type":"string","description":""},"active":{"type":"boolean","description":""},"productive":{"type":"boolean","description":""},"cumulative":{"type":"boolean","description":""},"supervisioned":{"type":"boolean","description":""},"typeMessage":{"type":"string","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""},"initialTime":{"type":"string","description":""},"maxTime":{"type":"string","description":""},"message":{"type":"string","description":""},"created_at":{"type":"string","description":""},"updated_at":{"type":"string","description":""},"count_calls_in":{"type":"number","description":""},"count_calls_out":{"type":"number","description":""},"talk_time_average":{"type":"string","description":""},"total_talk_time":{"type":"string","description":""},"metadata":{"type":"object","description":"Objeto de informações extras"}},"required":["paused","cumulative_time","_id","active","productive","cumulative","supervisioned","typeMessage","name","description","initialTime","maxTime","message","created_at","updated_at","count_calls_in","count_calls_out","talk_time_average","total_talk_time","metadata"]}}}}
```

## The UnpauseManageQueueMemberDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"UnpauseManageQueueMemberDto":{"type":"object","properties":{"agent_id":{"type":"string","description":"Id do agente"}},"required":["agent_id"]}}}}
```

## The ApplyTabulationDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ApplyTabulationDto":{"type":"object","properties":{"tabulation_id":{"type":"string","description":"Id da Tabulação"},"agent_id":{"type":"string","description":"Id do agente"},"group_id":{"type":"string","description":"Id do Grupo"},"protocol":{"type":"string","description":"Protocolo"},"contact_id":{"type":"string","description":"Id do Contato"}},"required":["tabulation_id","agent_id","group_id","protocol","contact_id"]}}}}
```

## The CreateTabulationDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CreateTabulationDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da Tabulação"}},"required":["name"]}}}}
```

## The ResponseTabulationControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseTabulationControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da Tabulação"},"name":{"type":"string","description":"Nome da Tabulação"}},"required":["_id","name"]}}}}
```

## The UpdateTabulationDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"UpdateTabulationDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da Tabulação"},"_id":{"type":"string","description":"ID da Tabulação"}},"required":["name","_id"]}}}}
```

## The DeleteTabulationDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"DeleteTabulationDto":{"type":"object","properties":{"ids":{"type":"string","description":"IDs da Tabulação"}},"required":["ids"]}}}}
```

## The ResponseDeleteTabulationControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseDeleteTabulationControllerDto":{"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"]}}}}
```

## The ResponseCallQueueStatusController object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseCallQueueStatusController":{"type":"object","properties":{"in_call":{"description":"","type":"array","items":{"type":"string"}},"calls_waiting_queues":{"description":"","type":"array","items":{"type":"string"}}},"required":["in_call","calls_waiting_queues"]}}}}
```

## The RingGroup object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"RingGroup":{"type":"object","properties":{"agent_id":{"type":"string","description":"ID do agente cadastrado"},"forwarding":{"type":"boolean","description":"Habilitar o encaminhamento"},"priority":{"type":"number","description":"Prioridade"},"order":{"type":"number","description":"Ordem de exibição do agente dentro do grupo de toque"}},"required":["agent_id","forwarding","priority","order"]}}}}
```

## The CreateCampaignDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CreateCampaignDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da equipe"},"extension":{"type":"string","description":"Número da equipe"},"ring_time":{"type":"number","description":"Tempo de toque"},"ring_type":{"type":"string","description":"Tipo de toque"},"allow_internal":{"type":"boolean","description":"Permite ou não chamadas entre agentes"},"dialing_permissions":{"description":"Array dos IDs de rotas de saída","type":"array","items":{"type":"string"}},"capture_permissions":{"description":"Array dos IDs das campanhas","type":"array","items":{"type":"string"}},"ring_group":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/RingGroup"}},"gogenier_integration":{"type":"boolean","description":"Indica se há integração ativa com o sistema GOgenier"},"gogenier_pipeline":{"type":"string","description":"ID de uma pipeline do Gogenier"},"gogenier_ai_id":{"type":"string","description":"Representa o ID da IA cadastrada no Voice referente ao GOgenier"},"max_waiting_time":{"type":"number","description":"Tempo máximo de espera permitido (em segundos) de uma ligação."},"transhipment_by_time":{"type":"string","description":"Indica o ID da equipe para onde a chamada vai ser desviada."},"service_meta":{"type":"number","description":"Meta de serviço"},"answered_within_seconds":{"type":"number","description":"Respondido em segundos"},"abandoned_within_seconds":{"type":"number","description":"Abandonado em segundos"}},"required":["name","extension","ring_time","ring_type","allow_internal","dialing_permissions","capture_permissions","ring_group","gogenier_integration","gogenier_pipeline","gogenier_ai_id","max_waiting_time","transhipment_by_time","service_meta","answered_within_seconds","abandoned_within_seconds"]},"RingGroup":{"type":"object","properties":{"agent_id":{"type":"string","description":"ID do agente cadastrado"},"forwarding":{"type":"boolean","description":"Habilitar o encaminhamento"},"priority":{"type":"number","description":"Prioridade"},"order":{"type":"number","description":"Ordem de exibição do agente dentro do grupo de toque"}},"required":["agent_id","forwarding","priority","order"]}}}}
```

## The ResponseCampaignControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseCampaignControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da rota da equipe"},"name":{"type":"string","description":"Nome da equipe"},"extension":{"type":"string","description":"Número da equipe"},"ring_time":{"type":"number","description":"Tempo de toque"},"ring_type":{"type":"string","description":"Tipo de toque"},"allow_internal":{"type":"boolean","description":"Permite ou não chamadas entre agentes"},"dialing_permissions":{"description":"Array dos IDs de rotas de saída","type":"array","items":{"type":"string"}},"capture_permissions":{"description":"Array dos IDs das campanhas","type":"array","items":{"type":"string"}},"ring_group":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/RingGroup"}},"max_waiting_time":{"type":"number","description":"Tempo máximo de espera permitido (em segundos) de uma ligação."},"transhipment_by_time":{"type":"string","description":"Indica o ID da equipe para onde a chamada vai ser desviada."},"service_meta":{"type":"number","description":"Meta de serviço"},"answered_within_seconds":{"type":"number","description":"Respondido em segundos"},"abandoned_within_seconds":{"type":"number","description":"Abandonado em segundos"}},"required":["_id","name","extension","ring_time","ring_type","allow_internal","dialing_permissions","capture_permissions","ring_group","max_waiting_time","transhipment_by_time","service_meta","answered_within_seconds","abandoned_within_seconds"]},"RingGroup":{"type":"object","properties":{"agent_id":{"type":"string","description":"ID do agente cadastrado"},"forwarding":{"type":"boolean","description":"Habilitar o encaminhamento"},"priority":{"type":"number","description":"Prioridade"},"order":{"type":"number","description":"Ordem de exibição do agente dentro do grupo de toque"}},"required":["agent_id","forwarding","priority","order"]}}}}
```

## The UpdateCampaignDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"UpdateCampaignDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da equipe"},"extension":{"type":"string","description":"Número da equipe"},"ring_time":{"type":"number","description":"Tempo de toque"},"ring_type":{"type":"string","description":"Tipo de toque"},"allow_internal":{"type":"boolean","description":"Permite ou não chamadas entre agentes"},"dialing_permissions":{"description":"Array dos IDs de rotas de saída","type":"array","items":{"type":"string"}},"capture_permissions":{"description":"Array dos IDs das campanhas","type":"array","items":{"type":"string"}},"ring_group":{"description":"Lista de desvios por horário","type":"array","items":{"$ref":"#/components/schemas/RingGroup"}},"gogenier_integration":{"type":"boolean","description":"Indica se há integração ativa com o sistema GOgenier"},"gogenier_pipeline":{"type":"string","description":"ID de uma pipeline do Gogenier"},"gogenier_ai_id":{"type":"string","description":"Representa o ID da IA cadastrada no Voice referente ao GOgenier"},"max_waiting_time":{"type":"number","description":"Tempo máximo de espera permitido (em segundos) de uma ligação."},"transhipment_by_time":{"type":"string","description":"Indica o ID da equipe para onde a chamada vai ser desviada."},"service_meta":{"type":"number","description":"Meta de serviço"},"answered_within_seconds":{"type":"number","description":"Respondido em segundos"},"abandoned_within_seconds":{"type":"number","description":"Abandonado em segundos"},"_id":{"type":"string","description":"ID da rota da equipe"}},"required":["name","extension","ring_time","ring_type","allow_internal","dialing_permissions","capture_permissions","ring_group","gogenier_integration","gogenier_pipeline","gogenier_ai_id","max_waiting_time","transhipment_by_time","service_meta","answered_within_seconds","abandoned_within_seconds","_id"]},"RingGroup":{"type":"object","properties":{"agent_id":{"type":"string","description":"ID do agente cadastrado"},"forwarding":{"type":"boolean","description":"Habilitar o encaminhamento"},"priority":{"type":"number","description":"Prioridade"},"order":{"type":"number","description":"Ordem de exibição do agente dentro do grupo de toque"}},"required":["agent_id","forwarding","priority","order"]}}}}
```

## The LinkedNumber object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"LinkedNumber":{"type":"object","properties":{"country_code":{"type":"string"},"ddd":{"type":"string"},"number":{"type":"string"}},"required":["country_code","ddd","number"]}}}}
```

## The CreateTrunkDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CreateTrunkDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da operadora"},"auth_type":{"type":"number","description":"Flag que indica se a operadora é \"Com autenticação\" (1), ou \"Sem autenticação\" (0)"},"carrier_type":{"type":"string","description":"Tipo da operadora"},"carrier_rn_code":{"type":"string","description":"Código RN (Routing Number) da operadora"},"username":{"type":"string","description":"Nome de usuário para se autenticar na operadora"},"password":{"type":"string","description":"Senha para se autenticar na operadora"},"protocol":{"type":"string","description":"Protocolo de comunicação com a operadora"},"from_domain":{"type":"string","description":"Domínio do FQDN quando do Microsoft Teams da empresa"},"dtmf_mode":{"type":"string","description":"DTMF da operadora"},"codecs":{"description":"Lista de codecs utilizados pela operadora","type":"array","items":{"type":"string"}},"ip_host":{"type":"string","description":"IP/Host da operadora"},"call_limit":{"type":"number","description":"Número principal da operadora"},"callerid_type":{"type":"string","description":"Tipo da bina da operadora"},"callerid_number":{"type":"number","description":"Número principal da operadora"},"initial_did":{"type":"string","description":"DDR inicial da operadora"},"final_did":{"type":"string","description":"DDR final da operadora"},"enabled":{"type":"number","description":"Indica se a operadora está ativada (1) ou não (0) na plataforma do Voice"},"port":{"type":"number","description":"Número da porta da operadora"},"endpoints":{"description":"É a lista de servidores SIP ao qual o Voice irá esperar os INVITES em uma chamada entrante. Este campo é usado em apenas operadoras que não possuem autenticação.","type":"array","items":{"type":"string"}},"linked_numbers":{"type":"array","items":{"$ref":"#/components/schemas/LinkedNumber"}},"send_registration":{"type":"boolean","description":"Enviar registro para a operadora"}},"required":["name","auth_type","carrier_type","carrier_rn_code","username","password","protocol","from_domain","dtmf_mode","codecs","ip_host","call_limit","callerid_type","callerid_number","initial_did","final_did","enabled","port","endpoints","linked_numbers","send_registration"]},"LinkedNumber":{"type":"object","properties":{"country_code":{"type":"string"},"ddd":{"type":"string"},"number":{"type":"string"}},"required":["country_code","ddd","number"]}}}}
```

## The ResponseTrunkControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseTrunkControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"Id da operadora"},"name":{"type":"string","description":"Nome da operadora"},"auth_type":{"type":"number","description":"Flag que indica se a operadora é \"Com autenticação\" (1), ou \"Sem autenticação\" (0)"},"carrier_type":{"type":"string","description":"Tipo da operadora"},"carrier_rn_code":{"type":"string","description":"Código RN (Routing Number) da operadora"},"username":{"type":"string","description":"Nome de usuário para se autenticar na operadora"},"protocol":{"type":"string","description":"Protocolo de comunicação com a operadora"},"from_domain":{"type":"string","description":"Domínio do FQDN quando do Microsoft Teams da empresa"},"dtmf_mode":{"type":"string","description":"DTMF da operadora"},"codecs":{"description":"Lista de codecs utilizados pela operadora","type":"array","items":{"type":"string"}},"ip_host":{"type":"string","description":"IP/Host da operadora/tronco"},"call_limit":{"type":"number","description":"Número principal da operadora/tronco"},"callerid_type":{"type":"string","description":"Tipo da bina da operadora/tronco"},"callerid_number":{"type":"number","description":"Número principal da operadora/tronco"},"initial_did":{"type":"string","description":"DDR inicial da operadora/tronco"},"final_did":{"type":"string","description":"DDR final da operadora/tronco"},"enabled":{"type":"number","description":"Indica se a operadora/tronco está ativada (1) ou não (0) na plataforma do Voice"},"port":{"type":"number","description":"Número da porta da operadora"},"endpoints":{"description":"É a lista de servidores SIP ao qual o Voice irá esperar os INVITES em uma chamada entrante. Este campo é usado em apenas operadoras que não possuem autenticação.","type":"array","items":{"type":"string"}},"linked_numbers":{"type":"array","items":{"$ref":"#/components/schemas/LinkedNumber"}},"status":{"description":"Status do registro com a operadora, valores possiveis: Registered, Unregistered, Rejected e Erro","type":"array","items":{"type":"string"}},"send_registration":{"type":"boolean","description":"Enviar registro para a operadora"}},"required":["_id","name","auth_type","carrier_type","carrier_rn_code","username","protocol","from_domain","dtmf_mode","codecs","ip_host","call_limit","callerid_type","callerid_number","initial_did","final_did","enabled","port","endpoints","linked_numbers","status","send_registration"]},"LinkedNumber":{"type":"object","properties":{"country_code":{"type":"string"},"ddd":{"type":"string"},"number":{"type":"string"}},"required":["country_code","ddd","number"]}}}}
```

## The GetTrunkControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"GetTrunkControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"Id da operadora"},"name":{"type":"string","description":"Nome da operadora"},"auth_type":{"type":"number","description":"Flag que indica se a operadora é \"Com autenticação\" (1), ou \"Sem autenticação\" (0)"},"carrier_type":{"type":"string","description":"Tipo da operadora"},"carrier_rn_code":{"type":"string","description":"Código RN (Routing Number) da operadora"},"username":{"type":"string","description":"Nome de usuário para se autenticar na operadora"},"protocol":{"type":"string","description":"Protocolo de comunicação com a operadora"},"from_domain":{"type":"string","description":"Domínio do FQDN quando do Microsoft Teams da empresa"},"dtmf_mode":{"type":"string","description":"DTMF da operadora"},"codecs":{"description":"Lista de codecs utilizados pela operadora","type":"array","items":{"type":"string"}},"ip_host":{"type":"string","description":"IP/Host da operadora/tronco"},"call_limit":{"type":"number","description":"Número principal da operadora/tronco"},"callerid_type":{"type":"string","description":"Tipo da bina da operadora/tronco"},"callerid_number":{"type":"number","description":"Número principal da operadora/tronco"},"initial_did":{"type":"string","description":"DDR inicial da operadora/tronco"},"final_did":{"type":"string","description":"DDR final da operadora/tronco"},"enabled":{"type":"number","description":"Indica se a operadora/tronco está ativada (1) ou não (0) na plataforma do Voice"},"port":{"type":"number","description":"Número da porta da operadora"},"endpoints":{"description":"É a lista de servidores SIP ao qual o Voice irá esperar os INVITES em uma chamada entrante. Este campo é usado em apenas operadoras que não possuem autenticação.","type":"array","items":{"type":"string"}},"linked_numbers":{"type":"array","items":{"$ref":"#/components/schemas/LinkedNumber"}},"status":{"description":"Status do registro com a operadora, valores possiveis: Registered, Unregistered, Rejected e Erro","type":"array","items":{"type":"string"}},"send_registration":{"type":"boolean","description":"Enviar registro para a operadora"}},"required":["_id","name","auth_type","carrier_type","carrier_rn_code","username","protocol","from_domain","dtmf_mode","codecs","ip_host","call_limit","callerid_type","callerid_number","initial_did","final_did","enabled","port","endpoints","linked_numbers","status","send_registration"]},"LinkedNumber":{"type":"object","properties":{"country_code":{"type":"string"},"ddd":{"type":"string"},"number":{"type":"string"}},"required":["country_code","ddd","number"]}}}}
```

## The UpdateTrunkDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"UpdateTrunkDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da operadora"},"auth_type":{"type":"number","description":"Flag que indica se a operadora é \"Com autenticação\" (1), ou \"Sem autenticação\" (0)"},"carrier_type":{"type":"string","description":"Tipo da operadora"},"carrier_rn_code":{"type":"string","description":"Código RN (Routing Number) da operadora"},"username":{"type":"string","description":"Nome de usuário para se autenticar na operadora"},"password":{"type":"string","description":"Senha para se autenticar na operadora"},"protocol":{"type":"string","description":"Protocolo de comunicação com a operadora"},"from_domain":{"type":"string","description":"Domínio do FQDN quando do Microsoft Teams da empresa"},"dtmf_mode":{"type":"string","description":"DTMF da operadora"},"codecs":{"description":"Lista de codecs utilizados pela operadora","type":"array","items":{"type":"string"}},"ip_host":{"type":"string","description":"IP/Host da operadora"},"call_limit":{"type":"number","description":"Número principal da operadora"},"callerid_type":{"type":"string","description":"Tipo da bina da operadora"},"callerid_number":{"type":"number","description":"Número principal da operadora"},"initial_did":{"type":"string","description":"DDR inicial da operadora"},"final_did":{"type":"string","description":"DDR final da operadora"},"enabled":{"type":"number","description":"Indica se a operadora está ativada (1) ou não (0) na plataforma do Voice"},"port":{"type":"number","description":"Número da porta da operadora"},"endpoints":{"description":"É a lista de servidores SIP ao qual o Voice irá esperar os INVITES em uma chamada entrante. Este campo é usado em apenas operadoras que não possuem autenticação.","type":"array","items":{"type":"string"}},"linked_numbers":{"type":"array","items":{"$ref":"#/components/schemas/LinkedNumber"}},"send_registration":{"type":"boolean","description":"Enviar registro para a operadora"},"_id":{"type":"string","description":"ID da operadora/tronco"}},"required":["name","auth_type","carrier_type","carrier_rn_code","username","password","protocol","from_domain","dtmf_mode","codecs","ip_host","call_limit","callerid_type","callerid_number","initial_did","final_did","enabled","port","endpoints","linked_numbers","send_registration","_id"]},"LinkedNumber":{"type":"object","properties":{"country_code":{"type":"string"},"ddd":{"type":"string"},"number":{"type":"string"}},"required":["country_code","ddd","number"]}}}}
```

## The CallToConfControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CallToConfControllerDto":{"type":"object","properties":{"src":{"type":"string","description":"Número do ramal do agente"},"dst":{"type":"string","description":"Número do contato"},"ringTime":{"type":"number","description":"Quantidade máxima de tempo em que a chamada ficará tocando até ser atendida"},"whatsapp":{"type":"boolean","description":"Indica se a chamada é para um número de WhatsApp"}},"required":["src","dst","ringTime","whatsapp"]}}}}
```

## The ResponseCallToConfControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseCallToConfControllerDto":{"type":"object","properties":{"response":{"type":"string","description":"Resposta"},"message":{"type":"string","description":"Mensagem"},"detail":{"type":"string","description":"Detalhes"}},"required":["response","message","detail"]}}}}
```

## The MaxAttempts object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The Options object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The Condition object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The Question object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]},"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"]}}}}
```

## The Flow object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The CreateFlowDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The ResponseFlowControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The UpdateFlowDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The CreatePlaylistDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CreatePlaylistDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"}},"required":["name","sort"]}}}}
```

## The ResponsePlaylistControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponsePlaylistControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da playlist"},"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"}},"required":["_id","name","sort"]}}}}
```

## The UpdatePlaylistDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"UpdatePlaylistDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"},"_id":{"type":"string","description":"ID da operadora/tronco"}},"required":["name","sort","_id"]}}}}
```

## The ResponseAudioControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseAudioControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da rota da equipe"},"name":{"type":"string","description":"Nome do áudio"},"extension":{"type":"string","description":"Extensão do arquivo de áudio (WAV ou mp3)"},"size":{"type":"string","description":"Tamanho do arquivo de áudio"},"playlist_id":{"type":"string","description":"ID da playlist "}},"required":["_id","name","extension","size","playlist_id"]}}}}
```

## The routeByTime object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The CreateIncallDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The ResponseIncallControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The UpdateIncallDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The UpdatePositionRouteDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The ResponseUpdatePositionRouteBackendDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseUpdatePositionRouteBackendDto":{"type":"object","properties":{"sucess":{"type":"string","description":""}},"required":["sucess"]}}}}
```

## The DstIdentity object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The CreateInternalRouteDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The ResponseInternalRouteControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The UpdateInternalRouteDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The Transhipment object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The CreateOutcallDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The ResponseOutcallControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The UpdateOutcallDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The ResponseGlobalControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseGlobalControllerDto":{"type":"object","properties":{"country_code":{"type":"string","description":"Código do país usado como prefixo do número no envio do link da gravação"},"ddd":{"type":"string","description":"Código do DDD padrão do tenant"},"sz4_send_recording_via_whatsapp":{"type":"boolean","description":"Flag que ativa/desativa o envio do link da gravação por Whatsapp"}},"required":["country_code","ddd","sz4_send_recording_via_whatsapp"]}}}}
```

## The UpdateGlobalDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"UpdateGlobalDto":{"type":"object","properties":{"country_code":{"type":"string","description":"Código do país usado como prefixo do número no envio do link da gravação"},"ddd":{"type":"string","description":"Código do DDD padrão do tenant"},"sz4_send_recording_via_whatsapp":{"type":"boolean","description":"Flag que ativa/desativa o envio do link da gravação por Whatsapp"}},"required":["country_code","ddd","sz4_send_recording_via_whatsapp"]}}}}
```

## The ResponseReportsControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseReportsControllerDto":{"type":"object","properties":{"Datetime":{"type":"string","description":"ID do agente"},"Protocol":{"type":"string","description":"Nome do agente"},"CallerID":{"type":"string","description":"Número do ramal do agente"},"Source":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"Destination":{"type":"string","description":"Horário inicial de login do agente"},"Duration":{"type":"string","description":"Horário final de login do agente"},"BillableSeconds":{"type":"string","description":"ID da equipe do agente"},"Disposition":{"type":"string","description":"Tecnologia do ramal do agente"},"ContactName":{"type":"string","description":"Nome do contato"},"ContactPhoto":{"type":"string","description":"Foto do contato"}},"required":["Datetime","Protocol","CallerID","Source","Destination","Duration","BillableSeconds","Disposition","ContactName","ContactPhoto"]}}}}
```

## The ResponseTimelineControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseTimelineControllerDto":{"type":"object","properties":{"X_StartEventTimestamp":{"type":"string"},"Protocol":{"type":"string"},"X_FinalStatus":{"type":"string"},"X_DestinationNumber":{"type":"string"},"X_CallType":{"type":"string"},"X_SourceNumber":{"type":"string"}},"required":["X_StartEventTimestamp","Protocol","X_FinalStatus","X_DestinationNumber","X_CallType","X_SourceNumber"]}}}}
```

## The Meta object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"Meta":{"type":"object","properties":{"totalItems":{"type":"number","description":"Total de itens"},"itemCount":{"type":"number","description":"Quantidade de itens"},"itemsPerPage":{"type":"number","description":"Quantidade de itens por páginas"},"totalPages":{"type":"number","description":"Total de páginas"},"currentPage":{"type":"number","description":"Página atual"}},"required":["totalItems","itemCount","itemsPerPage","totalPages","currentPage"]}}}}
```

## The ResponseReportsTimelineControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseReportsTimelineControllerDto":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ResponseTimelineControllerDto"}},"meta":{"description":"Propriedades da paginação","allOf":[{"$ref":"#/components/schemas/Meta"}]}},"required":["items","meta"]},"ResponseTimelineControllerDto":{"type":"object","properties":{"X_StartEventTimestamp":{"type":"string"},"Protocol":{"type":"string"},"X_FinalStatus":{"type":"string"},"X_DestinationNumber":{"type":"string"},"X_CallType":{"type":"string"},"X_SourceNumber":{"type":"string"}},"required":["X_StartEventTimestamp","Protocol","X_FinalStatus","X_DestinationNumber","X_CallType","X_SourceNumber"]},"Meta":{"type":"object","properties":{"totalItems":{"type":"number","description":"Total de itens"},"itemCount":{"type":"number","description":"Quantidade de itens"},"itemsPerPage":{"type":"number","description":"Quantidade de itens por páginas"},"totalPages":{"type":"number","description":"Total de páginas"},"currentPage":{"type":"number","description":"Página atual"}},"required":["totalItems","itemCount","itemsPerPage","totalPages","currentPage"]}}}}
```

## The ResponseTimelineDetailedControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseTimelineDetailedControllerDto":{"type":"object","properties":{"X_SourceName":{"type":"string"},"X_SourceNumber":{"type":"string"},"X_SourceId":{"type":"string"},"X_DestinationName":{"type":"string"},"X_DestinationNumber":{"type":"string"},"X_DestinationId":{"type":"string"},"X_DestinationType":{"type":"string"},"X_StartEventTimestamp":{"type":"string"},"X_CallType":{"type":"string"},"X_TrunkInName":{"type":"string"},"X_TrunkInId":{"type":"string"},"X_TrunkOutName":{"type":"string"},"X_TrunkOutId":{"type":"string"},"X_FinalStatus":{"type":"string"},"X_RecordingFile":{"type":"string"},"X_RecordingStream":{"type":"string"},"X_ContactName":{"type":"string"},"X_ContactPhoto":{"type":"string"},"X_GroupSourceIds":{"type":"string"},"X_Status":{"type":"string"},"Protocol":{"type":"string"},"Duration":{"type":"string"},"BillableSeconds":{"type":"string"}},"required":["X_SourceName","X_SourceNumber","X_SourceId","X_DestinationName","X_DestinationNumber","X_DestinationId","X_DestinationType","X_StartEventTimestamp","X_CallType","X_TrunkInName","X_TrunkInId","X_TrunkOutName","X_TrunkOutId","X_FinalStatus","X_RecordingFile","X_RecordingStream","X_ContactName","X_ContactPhoto","X_GroupSourceIds","X_Status","Protocol","Duration","BillableSeconds"]}}}}
```

## The CreateWebhookDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CreateWebhookDto":{"type":"object","properties":{"url":{"type":"string","description":"URL que vai ser acionada neste webhook"},"token":{"type":"string","description":"Token que será enviado no cabeçalho X-Voice-token caso o cliente queira autenticar as requisições"},"events":{"description":"Lista de eventos que serão enviados","type":"array","items":{"type":"string"}},"verify_ssl":{"type":"boolean","description":"Realiza (true) ou não (false) a verificação SSL"}},"required":["url","token","events","verify_ssl"]}}}}
```

## The ResponseWebhookControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseWebhookControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do webhook"},"url":{"type":"string","description":"URL que vai ser acionada neste webhook"},"token":{"type":"string","description":"Token que será enviado no cabeçalho X-Voice-token caso o cliente queira autenticar as requisições"},"events":{"description":"Lista de eventos que serão enviados","type":"array","items":{"type":"string"}},"verify_ssl":{"type":"boolean","description":"Realiza (true) ou não (false) a verificação SSL"}},"required":["_id","url","token","events","verify_ssl"]}}}}
```

## The ResponseWebhookPaginatedControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseWebhookPaginatedControllerDto":{"type":"object","properties":{"items":{"description":"Lista de Webhooks","type":"array","items":{"$ref":"#/components/schemas/ResponseWebhookControllerDto"}},"meta":{"description":"Propriedades da paginação","allOf":[{"$ref":"#/components/schemas/Meta"}]}},"required":["items","meta"]},"ResponseWebhookControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do webhook"},"url":{"type":"string","description":"URL que vai ser acionada neste webhook"},"token":{"type":"string","description":"Token que será enviado no cabeçalho X-Voice-token caso o cliente queira autenticar as requisições"},"events":{"description":"Lista de eventos que serão enviados","type":"array","items":{"type":"string"}},"verify_ssl":{"type":"boolean","description":"Realiza (true) ou não (false) a verificação SSL"}},"required":["_id","url","token","events","verify_ssl"]},"Meta":{"type":"object","properties":{"totalItems":{"type":"number","description":"Total de itens"},"itemCount":{"type":"number","description":"Quantidade de itens"},"itemsPerPage":{"type":"number","description":"Quantidade de itens por páginas"},"totalPages":{"type":"number","description":"Total de páginas"},"currentPage":{"type":"number","description":"Página atual"}},"required":["totalItems","itemCount","itemsPerPage","totalPages","currentPage"]}}}}
```

## The ValidateHour object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ValidateHour":{"type":"object","properties":{"initial":{"type":"string","description":"Hora inicial"},"final":{"type":"string","description":"Hora final"}},"required":["initial","final"]}}}}
```

## The ResponseRouteSimulatorControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseRouteSimulatorControllerDto":{"type":"object","properties":{"color":{"type":"string","description":"Cor para o frontend"},"type":{"type":"string","description":"Tipo de rota se é entrada, interna ou saida"},"origin":{"type":"string","description":"Origem"},"destiny":{"type":"string","description":"Destino"},"dialing_permission":{"type":"string","description":"Permisao de discagem"},"validate_hour":{"description":"Hora valida","type":"array","items":{"$ref":"#/components/schemas/ValidateHour"}},"validate_day":{"description":"Dias validos","type":"array","items":{"type":"string"}},"permission_id":{"type":"string","description":"ID da permissão"},"time_group_name":{"type":"string","description":"Nome do grupo de horario"}},"required":["color","type","origin","destiny","dialing_permission","validate_hour","validate_day","permission_id","time_group_name"]},"ValidateHour":{"type":"object","properties":{"initial":{"type":"string","description":"Hora inicial"},"final":{"type":"string","description":"Hora final"}},"required":["initial","final"]}}}}
```

## The CloneItemDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CloneItemDto":{"type":"object","properties":{"id":{"type":"string","description":"Id do item para ser clonado"},"type":{"type":"string","description":"O tipo do item que deseja clonar"}},"required":["id","type"]}}}}
```

## The ResponseCallHistoryByContact object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseCallHistoryByContact":{"type":"object","properties":{"codename":{"type":"string","description":"Codinome ou identificador único usado para referenciar o agente de forma anônima dentro do sistema."},"date_time":{"type":"string","description":"Data e hora"},"contact_id":{"type":"string","description":"ID do contato"},"contact_name":{"type":"string","description":"Nome do contato"},"contact_number":{"type":"string","description":"Número do contato"},"contact_photo":{"type":"string","description":"Foto do contato"},"agent_name":{"type":"string","description":"Nome do agente"},"agent_photo":{"type":"string","description":"Foto do agente"},"disposition":{"type":"string","description":"Disposição da chamada (atendida, ocupada, não atendida)"},"call_type":{"type":"string","description":"Fluxo da chamada (Entrada, saída)"},"recording_file":{"type":"string","description":"Arquivo de gravação"},"recording_path":{"type":"string","description":"Caminho da gravação"},"recording_stream":{"type":"string","description":"Link para ouvir a gravação"},"transfer_type":{"type":"string","description":"Tipo de transferência, se houver, se não, o campo fica vazio"},"transfer_source":{"type":"string","description":"Número que transferiu"},"source":{"type":"string","description":"Origem da chamada"},"destination":{"type":"string","description":"Destino da chamada"}},"required":["codename","date_time","contact_id","contact_name","contact_number","contact_photo","agent_name","agent_photo","disposition","call_type","recording_file","recording_path","recording_stream","transfer_type","transfer_source","source","destination"]}}}}
```

## The CreatePauseDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"CreatePauseDto":{"type":"object","properties":{"active":{"type":"boolean","description":"Indica se a pausa está ativa ou não"},"productive":{"type":"boolean","description":"Indica se a pausa é produtiva ou não"},"cumulative":{"type":"boolean","description":"Indica se a pausa é do tipo acumulativa ou não"},"supervisioned":{"type":"boolean","description":"Indica se a pausa é supervisionada ou não"},"name":{"type":"string","description":"Nome da pausa"},"description":{"type":"string","description":"Descrição da pausa"},"initialTime":{"type":"string","description":"Indica a partir de qual horário a pausa poderá ser usada"},"maxTime":{"type":"string","description":"Indica a quantidade máxima de tempo em segundos que esta pausa será usada"},"icon":{"type":"string","description":"Nome do ícone"}},"required":["active","productive","cumulative","supervisioned","name","description","initialTime","maxTime","icon"]}}}}
```

## The ResponsePauseControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponsePauseControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da playlist"},"active":{"type":"boolean","description":"Indica se a pausa está ativa ou não"},"productive":{"type":"boolean","description":"Indica se a pausa é produtiva ou não"},"cumulative":{"type":"boolean","description":"Indica se a pausa é do tipo acumulativa ou não"},"supervisioned":{"type":"boolean","description":"Indica se a pausa é supervisionada ou não"},"name":{"type":"string","description":"Nome da pausa"},"description":{"type":"string","description":"Descrição da pausa"},"initialTime":{"type":"string","description":"Indica a partir de qual horário a pausa poderá ser usada"},"maxTime":{"type":"string","description":"Indica a quantidade máxima de tempo em segundos que esta pausa será usada"},"icon":{"type":"string","description":"Nome do ícone"}},"required":["_id","active","productive","cumulative","supervisioned","name","description","initialTime","maxTime","icon"]}}}}
```

## The UpdatePauseDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"UpdatePauseDto":{"type":"object","properties":{"active":{"type":"boolean","description":"Indica se a pausa está ativa ou não"},"productive":{"type":"boolean","description":"Indica se a pausa é produtiva ou não"},"cumulative":{"type":"boolean","description":"Indica se a pausa é do tipo acumulativa ou não"},"supervisioned":{"type":"boolean","description":"Indica se a pausa é supervisionada ou não"},"name":{"type":"string","description":"Nome da pausa"},"description":{"type":"string","description":"Descrição da pausa"},"initialTime":{"type":"string","description":"Indica a partir de qual horário a pausa poderá ser usada"},"maxTime":{"type":"string","description":"Indica a quantidade máxima de tempo em segundos que esta pausa será usada"},"icon":{"type":"string","description":"Nome do ícone"},"_id":{"type":"string","description":"ID da operadora/tronco"}},"required":["active","productive","cumulative","supervisioned","name","description","initialTime","maxTime","icon","_id"]}}}}
```

## The DeletePausesByIdDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"DeletePausesByIdDto":{"type":"object","properties":{"ids":{"description":"Id das pausas a serem removidas","type":"array","items":{"type":"string"}}},"required":["ids"]}}}}
```

## The ResponseLicenseControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseLicenseControllerDto":{"type":"object","properties":{"license_id":{"type":"string","description":"Id da Licença"},"license_status":{"type":"string","description":"Status da Licença"},"license_updated_at":{"type":"boolean","description":"Data de atualização da Licença"},"days_for_wait_before_deleted_resources":{"type":"boolean","description":"Quantidade de dias para esperar antes de deletar todos os recursos do cliente depois que a Licença estiver em canceled"},"poc_expiration_date":{"type":"boolean","description":"Data de expiração da Licença"}},"required":["license_id","license_status","license_updated_at","days_for_wait_before_deleted_resources","poc_expiration_date"]}}}}
```

## The ResponseStorageControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseStorageControllerDto":{"type":"object","properties":{"use_in_mb":{"type":"number","description":"Tamanho do bucket do cliente no GCP"},"quota_in_mb":{"type":"number","description":"Valor do campo storage. total_gb (em mb)"},"exceeded":{"type":"boolean","description":"Excedido"}},"required":["use_in_mb","quota_in_mb","exceeded"]}}}}
```

## The ConditionsDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The CreateForwardDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The ResponseForwardControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The UpdateForwardDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"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"]}}}}
```

## The DeleteForwardDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"DeleteForwardDto":{"type":"object","properties":{"ids":{"type":"string","description":"IDs dos desvios"}},"required":["ids"]}}}}
```

## The ResponseDeleteForwardControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"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"]}}}}
```

## The ResponseVersionControllerDto object

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"components":{"schemas":{"ResponseVersionControllerDto":{"type":"object","properties":{"version":{"type":"string","description":"Versão atual do sistema"}},"required":["version"]}}}}
```


---

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