Saltar al contenido principal
POST
Iniciar conversación saliente de LeadScout con un lead conocido

Autorizaciones

x-api-key
string
header
requerido

Copy the API key as provided by the Bridge Console.

Parámetros de ruta

workspaceId
string<uuid>
requerido

Identificador único del workspace (UUID v4).

Ejemplo:

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

Cuerpo

application/json

Cuerpo de la solicitud para iniciar una conversación saliente de LeadScout.

contact
Contact · object
requerido

Lead al que se dirige esta conversación saliente. Ya debe existir en el workspace.

template
Template · object
requerido

Plantilla inicial que se enviará.

additionalMessages
OutboundFollowUpRequest · object[]

Hasta cinco mensajes de seguimiento guardados en la conversación en el orden de la solicitud. La persistencia no confirma la entrega. No asumas que estos mensajes esperan la respuesta del lead; consulta la guía de outbound para considerar entrega y reintentos.

Maximum array length: 5
agentContext
OutboundAgentContextRequest · object | null

Notas y medios guardados en la conversación como contexto del agente para la revisión por IA o una persona.

Evidencia de consentimiento declarada por la empresa y registrada sin modificaciones en la conversación.

handoffOverride
LeadscoutOutboundHandoffOverride · object | null

Reemplaza la asignación predeterminada del asesor de la conversación saliente.

brandId
string | null

ID opcional de marca. Si se proporciona, solo son elegibles los canales vinculados a ella. Omítelo para considerar todos los canales del workspace.

Ejemplo:

null

campaignId
string | null

Referencia opcional de campaña guardada en la conversación para auditoría e informes.

Ejemplo:

null

forceSend
boolean
predeterminado:false

Controla la reutilización de una conversación activa existente con este Contact en la línea elegida. Con false (predeterminado), una línea ocupada seleccionada explícitamente devuelve 409 BRIDGE_AI_LEADSCOUT_0007; la selección automática con solo líneas ocupadas devuelve 409 BRIDGE_AI_LEADSCOUT_0008. Con true, se reutiliza una conversación ocupada apta en lugar de crear una nueva, y una reutilización exitosa establece alreadyInitiated=true. La selección automática prefiere una línea libre, después una conversación liberada recuperable y, por último, una conversación ocupada cuando true. La recuperación es posible con cualquiera de los dos valores y devuelve recovered=true. La ruta heredada de LeadScout puede reutilizar una conversación controlada por un humano; no aplica la comprobación de control del envío saliente de Agents. Esta opción no omite las conversaciones bloqueadas/no recuperables, las comprobaciones de sesión ni otras validaciones y no es una clave de idempotencia. Consulta Envío saliente de Agents y forceSend.

Ejemplos:

false

true

Respuesta

Respuesta satisfactoria

Cuerpo de respuesta de un inicio saliente de LeadScout satisfactorio.

conversation
Conversation · object
requerido

Conversación utilizada para esta solicitud saliente: nueva, reutilizada (alreadyInitiated=true) o recuperada (recovered=true). Una conversación reutilizada conserva su ID; la reutilización legacy, por sí sola, no implica que haya cambiado su controlador.

contact
Contact · object
requerido

Contacto con el que se inició la conversación.

templateSent
LeadscoutTemplateSent · object | null

Resumen de la plantilla despachada para abrir la conversación.

additionalMessagesPersisted
integer
predeterminado:0

Número de mensajes de seguimiento guardados en la conversación.

Ejemplos:

0

3

alreadyInitiated
boolean
predeterminado:false

True cuando esta solicitud satisfactoria reutilizó una conversación activa existente mediante forceSend=true. False para creación o recuperación; consulta recovered para distinguir esas rutas. Es informativo: una reutilización satisfactoria también guarda la nueva plantilla y los seguimientos, por lo que repetir la solicitud puede agregar mensajes.

Ejemplos:

false

true

recovered
boolean
predeterminado:false

True cuando esta solicitud recuperó una conversación liberada que el contacto tenía en el canal elegido, en lugar de crear otra.

Ejemplos:

false

true