Versions Compared

Old Version 3

changes.mady.by.user Marcell Guilherme

Saved on

compared with

New Version 4

changes.mady.by.user Marcell Guilherme

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operações básicas para manipulação dos dados das filas.

Nos cabeçalhos dos requests, é necessário incluir uma chave "token" cujo valor seja um token de API.

Criação

Cria uma nova fila.

...

nameobrigatórioNome humanamente legível da fila.
slugopcional

Forma única e amigável a URLs do nome, escrito em minúsculo, sem caracteres

especiais e com espaços substituídos por underscore. Por padrão o próprio

sistema tentará arranjar um slug para o nome (e pode falhar caso já exista).

numberobrigatórioNúmero na telefonia pelo qual a fila atenderá.
public_numberopcional

Um DID já existente pelo qual a fila atenderá publicamente – se esse DID não

existir, uma criação manual terá de ser feita.

Exemplos de retorno

{
"meta": { "status": 200,
 "message": "Created"
201201
{
  },
  "datameta": {
    "idstatus": 42200,
     "namemessage": "Created queue name",
     "slug": "created_queue_name",
 },
  "numberdata": "1234",{
    "public_numberid": null42
  }
}
400
{
  "meta": {
    "status": 400,
    "message": "Missing required params"
  }
}
500
{
  "meta": {
    "status": 500,
    "message": "Data insertion may break a database constraint"
  }
}

Leitura de muitos

Recupera uma lista de filas.

...

include_archivedopcionalSe for igual a "true" irá incluir filas arquivadas

Exemplos de retorno

200
{
  "meta": {
    "status": 200,
    "message": "Created"
  },
  "data": [
    {
      "id": 42,
      "name": "CreatedDo queuenot namepanic",
      "slug": "createddo_queuenot_namepanic",
      "number": "1234",
      "public_number": null
    },
    { 
      "id": 666, 
      "name": "Highway to Hell", 
      "slug": "highway_to_hell", 
      "number": "666", 
      "public_number": "999"
    }
  ]
}

Leitura individual

Recupera um única fila.

...

include_archivedopcionalSe for igual a "true" irá retornar a fila mesmo que ela esteja arquivada

Exemplos de retorno

200
{
  "meta": {
    "status": 200,
    "message": "Created"
  },
  "data": {
    "id": 42,
    "name": "CreatedDo queuenot namepanic",
    "slug": "createddo_queuenot_namepanic",
    "number": "1234",
    "public_number": null
  }
}
404
{
  "meta": {
    "status": 404,
    "message": "Queue not found"
  }
}
422
{
  "meta": {
    "status": 422,
    "message": "Queue archived not requested"
  }
}

Edição

Recupera uma lista de filas.

...

nameobrigatórioNome humanamente legível da fila.
numberobrigatórioNúmero na telefonia pelo qual a fila atenderá.
public_numberopcional

Um DID já existente pelo qual a fila atenderá publicamente – se esse DID não

existir, uma criação manual terá de ser feita.

max_wait_timeopcional

Máximo tempo de espera, em minutos, em que um ligador fica aguardando ser

direcionado a um agente naquela fila.

Exemplos de retorno

200
{
  "meta": {
    "status": 200,
    "message": "Updated"
  }
}
400
{
  "meta": {
    "status": 400,
    "message": "Missing fields or trying to update slug"
  }
}
404
{
  "meta": {
    "status": 404,
    "message": "Queue not found"
  }
}
422
{
  "meta": {
    "status": 422,
    "message": "Archived queue can not be edited"
  }
}

Arquivamento

Arquiva uma fila, tornando-a indiponível para ser habilitada e sua consulta fica parcialmente restringida.

...

queue_idobrigatórioDeve ser igual ao valor de um campo id de uma fila já existente.

Exemplos de retorno

200
{
  "meta": {
    "status": 200,
    "message": "Arquived"
  }
}
404
{
  "meta": {
    "status": 404,
    "message": "Queue not found"
  }
}
422
{
  "meta": {
    "status": 422,
    "message": "Enabled queue can not be archived"
  }
}