Search docs/

Buscar mensagens

{...}

Buscar mensagens no Layers Education

GET https://api.layers.digital/v1/tickets/search
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota.

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade
  • agent
    (query)
    Identificador do atendente
  • channel
    (query)
    Identificador do canal de atendimento
  • author.id
    (query)
    Identificador do autor da mensagem
  • author.name
    (query)
    Nome do autor da mensagem
  • author.email
    (query)
    E-mail do autor da mensagem
  • subject
    (query)
    Assunto da conversa
  • source.type
    (query)
    Tipo da fonte da mensagem
  • source.alias
    (query)
    Identificador da fonte da mensagem na comunidade
  • source.id
    (query)
    Identificador da fonte da mensagem

Resposta

Especificação

  • totalNumber

    Número de mensagens encontradas que correspondem aos filtros

  • hitsTicket[ ]

    Mensagens encontradas

Exemplo

{
  "total": 5.5,
  "hits": [
    {
      "id": "5bb2575199d7179dfe85be02",
      "createdAt": "2020-09-15T14:14:14.277Z",
      "updatedAt": "2020-09-15T14:14:14.277Z",
      "interactedAt": "2020-09-15T14:14:14.277Z",
      "code": 12,
      "source": {
        "id": "5bb2575199d7179dfe85be02",
        "type": "app",
        "alias": "exemplo"
      },
      "author": {
        "id": "5bb2575199d7179dfe85be02",
        "email": "luke@starwars.com",
        "name": "autor@email.com"
      },
      "subject": "Revisão de provas",
      "subjectHistory": [
        "exemplo"
      ],
      "message": "Boa tarde! Gostaria de saber o que errei na prova de português do dia 30/06. Obrigado!",
      "status": "pending",
      "statusN": 3,
      "priority": "normal",
      "finished": true,
      "finishedAt": "2020-09-15T14:14:14.277Z",
      "durationTotal": 5.5,
      "durationEfective": 5.5,
      "firstReplyAt": "2020-09-15T14:14:14.277Z",
      "firstReplyDelayTotal": 5.5,
      "firstReplyDelayToalEffective": 5.5,
      "agent": {
        "id": "5bb2575199d7179dfe85be02",
        "name": "Jorge Farias",
        "email": "luke@starwars.com"
      },
      "channel": {
        "id": "5bb2575199d7179dfe85be02",
        "name": "Pedagógico",
        "allowAudio": true
      },
      "events": [
        {
          "ticketId": "5bb2575199d7179dfe85be02",
          "createdAt": "2020-09-15T14:14:14.277Z",
          "type": "note",
          "value": "Bom dia!",
          "author": {
            "id": "5bb2575199d7179dfe85be02",
            "name": "Joao Pedro Paulino",
            "email": "luke@starwars.com"
          },
          "sender": "exemplo"
        }
      ]
    }
  ]
}
CopiarCopiado