Skip to main content
GET
cURL

Quando usar

Para acompanhar item a item e ver o estado de entrega de cada destinatário.

O estado que mais importa

recipients[].status em FAILED quer dizer que a mensagem não chegou. É o caso de ligar para o cliente, e é por isso que vale assinar collection.message.failed. items[].files[] traz o parecer de cada arquivo, quando o item aceita mais de um. Item com signedDocumentAvailable: true tem via assinada para baixar. O link de cada destinatário não volta aqui: ele só existe na resposta de criação e na de envio.
Contexto e vocabulário em Solicitações de coleta. Autenticação, versionamento e capacidades em Visão geral da API.

Authorizations

Authorization
string
header
required

Enter JWT token

Path Parameters

id
string
required

Id da solicitacao.

Response

Solicitacao com itens, destinatarios, links e trilha.

Uma solicitacao de coleta com itens, destinatarios e trilha.

id
string
registryId
string
templateId
string | null
templateSlug
string | null
templateName
string | null
templateVersion
integer | null
status
enum<string>
Available options:
DRAFT,
SENT,
IN_PROGRESS,
COMPLETED,
EXPIRED,
CANCELED
responseMode
enum<string>
Available options:
AUTOMATIC,
REVIEW
channel
enum<string>

NONE: a plataforma nao avisou ninguem e quem entrega o link e voce.

Available options:
WHATSAPP,
EMAIL,
BOTH,
NONE
reminders
integer[]

Dias apos o envio.

behavior
object

O comportamento herdado do modelo.

message
string | null

Recado do operador ao destinatario.

dueAt
string<date-time> | null
sentAt
string<date-time> | null
completedAt
string<date-time> | null
canceledAt
string<date-time> | null
subjectName
string | null

Resumo do cadastro alvo, para evitar uma segunda chamada.

subjectDocument
string | null
items
object[]
recipients
object[]
events
object[]

A trilha, append-only. O detalhe traz os 100 eventos mais recentes.

registry
object | null

O cadastro alvo: id, document, name e entityType.

itemsTotal
integer
itemsResolved
integer
itemsAwaitingOperator
integer

Itens esperando decisao humana (AWAITING_OPERATOR ou MANUAL_REVIEW).

progress
object

Contagem de itens (total, resolved, validated, awaitingOperator, rejected, pending) e de destinatarios (recipientsTotal, recipientsExpected, recipientsCompleted, recipientsWithoutItems).

createdAt
string<date-time>
updatedAt
string<date-time>