# Operadoras

## GET /pbx/trunk

> Retorna uma operadora

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

## POST /pbx/trunk

> Cadastro de operadora

```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":{"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"]},"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"]}}},"paths":{"/pbx/trunk":{"post":{"operationId":"TrunksController_createTrunk","summary":"Cadastro de operadora","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTrunkDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseTrunkControllerDto"}}}}},"tags":["Operadoras"]}}}}
```

## PUT /pbx/trunk

> Atualiza uma operadora

```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":{"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"]},"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"]}}},"paths":{"/pbx/trunk":{"put":{"operationId":"TrunksController_updateTrunk","summary":"Atualiza uma operadora","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTrunkDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseTrunkControllerDto"}}}}},"tags":["Operadoras"]}}}}
```

## DELETE /pbx/trunk

> Deleta uma operadora

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

## GET /pbx/trunk/all

> Retorna lista de operadoras

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

## DELETE /pbx/trunk/all

> Deleta todas as operadoras

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


---

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