Mensagens de uma conversa de WhatsApp

GET

/v1/whatsapp/sessions/{sessionId}

const url = 'https://developers.nexo.winningsales.com.br/v1/whatsapp/sessions/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://developers.nexo.winningsales.com.br/v1/whatsapp/sessions/example \
  --header 'Authorization: Bearer <token>'

As mensagens da sessão, com o lado, o horário e a mídia marcada quando houver (o arquivo de mídia não sai). O vendedor só enxerga as próprias conversas de WhatsApp e as dos contatos dos próprios negócios; admin e líder de vendas enxergam as da empresa. Conteúdo de conversa: exige o escopo conversations:read e fica registrado na atividade da empresa.

Authorizations

bearer

Parameters

Path Parameters

sessionId

required

string

Id da sessão

Responses

200

A sessão com as mensagens

application/json

object

required

Id da sessão

string format: uuid

contactName

required

Nome do contato: do CRM, do contato salvo no WhatsApp, ou o telefone

string

nullable

contactPhone

required

Telefone do contato

string

nullable

repUserId

required

Vendedor dono da conversa. Nulo quando é um número da empresa

string format: uuid

nullable

repName

required

Nome do vendedor dono da conversa

string

nullable

startedAt

required

Quando a sessão começou

string format: date-time

lastMessageAt

required

Última mensagem da sessão

string format: date-time

closedAt

required

Quando a sessão fechou. Nulo enquanto está aberta

string format: date-time

nullable

messageCount

required

Total de mensagens da sessão

integer

inboundCount

required

Mensagens recebidas do contato

integer

deal

required

Negócio associado ao contato. Nulo sem negócio em aberto ou recém-fechado

object

required

Id do negócio

string format: uuid

name

required

Nome do negócio

string

messages

required

Mensagens da sessão, em ordem

Array<object>

object

required

Id da mensagem

string format: uuid

ref

required

Referência (e1, e2…) quando esta mensagem também aparece como trecho da leitura

string

nullable

side

required

Quem enviou: contato (external) ou empresa (internal)

string

Allowed values: external internal

kind

required

Tipo da mensagem: texto, áudio, imagem, vídeo, documento etc.

string

text

required

Texto da mensagem. Em áudio, a transcrição quando já saiu. Nulo se apagada ou sem transcrição

string

nullable

sentAt

required

Quando foi enviada

string format: date-time

editedAt

required

Quando foi editada, se foi

string format: date-time

nullable

revokedAt

required

Quando foi apagada, se foi

string format: date-time

nullable

media

required

Presente quando a mensagem tem mídia. O conteúdo real fica marcado, não mostrado

object

mimeType

required

Tipo do arquivo enviado

string

stored

required

Se o arquivo já foi baixado e guardado. A URL assinada fica fora até a aprovação da Meta

boolean

Example

{
  "messages": [
    {
      "side": "external"
    }
  ]
}

401

Token ausente, inválido, expirado ou revogado

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.invalid_credential",
  "title": "InvalidCredentialError",
  "status": 401,
  "detail": "Token de acesso inválido, expirado ou revogado. Crie um novo token de acesso no Nexo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb"
}

403

Papel, escopo do token ou plano não permitem a operação

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.insufficient_scope",
  "title": "InsufficientScopeError",
  "status": 403,
  "detail": "Este token não tem o escopo conversations:read, exigido por esta operação. Gere um token com esse escopo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "operation": "conversations.reading",
    "scope": "conversations:read"
  }
}

404

Sessão inexistente ou fora da visibilidade

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "whatsapp.session_not_found",
  "title": "WhatsAppSessionNotFoundError",
  "status": 404,
  "detail": "Essa conversa de WhatsApp não está disponível.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "sessionId": "019fcae7-3e54-755a-8458-bdb605b324aa"
  }
}

429

Limite de chamadas da empresa ou do token atingido

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.rate_limited",
  "title": "PublicRateLimitedError",
  "status": 429,
  "detail": "Muitas chamadas em pouco tempo. Tente de novo em 12 segundos.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "class": "content",
    "limitedBy": "company",
    "limit": 120,
    "windowSeconds": 60,
    "retryAfterSeconds": 12
  }
}