Operadoras

Retorna uma operadora

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

get

/pbx/trunk

HTTPcURLJavaScriptPython

GET /pbx/trunk?id=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Voip provider",
  "auth_type": 1,
  "carrier_type": "voip",
  "carrier_rn_code": "55222",
  "username": "9529",
  "protocol": "sip",
  "from_domain": "domain.com.br",
  "dtmf_mode": "rfc4733",
  "codecs": "[\"alaw\",\"ulaw\"]",
  "ip_host": "example.com",
  "call_limit": 30,
  "callerid_type": "fixed",
  "callerid_number": 30303030,
  "initial_did": "8100",
  "final_did": "8199",
  "enabled": 0,
  "port": 5060,
  "endpoints": [
    "192.168.1.1",
    "172.16.30.12"
  ],
  "linked_numbers": [
    {
      "country_code": "55",
      "ddd": "84",
      "number": "30348100-30348199"
    }
  ],
  "status": "Registered",
  "send_registration": true
}

Cadastro de operadora

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome da operadora

Example: Voip provider

auth_typenumberObrigatório

Flag que indica se a operadora é "Com autenticação" (1), ou "Sem autenticação" (0)

Example: 1

carrier_typestringObrigatório

Tipo da operadora

Example: voip

carrier_rn_codestringObrigatório

Código RN (Routing Number) da operadora

Example: 55222

usernamestringObrigatório

Nome de usuário para se autenticar na operadora

Example: 9529

passwordstringObrigatório

Senha para se autenticar na operadora

Example: e32e23e32e23e

protocolstringObrigatório

Protocolo de comunicação com a operadora

Example: sip

from_domainstringObrigatório

Domínio do FQDN quando do Microsoft Teams da empresa

Example: domain.com.br

dtmf_modestringObrigatório

DTMF da operadora

Example: rfc4733

codecsstring[]Obrigatório

Lista de codecs utilizados pela operadora

Example: ["alaw","ulaw"]

ip_hoststringObrigatório

IP/Host da operadora

Example: example.com

call_limitnumberObrigatório

Número principal da operadora

Example: 30

callerid_typestringObrigatório

Tipo da bina da operadora

Example: fixed

callerid_numbernumberObrigatório

Número principal da operadora

Example: 30303030

initial_didstringObrigatório

DDR inicial da operadora

Example: 8100

final_didstringObrigatório

DDR final da operadora

Example: 8199

enablednumberObrigatório

Indica se a operadora está ativada (1) ou não (0) na plataforma do Voice

Example: 0

portnumberObrigatório

Número da porta da operadora

Example: 5060

endpointsstring[]Obrigatório

É 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.

Example: ["127.168.1.1","127.16.30.12"]

send_registrationbooleanObrigatório

Enviar registro para a operadora

Example: true

Respostas

default

application/json

post

/pbx/trunk

HTTPcURLJavaScriptPython

POST /pbx/trunk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 535

{
  "name": "Voip provider",
  "auth_type": 1,
  "carrier_type": "voip",
  "carrier_rn_code": "55222",
  "username": "9529",
  "password": "e32e23e32e23e",
  "protocol": "sip",
  "from_domain": "domain.com.br",
  "dtmf_mode": "rfc4733",
  "codecs": "[\"alaw\",\"ulaw\"]",
  "ip_host": "example.com",
  "call_limit": 30,
  "callerid_type": "fixed",
  "callerid_number": 30303030,
  "initial_did": "8100",
  "final_did": "8199",
  "enabled": 0,
  "port": 5060,
  "endpoints": [
    "127.168.1.1",
    "127.16.30.12"
  ],
  "linked_numbers": [
    {
      "country_code": "55",
      "ddd": "84",
      "number": "30348100-30348199"
    }
  ],
  "send_registration": true
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Voip provider",
  "auth_type": 1,
  "carrier_type": "voip",
  "carrier_rn_code": "55222",
  "username": "9529",
  "protocol": "sip",
  "from_domain": "domain.com.br",
  "dtmf_mode": "rfc4733",
  "codecs": "[\"alaw\",\"ulaw\"]",
  "ip_host": "example.com",
  "call_limit": 30,
  "callerid_type": "fixed",
  "callerid_number": 30303030,
  "initial_did": "8100",
  "final_did": "8199",
  "enabled": 0,
  "port": 5060,
  "endpoints": [
    "192.168.1.1",
    "172.16.30.12"
  ],
  "linked_numbers": [
    {
      "country_code": "55",
      "ddd": "84",
      "number": "30348100-30348199"
    }
  ],
  "status": "Registered",
  "send_registration": true
}

Atualiza uma operadora

put

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome da operadora

Example: Voip provider

auth_typenumberObrigatório

Flag que indica se a operadora é "Com autenticação" (1), ou "Sem autenticação" (0)

Example: 1

carrier_typestringObrigatório

Tipo da operadora

Example: voip

carrier_rn_codestringObrigatório

Código RN (Routing Number) da operadora

Example: 55222

usernamestringObrigatório

Nome de usuário para se autenticar na operadora

Example: 9529

passwordstringObrigatório

Senha para se autenticar na operadora

Example: e32e23e32e23e

protocolstringObrigatório

Protocolo de comunicação com a operadora

Example: sip

from_domainstringObrigatório

Domínio do FQDN quando do Microsoft Teams da empresa

Example: domain.com.br

dtmf_modestringObrigatório

DTMF da operadora

Example: rfc4733

codecsstring[]Obrigatório

Lista de codecs utilizados pela operadora

Example: ["alaw","ulaw"]

ip_hoststringObrigatório

IP/Host da operadora

Example: example.com

call_limitnumberObrigatório

Número principal da operadora

Example: 30

callerid_typestringObrigatório

Tipo da bina da operadora

Example: fixed

callerid_numbernumberObrigatório

Número principal da operadora

Example: 30303030

initial_didstringObrigatório

DDR inicial da operadora

Example: 8100

final_didstringObrigatório

DDR final da operadora

Example: 8199

enablednumberObrigatório

Indica se a operadora está ativada (1) ou não (0) na plataforma do Voice

Example: 0

portnumberObrigatório

Número da porta da operadora

Example: 5060

endpointsstring[]Obrigatório

É 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.

Example: ["127.168.1.1","127.16.30.12"]

send_registrationbooleanObrigatório

Enviar registro para a operadora

Example: true

_idstringObrigatório

ID da operadora/tronco

Example: 63724b92c0ef93903y24dc45

Respostas

default

application/json

put

/pbx/trunk

HTTPcURLJavaScriptPython

PUT /pbx/trunk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 568

{
  "name": "Voip provider",
  "auth_type": 1,
  "carrier_type": "voip",
  "carrier_rn_code": "55222",
  "username": "9529",
  "password": "e32e23e32e23e",
  "protocol": "sip",
  "from_domain": "domain.com.br",
  "dtmf_mode": "rfc4733",
  "codecs": "[\"alaw\",\"ulaw\"]",
  "ip_host": "example.com",
  "call_limit": 30,
  "callerid_type": "fixed",
  "callerid_number": 30303030,
  "initial_did": "8100",
  "final_did": "8199",
  "enabled": 0,
  "port": 5060,
  "endpoints": [
    "127.168.1.1",
    "127.16.30.12"
  ],
  "linked_numbers": [
    {
      "country_code": "55",
      "ddd": "84",
      "number": "30348100-30348199"
    }
  ],
  "send_registration": true,
  "_id": "63724b92c0ef93903y24dc45"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Voip provider",
  "auth_type": 1,
  "carrier_type": "voip",
  "carrier_rn_code": "55222",
  "username": "9529",
  "protocol": "sip",
  "from_domain": "domain.com.br",
  "dtmf_mode": "rfc4733",
  "codecs": "[\"alaw\",\"ulaw\"]",
  "ip_host": "example.com",
  "call_limit": 30,
  "callerid_type": "fixed",
  "callerid_number": 30303030,
  "initial_did": "8100",
  "final_did": "8199",
  "enabled": 0,
  "port": 5060,
  "endpoints": [
    "192.168.1.1",
    "172.16.30.12"
  ],
  "linked_numbers": [
    {
      "country_code": "55",
      "ddd": "84",
      "number": "30348100-30348199"
    }
  ],
  "status": "Registered",
  "send_registration": true
}

Deleta uma operadora

delete

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

delete

/pbx/trunk

HTTPcURLJavaScriptPython

DELETE /pbx/trunk?id=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "count": 1
}

Retorna lista de operadoras

get

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

get

/pbx/trunk/all

HTTPcURLJavaScriptPython

GET /pbx/trunk/all HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

[
  {
    "_id": "63724b92c0ef93903y24dc45",
    "name": "Voip provider",
    "auth_type": 1,
    "carrier_type": "voip",
    "carrier_rn_code": "55222",
    "username": "9529",
    "protocol": "sip",
    "from_domain": "domain.com.br",
    "dtmf_mode": "rfc4733",
    "codecs": "[\"alaw\",\"ulaw\"]",
    "ip_host": "example.com",
    "call_limit": 30,
    "callerid_type": "fixed",
    "callerid_number": 30303030,
    "initial_did": "8100",
    "final_did": "8199",
    "enabled": 0,
    "port": 5060,
    "endpoints": [
      "192.168.1.1",
      "172.16.30.12"
    ],
    "linked_numbers": [
      {
        "country_code": "55",
        "ddd": "84",
        "number": "30348100-30348199"
      }
    ],
    "status": "Registered",
    "send_registration": true
  }
]

Deleta todas as operadoras

delete

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

delete

/pbx/trunk/all

HTTPcURLJavaScriptPython

DELETE /pbx/trunk/all HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "count": 1
}