Pausas

Retorna lista de pausas

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

limitnumberOpcional

Número máximo de itens por página.

Default: 10Example: 10

pagenumberOpcional

Número da página a ser retornada.

Default: 1Example: 1

sort_orderstring · enumOpcional

Ordem da listagem, podendo ser "ASC" para ascendente ou "DESC" para descendente.

Default: ASCExample: ASCValores possíveis:

sort_fieldstringOpcional

Campo pelo qual será ordenado.

Default: nameExample: name

search_fieldsstringOpcional

Lista de campos a serem filtrados.

search_valuestringOpcional

Lista de valores correspondentes aos campos filtrados.

search_textstringOpcional

Texto a ser usado para busca em todos os campos.

Respostas

200Sucesso

Sem conteúdo

get

/pbx/pauses

HTTPcURLJavaScriptPython

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

200Sucesso

Sem conteúdo

Cadastro de pausa

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

activebooleanObrigatório

Indica se a pausa está ativa ou não

Example: true

productivebooleanObrigatório

Indica se a pausa é produtiva ou não

Example: false

cumulativebooleanObrigatório

Indica se a pausa é do tipo acumulativa ou não

Example: false

supervisionedbooleanObrigatório

Indica se a pausa é supervisionada ou não

Example: false

namestringObrigatório

Nome da pausa

Example: Balcão

descriptionstringObrigatório

Descrição da pausa

Example: Atendimento à cliente no balcão

initialTimestringObrigatório

Indica a partir de qual horário a pausa poderá ser usada

Example: 15:00

maxTimestringObrigatório

Indica a quantidade máxima de tempo em segundos que esta pausa será usada

Example: 20

iconstringObrigatório

Nome do ícone

Example: code

Respostas

default

application/json

post

/pbx/pauses

HTTPcURLJavaScriptPython

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

{
  "active": true,
  "productive": false,
  "cumulative": false,
  "supervisioned": false,
  "name": "Balcão",
  "description": "Atendimento à cliente no balcão",
  "initialTime": "15:00",
  "maxTime": "20",
  "icon": "code"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "active": true,
  "productive": false,
  "cumulative": false,
  "supervisioned": false,
  "name": "Balcão",
  "description": "Atendimento à cliente no balcão",
  "initialTime": "15:00",
  "maxTime": "20",
  "icon": "code"
}

Atualiza uma pausa

put

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

activebooleanObrigatório

Indica se a pausa está ativa ou não

Example: true

productivebooleanObrigatório

Indica se a pausa é produtiva ou não

Example: false

cumulativebooleanObrigatório

Indica se a pausa é do tipo acumulativa ou não

Example: false

supervisionedbooleanObrigatório

Indica se a pausa é supervisionada ou não

Example: false

namestringObrigatório

Nome da pausa

Example: Balcão

descriptionstringObrigatório

Descrição da pausa

Example: Atendimento à cliente no balcão

initialTimestringObrigatório

Indica a partir de qual horário a pausa poderá ser usada

Example: 15:00

maxTimestringObrigatório

Indica a quantidade máxima de tempo em segundos que esta pausa será usada

Example: 20

iconstringObrigatório

Nome do ícone

Example: code

_idstringObrigatório

ID da operadora/tronco

Example: 63724b92c0ef93903y24dc45

Respostas

default

application/json

put

/pbx/pauses

HTTPcURLJavaScriptPython

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

{
  "active": true,
  "productive": false,
  "cumulative": false,
  "supervisioned": false,
  "name": "Balcão",
  "description": "Atendimento à cliente no balcão",
  "initialTime": "15:00",
  "maxTime": "20",
  "icon": "code",
  "_id": "63724b92c0ef93903y24dc45"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "active": true,
  "productive": false,
  "cumulative": false,
  "supervisioned": false,
  "name": "Balcão",
  "description": "Atendimento à cliente no balcão",
  "initialTime": "15:00",
  "maxTime": "20",
  "icon": "code"
}

Deleta uma pausa

delete

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

idsstring[]Obrigatório

Id das pausas a serem removidas

Example: ["66ff21b2578606ba115f9ee2"]

Respostas

default

application/json

delete

/pbx/pauses

HTTPcURLJavaScriptPython

DELETE /pbx/pauses HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "ids": [
    "66ff21b2578606ba115f9ee2"
  ]
}

default

{
  "count": 1
}