Permissões de discagem de saída

Retorna uma permissão de saída

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

get

/pbx/outcalls

HTTPcURLJavaScriptPython

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

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Fixo local",
  "number_format": "[2-5]XXXXXXX",
  "enabled": 1,
  "time_group_id": "63f26d83f7dedc1249a039b7",
  "source": "456954",
  "transhipments": [
    {
      "type": "main",
      "trunk_id": "F63d7d91f6648050011dc5d7e",
      "del_initial_digits": 0,
      "add_digits_before": "01585",
      "add_digits_after": "1555",
      "call_id": "55456954",
      "removal_starting_position": "1",
      "number_of_digits_to_remove": "1"
    }
  ],
  "icon": "phone"
}

Cadastro de permissão de saída

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome da permissão de saída

Example: Fixo local

number_formatstringObrigatório

Expressão que representa o número de saída desta permissão de saída

Example: [2-5]XXXXXXX

enablednumberObrigatório

Flag que indica se a rota está ativa (1) ou não (0)

Example: 1

time_group_idstringObrigatório

ID de um grupo de horários (campo id da collection time_groups)

Example: 63f26d83f7dedc1249a039b7

sourcestringObrigatório

Identifica a origem do número na rota de saída.

Example: 456954

iconstringObrigatório

Ícone que vai ser exibido na tela de permissões de saída.

Example: phone

Respostas

default

application/json

post

/pbx/outcalls

HTTPcURLJavaScriptPython

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

{
  "name": "Fixo local",
  "number_format": "[2-5]XXXXXXX",
  "enabled": 1,
  "time_group_id": "63f26d83f7dedc1249a039b7",
  "source": "456954",
  "transhipments": [
    {
      "type": "main",
      "trunk_id": "F63d7d91f6648050011dc5d7e",
      "del_initial_digits": 0,
      "add_digits_before": "01585",
      "add_digits_after": "1555",
      "call_id": "55456954",
      "removal_starting_position": "1",
      "number_of_digits_to_remove": "1"
    }
  ],
  "icon": "phone"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Fixo local",
  "number_format": "[2-5]XXXXXXX",
  "enabled": 1,
  "time_group_id": "63f26d83f7dedc1249a039b7",
  "source": "456954",
  "transhipments": [
    {
      "type": "main",
      "trunk_id": "F63d7d91f6648050011dc5d7e",
      "del_initial_digits": 0,
      "add_digits_before": "01585",
      "add_digits_after": "1555",
      "call_id": "55456954",
      "removal_starting_position": "1",
      "number_of_digits_to_remove": "1"
    }
  ],
  "icon": "phone"
}

Atualiza uma permissão de saída

put

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome da permissão de saída

Example: Fixo local

number_formatstringObrigatório

Expressão que representa o número de saída desta permissão de saída

Example: [2-5]XXXXXXX

enablednumberObrigatório

Flag que indica se a rota está ativa (1) ou não (0)

Example: 1

time_group_idstringObrigatório

ID de um grupo de horários (campo id da collection time_groups)

Example: 63f26d83f7dedc1249a039b7

sourcestringObrigatório

Identifica a origem do número na rota de saída.

Example: 456954

iconstringObrigatório

Ícone que vai ser exibido na tela de permissões de saída.

Example: phone

_idstringObrigatório

ID da permissão de saída

Example: 63724b92c0ef93903y24dc45

Respostas

default

application/json

put

/pbx/outcalls

HTTPcURLJavaScriptPython

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

{
  "name": "Fixo local",
  "number_format": "[2-5]XXXXXXX",
  "enabled": 1,
  "time_group_id": "63f26d83f7dedc1249a039b7",
  "source": "456954",
  "transhipments": [
    {
      "type": "main",
      "trunk_id": "F63d7d91f6648050011dc5d7e",
      "del_initial_digits": 0,
      "add_digits_before": "01585",
      "add_digits_after": "1555",
      "call_id": "55456954",
      "removal_starting_position": "1",
      "number_of_digits_to_remove": "1"
    }
  ],
  "icon": "phone",
  "_id": "63724b92c0ef93903y24dc45"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Fixo local",
  "number_format": "[2-5]XXXXXXX",
  "enabled": 1,
  "time_group_id": "63f26d83f7dedc1249a039b7",
  "source": "456954",
  "transhipments": [
    {
      "type": "main",
      "trunk_id": "F63d7d91f6648050011dc5d7e",
      "del_initial_digits": 0,
      "add_digits_before": "01585",
      "add_digits_after": "1555",
      "call_id": "55456954",
      "removal_starting_position": "1",
      "number_of_digits_to_remove": "1"
    }
  ],
  "icon": "phone"
}

Deleta uma permissão de saída

delete

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

delete

/pbx/outcalls

HTTPcURLJavaScriptPython

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

default

{
  "count": 1
}

Retorna lista de permissões de saída

get

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

get

/pbx/outcalls/all

HTTPcURLJavaScriptPython

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

default

[
  {
    "_id": "63724b92c0ef93903y24dc45",
    "name": "Fixo local",
    "number_format": "[2-5]XXXXXXX",
    "enabled": 1,
    "time_group_id": "63f26d83f7dedc1249a039b7",
    "source": "456954",
    "transhipments": [
      {
        "type": "main",
        "trunk_id": "F63d7d91f6648050011dc5d7e",
        "del_initial_digits": 0,
        "add_digits_before": "01585",
        "add_digits_after": "1555",
        "call_id": "55456954",
        "removal_starting_position": "1",
        "number_of_digits_to_remove": "1"
      }
    ],
    "icon": "phone"
  }
]

Deleta todas as permissões de saída

delete

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

delete

/pbx/outcalls/all

HTTPcURLJavaScriptPython

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

default

{
  "count": 1
}

Atualiza a posição das rotas

put

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

old_positionnumberObrigatório

A antiga posição

Example: 4

new_positionnumberObrigatório

A nova posição

Example: 2

Respostas

default

application/json

put

/pbx/outcalls/update_position

HTTPcURLJavaScriptPython

PUT /pbx/outcalls/update_position HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "old_position": 4,
  "new_position": 2
}

default

{
  "sucess": "true"
}