Skip to main content
POST
Python

Autorizações

Authorization
string
header
obrigatório

nia_sk_...

Corpo

application/json

O que um agente está prestes a fazer. Sem cliente não há orçamento, supressão nem detentor a consultar: uma pergunta assim só trata da chave do efeito.

agent
string
obrigatório
Required string length: 1 - 256
direction
enum<string>
obrigatório
Opções disponíveis:
inbound,
outbound
intent
string
obrigatório
Pattern: ^[a-z][a-z0-9_]{0,39}$
purpose
string
obrigatório
Pattern: ^[a-z][a-z0-9_]{0,39}$
channel
string | null
Pattern: ^[a-z][a-z0-9_]{0,39}$
destination_hash
string | null

O rcpt do token, calculado por quem tem a chave do gateway, quando o destino não é o handle do cliente.

Pattern: ^[A-Za-z0-9_-]{43}$
effect_key
string | null

A chave do fato de negócio; reservada atomicamente quando nada a segura.

Required string length: 1 - 512
effect_kind
enum<string>
padrão:delivery
Opções disponíveis:
delivery,
document,
notice,
filing,
paid_call,
external_action
gateway_id
string | null
Pattern: ^[a-z][a-z0-9_]{0,39}$
object
ObjectRef · object | null

Um objeto de negócio num sistema de registro.

subject
Handle · object | null

Um identificador de um sujeito num canal ou sistema: um telefone, um e-mail, um id do CRM.

task
string | null
Pattern: ^[a-z][a-z0-9_]{0,39}$

Resposta

A decisão, válida por valid_for_s segundos; quem age depois disso pergunta de novo.

A decisão de coordenação. reasons são códigos (a especificação de coordenação, 4); holder é para quem transferir com handoff_to. contact_token vem só com um contato de saída permitido de uma finalidade que precisa de um.

decision
enum<string>
obrigatório
Opções disponíveis:
allow,
defer,
deny,
handoff_to
decision_id
string<uuid>
obrigatório
valid_for_s
integer
obrigatório
Intervalo obrigatório: x >= 0
channel
ChannelState · object | null
commitments_active
CommitmentRef · object[]
contact_budget
Contact Budget · object
contact_token
string | null
Maximum string length: 1024
Pattern: ^nct1\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]{86}$
effect
EffectStatus · object | null

none quer dizer que nada segurava a chave e esta pergunta a reservou: quem chama age e depois declara.

holder
string | null
Required string length: 1 - 256
locks
Lock · object[]
owner
Owner · object | null

Quem detém o cliente ou o objeto agora: a reivindicação válida mais restritiva, de onde veio e até quando. epoch protege uma liberação.

promises_open
PromiseRef · object[]
reasons
string[]
Required string length: 1 - 256
suppressions
string[]
Pattern: ^[a-z][a-z0-9_]{0,39}$