Pular para o conteúdo principal
POST
Iniciar conversa de saída com um Contact como Agent específico

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

agentId
string<uuid>
obrigatório

Identificador único do Agent (UUID v4), conforme GET /agents.

Exemplo:

"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"

Corpo

application/json

Corpo da solicitação para iniciar uma conversa de saída atendida por um Agent específico.

contact
Contact · object
obrigatório

Contact ao qual esta conversa de saída é direcionada. Já deve existir no workspace.

template
Template · object
obrigatório

Modelo inicial a ser enviado.

additionalMessages
AgentOutboundFollowUp · object[]

Até cinco acompanhamentos de texto armazenados na conversa após o modelo inicial, na ordem informada, e enviados como o modelo. Os anexos (mediaIds) ainda não são enviados.

Maximum array length: 5
agentContext
AgentOutboundContext · object | null

Notas e mídias armazenadas na conversa como contexto para o Agent e os Bridge Users.

Evidência de consentimento declarada pela empresa e registrada sem modificações na conversa.

handoffOverride
AgentOutboundHandoffOverride · object | null

Pré-atribui o Bridge User que recebe a transferência da conversa de saída.

brandId
string | null

ID opcional da marca. Quando informado, apenas as linhas do Agent vinculadas à marca são elegíveis; se não houver nenhuma, a solicitação falha com 404. Omita para considerar todas as linhas do Agent.

Exemplo:

null

campaignId
string | null

Referência opcional de campanha armazenada na conversa para auditoria e relatórios.

Exemplo:

null

forceSend
boolean
padrão:false

Controla o que acontece quando nenhuma linha do Agent está livre ou é recuperável. Uma linha livre sempre tem prioridade, seguida de uma linha com uma conversa liberada recuperável com este Contact, qualquer que seja o valor desta opção. Quando nenhuma existe: com false (padrão), a solicitação falha com 409 BRIDGE_AI_LEADSCOUT_0008; com true, uma linha ocupada por uma conversa ativa com este Contact é reutilizada, dando preferência a uma controlada por este Agent. Se a conversa escolhida for controlada por outro Agent ou por um Bridge User, a solicitação falha com 409 BRIDGE_AI_AGENT_OUTBOUND_0006 e nada é gravado; libere-a primeiro e tente novamente. Linhas cuja conversa está bloqueada ou foi liberada sem recuperação nunca são usadas; portanto, se nenhuma linha estiver ocupada por uma conversa ativa, a solicitação falha com 409 BRIDGE_AI_LEADSCOUT_0008 mesmo com true.

Exemplos:

false

true

Resposta

Resposta bem-sucedida

Corpo da resposta de uma iniciação de saída bem-sucedida do Agent.

conversation
Conversation · object
obrigatório

Conversa agora controlada pelo Agent: nova, reutilizada (alreadyInitiated) ou recuperada (recovered).

contact
Contact · object
obrigatório

Contato com o qual a conversa foi iniciada.

templateSent
AgentTemplateSent · object | null

Resumo do modelo armazenado para abrir a conversa.

additionalMessagesPersisted
integer
padrão:0

Número de mensagens de acompanhamento armazenadas na conversa.

Exemplos:

0

3

alreadyInitiated
boolean
padrão:false

True quando esta solicitação bem-sucedida reutilizou uma conversa ativa existente por forceSend=true. False para criação ou recuperação; consulte recovered para distinguir esses caminhos. É informativo: uma reutilização bem-sucedida também armazena o novo modelo e os acompanhamentos, portanto repetir a solicitação pode adicionar mensagens.

Exemplos:

false

true

recovered
boolean
padrão:false

True quando uma conversa liberada que o Contact tinha na linha foi recuperada em vez de criar outra. A recuperação substitui o contexto de saída anterior e agentContext. Linhas recuperáveis são usadas mesmo com forceSend=false.

Exemplos:

false

true