Contas de Dispositivos VoIP

Esta é uma API para cadastro de contas de dispositivos VoIP.

Esta API é autenticada usando OAuth2, ver documentação de autenticação

Somente usuários com a permissão de VoIPs habilitada podem ter acesso aos dispositivos VoIP. Os usuários sem essa permissão, possuem acesso normal às unidades e aos seus roteadores, porém não possuem acesso ao cadastro de dispositivos VoIP das unidades.

As contas são vinculas aos dispositivos VoIP. Dessa forma, se o usuário não possui acesso aos dispositivos VoIP, também não possuirá acesso às contas

Listagem de contas de dispositivos VoIP

GET /api/v1/cdm/voips/voip_id/accounts

API para listagem de contas de dispositivos VoIP

Exemplo requisição

GET /api/v1/cdm/voips/Az2fDNvAta9pSrr5en8Su/accounts HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "total": 4,
  "accounts": [
    {
      "id": 1,
      "exten_id": "AzHpFafAgjjzA5EREeyJc"
    },
    {
      "id": 2,
      "exten_id": "AzHpFaqzTXHnzhny631ER"
    },
    {
      "id": 3,
      "exten_id": "AzHpFb8VYTQT9gxRnLCXf"
    },
    {
      "id": 4,
      "exten_id": "AzHpFbTs6wxGHvARpsynp"
    }
  ]
}

Buscar uma conta de dispositivo VoIP

GET /api/v1/cdm/voips/voip_id/accounts/id

API para buscar uma conta de dispositivo VoIP

Exemplo requisição

GET /api/v1/cdm/voips/Az2fDNvAta9pSrr5en8Su/accounts/1 HTTP/1.1
Host: cdm.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "exten_id": "AzHpFafAgjjzA5EREeyJc"
}

Atualizar uma conta de dispositivo VoIP

PUT /api/v1/cdm/voips/voip_id/accounts/id

API para atualização de uma conta de dispositivo VoIP

Exemplo requisição

PUT /api/v1/cdm/voips/Az2fDNvAta9pSrr5en8Su/accounts/1 HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "exten_id": "L9apFafAgjjzA5EREeyJc"
}

Exemplo resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "exten_id": "L9apFafAgjjzA5EREeyJc"
}

Formato dos dados

Parâmetros da url

idint Identificador da conta de dispositivo VoIP
voip_idstring Identificador do dispositivo VoIP ao qual a conta pertence

Requisição

As contas são criadas automaticamente quando o dispositivo VoIP é criado. O ramal ao qual a conta é associada é criado (de forma automática) com base no formato padrão de ramais definido pelo cliente

Por exemplo, o ramal pode ser criado como uma concatenação de 4 parâmetros:
* Prefixo do ramal do grupo ao qual o dispositivo VoIP pertence
* Prefixo do ramal da unidade a qual o dispositivo VoIP pertence
* Prefixo do ramal do dispositivo VoIP
* Prefixo incremental gerado automaticamente para cada conta

Após a criação do dispositivo VoIP e da criação automática das contas, é possível realizar a alteração do ramal de uma conta passando um novo exten_id

OBS: O exten_id não pode estar associado a outra de conta de dispositivo VoIP

exten_idstringrequerido único

ID do ramal ao qual a conta de dispositivo VoIP será associada