Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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.

Endpoint/api/v1/queues
MethodPOST

Parâmetros

Corpo em JSON

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

201
{
  "meta": {
    "status": 200,
    "message": "Created"
  },
  "data": {
    "id": 42
  }
}
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.

Endpoint/api/v1/queues
MethodGET

Parâmetros

Query na URL

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

Exemplos de retorno

200
{
  "meta": {
    "status": 200,
    "message": "Created"
  },
  "data": [
    {
      "id": 42,
      "name": "Do not panic",
      "slug": "do_not_panic",
      "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.

Endpoint/api/v1/queues/{queue_id}
MethodGET

Parâmetros

No endpoint da URL

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

Query da URL

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": "Do not panic",
    "slug": "do_not_panic",
    "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.

Endpoint/api/v1/queues/{queue_id}
MethodPUT

Parâmetros

No endpoint da URL

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

Corpo em JSON

nameopcionalNome humanamente legível da fila.
numberopcionalNú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 segundos, 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.

Endpoint/api/v1/queues/{queue_id}
MethodDELETE

Parâmetros

No endpoint da URL

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"
  }
}



  • No labels