Pular para o conteúdo principal
POST
Iniciar conversa de saída do LeadScout com um lead conhecido

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"

Corpo

application/json

Corpo da solicitação para iniciar uma conversa de saída do LeadScout.

contact
Contact · object
obrigatório

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

template
Template · object
obrigatório

Modelo inicial a ser enviado.

additionalMessages
OutboundFollowUpRequest · object[]

Até cinco mensagens de acompanhamento armazenadas na conversa na ordem da solicitação. A persistência não confirma a entrega. Não presuma que essas mensagens aguardam a resposta do lead; consulte o guia de saída para considerações sobre entrega e novas tentativas.

Maximum array length: 5
agentContext
OutboundAgentContextRequest · object | null

Notas e mídias armazenadas na conversa como contexto do agente para revisão por IA ou uma pessoa.

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

handoffOverride
LeadscoutOutboundHandoffOverride · object | null

Substitui a atribuição padrão do consultor da conversa de saída.

brandId
string | null

ID opcional da marca. Quando informado, apenas os canais vinculados a ela são elegíveis. Omita para considerar todos os canais do workspace.

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 a reutilização de uma conversa ativa existente com este Contact na linha escolhida. Com false (padrão), uma linha ocupada selecionada explicitamente retorna 409 BRIDGE_AI_LEADSCOUT_0007; a seleção automática com apenas linhas ocupadas retorna 409 BRIDGE_AI_LEADSCOUT_0008. Com true, uma conversa ocupada elegível é reutilizada em vez de criar uma nova, e uma reutilização bem-sucedida define alreadyInitiated=true. A seleção automática prefere uma linha livre, depois uma conversa liberada recuperável e, por último, uma conversa ocupada quando true. A recuperação é possível com qualquer um dos valores e retorna recovered=true. A rota legada do LeadScout pode reutilizar uma conversa controlada por um humano; ela não aplica a verificação de controle da saída de Agents. Esta opção não ignora conversas bloqueadas/não recuperáveis, verificações de sessão ou outras validações e não é uma chave de idempotência. Consulte Saída de Agents e forceSend.

Exemplos:

false

true

Resposta

Resposta bem-sucedida

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

conversation
Conversation · object
obrigatório

Conversa usada para esta solicitação de saída: nova, reutilizada (alreadyInitiated=true) ou recuperada (recovered=true). Uma conversa reutilizada mantém seu ID; a reutilização legacy, por si só, não implica mudança de controlador.

contact
Contact · object
obrigatório

Contato com o qual a conversa foi iniciada.

templateSent
LeadscoutTemplateSent · object | null

Resumo do modelo despachado 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 esta solicitação recuperou uma conversa liberada que o contato tinha no canal escolhido, em vez de criar outra.

Exemplos:

false

true