Ramais

Esta é uma API para cadastro de ramais.

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

Listagem de ramais

GET /api/v1/cdm/extens

API para listagem de ramais

Exemplo requisição

GET /api/v1/cdm/extens 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

{
  "cursor": {
    "previous": "",
    "current": "0",
    "next": "",
    "count": 2
  },
  "extens": [
    {
      "id": "AzHpFafAgjjzA5EREeyJc",
      "number": "123999101",
      "name": "Ramal01",
      "server_id": "AxUBbTFhJA6cPZH56YQMG",
      "billing_group_id": "Az2yHHgVNpCYaEoFMSvxu",
      "type": "sip",
      "password": "zFwa9Z"
    },
    {
      "id": "AzHpFaqzTXHnzhny631ER",
      "number": "123999102",
      "name": "Ramal03",
      "server_id": "AxUBbTFhJA6cPZH56YQMG",
      "billing_group_id": "Az2yHHgVNpCYaEoFMSvxu",
      "type": "sip",
      "password": "bRrJDQy"
    }
  ]
}

Buscar um ramal

GET /api/v1/cdm/extens/id

API para buscar um ramal

Exemplo requisição

GET /api/v1/cdm/extens/Az2g33hnCce1mLEcPRhEF 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": "Az2g33hnCce1mLEcPRhEF",
  "number": "123999102",
  "name": "Ramal03",
  "server_id": "AxUBbTFhJA6cPZH56YQMG",
  "billing_group_id": "Az2yHHgVNpCYaEoFMSvxu",
  "type": "sip",
  "password": "bRrJDQy"
}

Criar um ramal

POST /api/v1/cdm/extens

API para criação de um ramal

Exemplo requisição

POST /api/v1/cdm/extens HTTP/1.1
Host: cdm.exemplo.com
Content-Type: application/json
Accept: application/json
Authorization: Bearer <Access-Token>

{
  "number": "123919394",
  "name": "Ramal09",
  "server_id": "AxUBbTFhJA6cPZH56YQMG",
  "billing_group_id": "Az2yHHgVNpCYaEoFMSvxu",
  "type": "sip",
  "password": "bRrJDQy"
}

Exemplo resposta

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

{
  "id": "Az2g33hnCce1mLEcPRhEF",
  "number": "123919394",
  "name": "Ramal09",
  "server_id": "AxUBbTFhJA6cPZH56YQMG",
  "billing_group_id": "Az2yHHgVNpCYaEoFMSvxu",
  "type": "sip",
  "password": "bRrJDQy"
}

Atualizar um ramal

PUT /api/v1/cdm/extens/id

API para atualização de um ramal

Exemplo requisição

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

{
  "name": "Ramal01"
}

Exemplo resposta

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

{
  "id": "Az2g33hnCce1mLEcPRhEF",
  "number": "123919394",
  "name": "Ramal01",
  "server_id": "AxUBbTFhJA6cPZH56YQMG",
  "billing_group_id": "Az2yHHgVNpCYaEoFMSvxu",
  "type": "sip",
  "password": "bRrJDQy"
}

Apagar um ramal

DELETE /api/v1/cdm/extens/id

API de remoção de um ramal

Exemplo requisição

DELETE /api/v1/cdm/extens/Az2g33hnCce1mLEcPRhEF 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

Formato dos dados

Parâmetros da url

idstring Identificador do ramal

Requisição

namestringrequerido único Nome do ramal
numberstringrequerido único Número do ramal
typestringrequerido Tipo do ramal Tipo possível: sip
billing_group_idstringrequerido ID do centro de custo ao qual o ramal irá pertencer
server_idstringrequerido ID do servidor que o ramal irá utilizar
passwordstringrequerido Senha do ramal

Resposta

idstring Identificador do ramal
namestring Nome do ramal
numberstring Número do ramal
typestring Tipo do ramal
billing_group_idstring ID do centro de custo ao qual o ramal pertence
server_idstring ID do servidor que o ramal utiliza
passwordstring Senha do ramal