Um pedido de ZIP

GET

/v1/downloads/bundles/{bundleId}

const url = 'https://developers.nexo.winningsales.com.br/v1/downloads/bundles/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/downloads/bundles/example \
  --header 'Authorization: Bearer <token>'

A situação do pedido (building, ready ou failed com o motivo) e, quando pronto, uma URL assinada nova.

Authorizations

bearer

Parameters

Path Parameters

bundleId

required

string

Id do pedido

Responses

200

O pedido

application/json

object

required

Id do lote

string format: uuid

status

required

Montando, pronto para baixar ou falhou

string

Allowed values: building ready failed

itemCount

required

Quantas conversas entraram no pedido, somando reuniões, WhatsApp e e-mail

integer

includeAudio

required

Se o pedido incluiu os áudios

boolean

sizeInBytes

required

Tamanho do ZIP quando pronto

integer

nullable

failureReason

required

Por que falhou: lote acima do limite de tamanho, nenhuma conversa com conteúdo para baixar, ou erro inesperado

string

nullable

Allowed values: too_large empty unexpected

fileName

required

Nome sugerido para o ZIP

string

url

required

URL assinada do ZIP quando pronto, válida por poucos minutos; null antes disso

string format: uri

nullable

expiresAt

required

Quando a URL deixa de funcionar

string format: date-time

nullable

createdAt

required

Quando o lote foi pedido

string format: date-time

readyAt

required

Quando o ZIP ficou pronto

string format: date-time

nullable

Example

{
  "status": "building",
  "failureReason": "too_large"
}

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

Pedido inexistente ou de outra pessoa

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": "downloads.not_found",
  "title": "DownloadNotFoundError",
  "status": 404,
  "detail": "Download não encontrado.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "downloadId": "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
  }
}