# Equipes

## GET /pbx/campaigns

> Retorna uma equipe

```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":{"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"]}}},"paths":{"/pbx/campaigns":{"get":{"operationId":"CampaignsController_getCampaign","summary":"Retorna uma equipe","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCampaignControllerDto"}}}}},"tags":["Equipes"]}}}}
```

## POST /pbx/campaigns

> Cadastro de equipe

```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":{"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"]},"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"]}}},"paths":{"/pbx/campaigns":{"post":{"operationId":"CampaignsController_createCampaign","summary":"Cadastro de equipe","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCampaignControllerDto"}}}}},"tags":["Equipes"]}}}}
```

## PUT /pbx/campaigns

> Atualiza uma equipe

```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":{"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"]},"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"]}}},"paths":{"/pbx/campaigns":{"put":{"operationId":"CampaignsController_updateCampaign","summary":"Atualiza uma equipe","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseCampaignControllerDto"}}}}},"tags":["Equipes"]}}}}
```

## DELETE /pbx/campaigns

> Deleta uma equipe

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

## GET /pbx/campaigns/all

> Retorna lista de equipes

```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":{"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"]}}},"paths":{"/pbx/campaigns/all":{"get":{"operationId":"CampaignsController_getCampaigns","summary":"Retorna lista de equipes","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseCampaignControllerDto"}}}}}},"tags":["Equipes"]}}}}
```

## DELETE /pbx/campaigns/all

> Deleta todas as equipes

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


---

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