collections

Detalhe de uma solicitacao

Traz os itens (com status e o parecer de cada um), os destinatarios (com o estado da entrega), o cadastro alvo em registry, a contagem em progress e a trilha. O link de cada destinatario NAO volta aqui: ele so existe na resposta de criacao e na de envio.

Status de item: PENDING, ALREADY_ON_FILE, SUBMITTED, PROCESSING, VALIDATED, REJECTED, MANUAL_REVIEW, AWAITING_OPERATOR (a IA avaliou e espera decisao humana), WAIVED, EXPIRED.

Estado do destinatario: PENDING, DELIVERED, OPENED, IN_PROGRESS, COMPLETED, FAILED e NO_ITEMS (nao sobrou item para essa pessoa).

FAILED no destinatario quer dizer que a MENSAGEM nao chegou. E o caso de ligar para o cliente.

get/v1/collections/{id}

Request

  • Base URL: https://gyra-core.gyramais.com.br
  • URL: https://gyra-core.gyramais.com.br/v1/collections/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Id da solicitacao.

Response

Solicitacao com itens, destinatarios, links e trilha.

idstring
registryIdstring
templateIdstring nullable
templateSlugstring nullable
templateNamestring nullable
templateVersioninteger nullable
status'DRAFT' | 'SENT' | 'IN_PROGRESS' | 'COMPLETED' | 'EXPIRED' | 'CANCELED'
responseMode'AUTOMATIC' | 'REVIEW'
channel'WHATSAPP' | 'EMAIL' | 'BOTH' | 'NONE'

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

remindersinteger[]

Dias apos o envio.

behaviorobject

O comportamento herdado do modelo.

messagestring nullable

Recado do operador ao destinatario.

dueAtstring date-time nullable
sentAtstring date-time nullable
completedAtstring date-time nullable
canceledAtstring date-time nullable
subjectNamestring nullable

Resumo do cadastro alvo, para evitar uma segunda chamada.

subjectDocumentstring nullable
itemsTotalinteger
itemsResolvedinteger
itemsAwaitingOperatorinteger

Itens esperando decisao humana (AWAITING_OPERATOR ou MANUAL_REVIEW).

progressobject

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

createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.