Permissões de discagem de entrada

Retorna uma permissão de entrada

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

get

/pbx/incalls

HTTPcURLJavaScriptPython

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

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "IN DDR 8XXX",
  "did": "_8XXX",
  "dst": "645d050c3f0df3001f4d426d",
  "enabled": 1,
  "tags": [
    "comercial",
    "diretoria"
  ],
  "source_numbers": [
    "85986251919",
    "_11X."
  ],
  "trunk_id": "64039e5d388735a60f299874",
  "route_by_time": [
    {
      "time_group_id": "64039e61388735a60f299876",
      "audio_ids": [
        "64039e5d388735a60f299874"
      ],
      "dst_type": "agent",
      "dst": "645d050c3f0df3001f4d426d"
    }
  ],
  "audio_ids": [
    "64039e5d388735a60f299874"
  ],
  "dst_type": "agent",
  "direct_whatsapp_agent": false
}

Cadastro de permissão de entrada

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome da permissão de entrada

Example: IN DDR 8XXX

didstringObrigatório

DDR da permissão de entrada

Example: _8XXX

dststringObrigatório

Destino default da permissão de entrada

Example: _8XXX

enablednumberObrigatório

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

Example: 1

tagsstring[]Obrigatório

Lista de tags

Example: ["comercial","diretoria"]

source_numbersstring[]Obrigatório

Lista de expressões de números de origem

Example: ["85986251919","_11X."]

trunk_idstringObrigatório

Operadora associada à esta rota (campo id da collection voice_trunks)

Example: 64039e5d388735a60f299874

audio_idsstring[]Obrigatório

Ids dos áudios da playlist system

Example: ["64039e5d388735a60f299874"]

dst_typestringObrigatório

Tipo do destino [agent, campaign, ivr, did]

Example: agent

direct_whatsapp_agentbooleanObrigatório

Receber ligações do whatsapp

Example: false

Respostas

default

application/json

post

/pbx/incalls

HTTPcURLJavaScriptPython

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

{
  "name": "IN DDR 8XXX",
  "did": "_8XXX",
  "dst": "_8XXX",
  "enabled": 1,
  "tags": [
    "comercial",
    "diretoria"
  ],
  "source_numbers": [
    "85986251919",
    "_11X."
  ],
  "trunk_id": "64039e5d388735a60f299874",
  "route_by_time": [
    {
      "time_group_id": "64039e61388735a60f299876",
      "audio_ids": [
        "64039e5d388735a60f299874"
      ],
      "dst_type": "agent",
      "dst": "645d050c3f0df3001f4d426d"
    }
  ],
  "audio_ids": [
    "64039e5d388735a60f299874"
  ],
  "dst_type": "agent",
  "direct_whatsapp_agent": false
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "IN DDR 8XXX",
  "did": "_8XXX",
  "dst": "645d050c3f0df3001f4d426d",
  "enabled": 1,
  "tags": [
    "comercial",
    "diretoria"
  ],
  "source_numbers": [
    "85986251919",
    "_11X."
  ],
  "trunk_id": "64039e5d388735a60f299874",
  "route_by_time": [
    {
      "time_group_id": "64039e61388735a60f299876",
      "audio_ids": [
        "64039e5d388735a60f299874"
      ],
      "dst_type": "agent",
      "dst": "645d050c3f0df3001f4d426d"
    }
  ],
  "audio_ids": [
    "64039e5d388735a60f299874"
  ],
  "dst_type": "agent",
  "direct_whatsapp_agent": false
}

Atualiza uma permissão de entrada

put

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome da permissão de entrada

Example: IN DDR 8XXX

didstringObrigatório

DDR da permissão de entrada

Example: _8XXX

dststringObrigatório

Destino default da permissão de entrada

Example: _8XXX

enablednumberObrigatório

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

Example: 1

tagsstring[]Obrigatório

Lista de tags

Example: ["comercial","diretoria"]

source_numbersstring[]Obrigatório

Lista de expressões de números de origem

Example: ["85986251919","_11X."]

trunk_idstringObrigatório

Operadora associada à esta rota (campo id da collection voice_trunks)

Example: 64039e5d388735a60f299874

audio_idsstring[]Obrigatório

Ids dos áudios da playlist system

Example: ["64039e5d388735a60f299874"]

dst_typestringObrigatório

Tipo do destino [agent, campaign, ivr, did]

Example: agent

direct_whatsapp_agentbooleanObrigatório

Receber ligações do whatsapp

Example: false

_idstringObrigatório

ID da permissão de entrada

Example: 63724b92c0ef93903y24dc45

Respostas

default

application/json

put

/pbx/incalls

HTTPcURLJavaScriptPython

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

{
  "name": "IN DDR 8XXX",
  "did": "_8XXX",
  "dst": "_8XXX",
  "enabled": 1,
  "tags": [
    "comercial",
    "diretoria"
  ],
  "source_numbers": [
    "85986251919",
    "_11X."
  ],
  "trunk_id": "64039e5d388735a60f299874",
  "route_by_time": [
    {
      "time_group_id": "64039e61388735a60f299876",
      "audio_ids": [
        "64039e5d388735a60f299874"
      ],
      "dst_type": "agent",
      "dst": "645d050c3f0df3001f4d426d"
    }
  ],
  "audio_ids": [
    "64039e5d388735a60f299874"
  ],
  "dst_type": "agent",
  "direct_whatsapp_agent": false,
  "_id": "63724b92c0ef93903y24dc45"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "IN DDR 8XXX",
  "did": "_8XXX",
  "dst": "645d050c3f0df3001f4d426d",
  "enabled": 1,
  "tags": [
    "comercial",
    "diretoria"
  ],
  "source_numbers": [
    "85986251919",
    "_11X."
  ],
  "trunk_id": "64039e5d388735a60f299874",
  "route_by_time": [
    {
      "time_group_id": "64039e61388735a60f299876",
      "audio_ids": [
        "64039e5d388735a60f299874"
      ],
      "dst_type": "agent",
      "dst": "645d050c3f0df3001f4d426d"
    }
  ],
  "audio_ids": [
    "64039e5d388735a60f299874"
  ],
  "dst_type": "agent",
  "direct_whatsapp_agent": false
}

Deleta uma permissão de entrada

delete

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

delete

/pbx/incalls

HTTPcURLJavaScriptPython

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

default

{
  "count": 1
}

Retorna lista de permissões de entrada

get

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

get

/pbx/incalls/all

HTTPcURLJavaScriptPython

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

default

[
  {
    "_id": "63724b92c0ef93903y24dc45",
    "name": "IN DDR 8XXX",
    "did": "_8XXX",
    "dst": "645d050c3f0df3001f4d426d",
    "enabled": 1,
    "tags": [
      "comercial",
      "diretoria"
    ],
    "source_numbers": [
      "85986251919",
      "_11X."
    ],
    "trunk_id": "64039e5d388735a60f299874",
    "route_by_time": [
      {
        "time_group_id": "64039e61388735a60f299876",
        "audio_ids": [
          "64039e5d388735a60f299874"
        ],
        "dst_type": "agent",
        "dst": "645d050c3f0df3001f4d426d"
      }
    ],
    "audio_ids": [
      "64039e5d388735a60f299874"
    ],
    "dst_type": "agent",
    "direct_whatsapp_agent": false
  }
]

Deleta todas as permissões de entrada

delete

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

delete

/pbx/incalls/all

HTTPcURLJavaScriptPython

DELETE /pbx/incalls/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/incalls/update_position

HTTPcURLJavaScriptPython

PUT /pbx/incalls/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"
}