Canais e Mensagens

Esta página reúne os endpoints e campos relacionados a canais de contato e histórico de interações de atendimento (WhatsApp, Webchat, Telegram, Instagram, Messenger, e-mail, SMS e voz).

Todas as requisições exigem o cabeçalho Authorization — veja Autenticação e Segurança.

Para enviar mensagens ativamente (chat, HSM de WhatsApp, e-mail, SMS, botões, CTA, etc.), veja Envio de Mensagens. Esta página trata de consulta ao que já foi trocado com o cliente.

Índice desta página

• Buscar histórico de interações de um caso

• Buscar conteúdo de e-mail

• Buscar anexo de histórico de interações de chat

• Inserir tag do caso no assunto de e-mails

• Listar os áudios de ligações de um atendimento

• Baixar áudio de uma ligação

• Tipos de contato da Pessoa

• Campos de canal no Caso

Buscar histórico de interações de um caso

Permite obter o histórico de interações de um caso — o recurso citado na Visão Geral como "histórico de interações de chat".

Request

GET https://api.cvortex.com/v1/message-history/{hash_case}/filter

Header: Authorization

Parâmetros de URI

Response

Exemplo

GET https://api.cvortex.com/v1/message-history/3639722f-5dd7-4435-9fd6-ccf71ce2f900/filter?channel=WHATSAPP

{
   "content": [
      {
         "messageHistoryId": "123",
         "messageType": "TEXT",
         "assetId": "123",
         "assetAssignee": "123",
         "channel": "WHATSAPP",
         "hsmTemplateId": "123",
         "message": "Hello World!",
         "status": "READ",
         "digitalId": "3412345678",
         "way": "SENT",
         "conversationId": "123",
         "channelAccountKey": "123",
         "error": null,
         "errorTitle": null,
         "errorCode": null,
         "repliedHistoryId": null,
         "createdAt": 1658928025873,
         "messageReceivedDate": 1658928025873
      }
   ],
   "totalElements": 1,
   "totalPages": 1
}

Buscar conteúdo de e-mail

Permite obter o conteúdo de um e-mail a partir de um ID de histórico de interações.

Request

GET https://api.cvortex.com/v1/message-history/email/{id}/content

Header: Authorization

Parâmetros de URI

Response

Exemplo

GET https://api.cvortex.com/v1/message-history/email/3639722f-5dd7-4435-9fd6-ccf71ce2f900/content?exclude-tags=true

{
  "content": "Conteúdo do email"
}

Buscar anexo de histórico de interações de chat

Permite obter o anexo de um histórico de interações (WhatsApp, Webchat, Telegram, Instagram, Messenger e E-mail). O endpoint retorna uma lista de URLs para download dos arquivos de anexo referentes ao histórico buscado.

Request

GET https://api.cvortex.com/v1/message-history/attachment/{messageHistoryId}

Header: Authorization

Parâmetros de URI

Response

Exemplo

GET https://api.cvortex.com/v1/message-history/attachment/3639722f-5dd7-4435-9fd6-ccf71ce2f900

[
  { "url": "https://storage.googleapis.com/12345/abcdefc" }
]

Inserir tag do caso no assunto de e-mails

Adiciona a tag do caso no assunto de e-mails recebidos, garantindo que respostas e encaminhamentos de e-mails do cliente voltem para o mesmo caso que iniciou a conversa.

Request

POST https://api.cvortex.com/v1/email/{messageHistoryId}/add-case-tag

Header: Authorization

Parâmetros de body

N.A.

Exemplo de request

POST https://api.cvortex.com/v1/email/db2d5ff1-af3d-4523-b16b-de4b3d2de15b/add-case-tag

{}

Listar os áudios de ligações de um atendimento

Permite recuperar a lista de ligações realizadas para um atendimento.

Request

GET https://api.cvortex.com/v1/case/{caseId}/voice-records

Header: Authorization

Parâmetros de body

N.A.

Exemplo de request

GET https://api.cvortex.com/v1/case/dfb286c0-7958-4399-b918-e0d3587f0f90/voice-records

Response

[
  {
    "messageHistoryId": "50bbaf9a-7032-4c1e-baba-ed54d201ce60",
    "way": "SENT",
    "channel": "VOICE",
    "duration": 41,
    "callDate": 1757436031000
  }
]

Baixar áudio de uma ligação

Permite recuperar o link de download do áudio de uma ligação. É necessário informar o messageHistoryId recuperado no endpoint Listar os áudios de ligações de um atendimento.

Request

GET https://api.cvortex.com/v1/voice-records/{recordId}

Header: Authorization

Parâmetros de body

N.A.

Exemplo de request

GET https://api.cvortex.com/v1/voice-records/50bbaf9a-7032-4c1e-baba-ed54d201ce60

Response

O retorno é a URL de download (assinada, com expiração) do áudio:

[
  {
    "attachmentUrl": "https://storage.googleapis.com/<bucket>/<caminho-do-arquivo>.WAV?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=...&X-Goog-Date=...&X-Goog-Expires=300&X-Goog-SignedHeaders=host&X-Goog-Signature=..."
  }
]

Tipos de contato da Pessoa

Ao criar ou atualizar uma pessoa, os canais de contato são enviados na lista contactsToAdd, cada um com um par de campos Contact Type / Value. Os valores de Contact Type observados nos exemplos da API são:

Veja o payload completo em Gestão de Pessoas → Criar Pessoa.

Na criação de caso por formulário (v2), o mesmo conceito aparece na estrutura personRequest.contacts, com os campos channelType (ex: VOICE, EMAIL) e contactType (ex: MOBILE_PHONE, LANDLINE_PHONE, EMAIL).

Campos de canal no Caso

O objeto de caso (retornado em Buscar caso por ID e em Buscar Casos (v2)) carrega o canal e o contato pelos quais o caso está ou foi tratado: