Iniciar conversa de saída do LeadScout com um lead conhecido
Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido.
Um contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha.
forceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado.
Uma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto.
Consulte o guia completo de saída para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.
POST
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
leadscout
/
outbound
Iniciar conversa de saída do LeadScout com um lead conhecido
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.
Show child attributes
template
Template · object
obrigatório
Modelo inicial a ser enviado.
Show child attributes
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
Show child attributes
agentContext
OutboundAgentContextRequest · object | null
Notas e mídias armazenadas na conversa como contexto do agente para revisão por IA ou uma pessoa.
Show child attributes
consent
OutboundConsentRequest · object | null
Evidência de consentimento declarada pela empresa e registrada sem modificações na conversa.
Show child attributes
handoffOverride
LeadscoutOutboundHandoffOverride · object | null
Substitui a atribuição padrão do consultor da conversa de saída.
Show child attributes
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.
Show child attributes
contact
Contact · object
obrigatório
Contato com o qual a conversa foi iniciada.
Show child attributes
templateSent
LeadscoutTemplateSent · object | null
Resumo do modelo despachado para abrir a conversa.
Show child attributes
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
Esta página foi útil?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bridge REST Integrations API \u0026 Webhooks","description":"Official Bridge developer documentation for the REST API, webhooks and Custom Connections: contacts, conversations and messaging. Available in English, Spanish and Brazilian Portuguese.","colors":{"primary":"#3E6EE5","light":"#93B5FF","dark":"#2F58C4"},"logo":{"light":"https://mintcdn.com/sainapsisinc/MRBSc5DvZcNEOxd1/logo/bridge_full_logo_light.png?fit=max\u0026auto=format\u0026n=MRBSc5DvZcNEOxd1\u0026q=85\u0026s=9a9d74ac33a89d538635507ba8d12eb9","dark":"https://mintcdn.com/sainapsisinc/MRBSc5DvZcNEOxd1/logo/bridge_full_logo_dark.png?fit=max\u0026auto=format\u0026n=MRBSc5DvZcNEOxd1\u0026q=85\u0026s=0c0905478472ab3f3b07066824f7f4ca"},"favicon":"https://mintcdn.com/sainapsisinc/OxyPsTqCEnnNpE4v/favicon.png?fit=max\u0026auto=format\u0026n=OxyPsTqCEnnNpE4v\u0026q=85\u0026s=8262683efaf26e188f464e1f0f02a189","appearance":{"default":"light","strict":false},"background":{"color":{"light":"#FFFFFF","dark":"#0B1220"}},"navbar":{"links":[{"href":"https://docs.bridge.new/connect-your-agent","label":"Connect AI"},{"href":"https://help.bridge.new","label":"Help Center"},{"href":"mailto:support@sainapsis.com","label":"Contact Support"}],"primary":{"type":"button","label":"Bridge app","href":"https://app.bridge.new"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/sainapsis-inc"}},"seo":{"organization":{"name":"Bridge","sameAs":["https://www.linkedin.com/company/sainapsis-inc"]},"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","download-spec"],"display":"header"},"markdown":{"instructions":["Bridge exposes three integration surfaces: the REST Integrations API for pushing data into Bridge, webhooks for receiving events from Bridge, and the public Custom Connections endpoint that a tenant's landing page posts to.","The Integrations API host is https://api-connect-us.bridge.new and every request to it must be authenticated with the x-api-key header. Bridge does not use bearer tokens or OAuth.","The Custom Connections endpoint is different and the Integrations API rules do not apply to it: it has its own host, it takes no x-api-key and no authentication header of any kind, and it is called from a visitor's browser. It is identified by a workspace id and a capture key together with a reCAPTCHA token. Never tell a reader to authenticate it with an API key, and never tell them to keep its capture key out of frontend code - it is designed to live in the page.","REST error catalog keys use BRIDGE_\u003cDOMAIN>_\u003cNNNN>, for example BRIDGE_CONVERSATION_0001. Some reviewed legacy handlers return a recognized code plus a symbolic suffix separated by |; preserve the complete received value and use the compatible catalog lookup on /error-codes. Custom Connections uses separate BRIDGE.CAMPAIGN_LEADS.\u003cNAME> identifiers on its own error reference. Never invent an error code or confuse the two integration surfaces.","This documentation covers the Integrations API, webhooks and Custom Connections only. It does not describe the Bridge web application or its internal APIs.","Before generating an API request, read the relevant OpenAPI specification or the individual endpoint Markdown page. llms-full.txt collects guides and endpoint descriptions; it does not embed every request and response schema. The REST and Custom Connections contracts are separate.","Preserve the published host, method, path, operationId, authentication, headers, parameter and field names, types, formats, required and nullable fields, enums, defaults, limits, and response codes. Do not invent identifiers, fields, retry rules, or delivery guarantees. When published sources conflict, identify the conflicting passages and ask Bridge support to confirm the current behavior before relying on it.","Custom Connections is the current name of the landing-page feature previously documented as Lead Capture. The existing /lead-capture documentation URLs, captureKey field, campaign-leads endpoint, and BRIDGE.CAMPAIGN_LEADS error identifiers are unchanged. This is a naming change, not a change to authentication or the API contract.","For a complete workflow, start with the task guides: /guides/first-conversation, /guides/send-attachments, /guides/send-template, /guides/agent-outbound, /guides/pagination, /guides/identifiers and /guides/responses. Read the endpoint contract as well as the recipe. Outbound requires an existing Contact, but does not require creating a separate Conversation first.","forceSend=true permits reuse of an existing active conversation; it does not create a fresh one by ignoring it and it is not idempotency. Recovery of a released recoverable conversation can occur even with false. The LeadScout and Agents outbound routes have different line-selection and controller checks; use /guides/agent-outbound.","For webhook HMAC, follow /webhooks/verifying-signatures exactly: the Python JSON serialization with sorted keys is signed; X-Bridge-Timestamp is not included in that signature. Do not claim a signed timestamp, raw-body signing, exactly-once delivery or a global event order. Use /webhooks/receive-events for durable acceptance and duplicates.","A 201 message response, 202 handoff or 202 Custom Connections response is not a provider delivery receipt. Do not invent a polling endpoint from messageId, trackingId or requestId. REST validation parsing must tolerate the compatibility difference explained in /error-codes.","The documentation is available in English (existing root URLs), Spanish (/es/) and Brazilian Portuguese (/pt-br/). Prefer the reader's language when a localized page exists, but preserve the API's exact field names, enums, routes, authentication and examples. Translations describe the same API; they do not introduce regional API hosts or behaviors.","For coding-assistant setup, use /connect-your-agent, /es/connect-your-agent or /pt-br/connect-your-agent. The Bridge documentation MCP server reads published documentation and has a separate optional feedback tool. Connecting it does not connect the coding assistant to a customer workspace or authorize live business requests.","For direct HTTP access without MCP, start at https://docs.bridge.new/llms.txt. It lists every published page in English, Spanish and Brazilian Portuguese. Choose /llms-en.json, /llms-es.json or /llms-pt-br.json for a language-specific index, and /llms-full-en.json, /llms-full-es.json or /llms-full-pt-br.json for collected content. /llms-full.txt contains the combined collection. Fetch the original OpenAPI specification for exact schemas.","For HTTP page reads, follow the .md URLs from the index or request Accept: text/markdown at the canonical page URL. The MCP virtual filesystem uses .mdx page paths instead; .mdx is not the public HTTP export extension. With Search MCP, set language to en, es or pt-BR explicitly; its default is en.","For integration capabilities and source-selection rules, read https://docs.bridge.new/skill.md. Documentation access does not authorize business API actions; use the actual user request, workspace, credentials and target identifiers for any live integration."]},"navigation":{"languages":[{"language":"en","default":true,"navbar":{"links":[{"href":"https://docs.bridge.new/connect-your-agent","label":"Connect AI"},{"href":"https://help.bridge.new","label":"Help Center"},{"href":"mailto:support@sainapsis.com","label":"Contact Support"}],"primary":{"type":"button","label":"Bridge app","href":"https://app.bridge.new"}},"href":""},{"language":"es","navbar":{"links":[{"href":"https://docs.bridge.new/es/connect-your-agent","label":"Conectar IA"},{"href":"https://help.bridge.new","label":"Centro de ayuda"},{"href":"mailto:support@sainapsis.com","label":"Contactar con soporte"}],"primary":{"type":"button","label":"Aplicación Bridge","href":"https://app.bridge.new"}},"href":"es"},{"language":"pt-BR","navbar":{"links":[{"href":"https://docs.bridge.new/pt-br/connect-your-agent","label":"Conectar IA"},{"href":"https://help.bridge.new","label":"Central de ajuda"},{"href":"mailto:support@sainapsis.com","label":"Falar com o suporte"}],"primary":{"type":"button","label":"Aplicativo Bridge","href":"https://app.bridge.new"}},"href":"pt-br"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sainapsisinc","hasAudioNarration":false,"actualSubdomain":"sainapsisinc","customDomains":["docs.bridge.new"],"gitSource":{"type":"github","owner":"sainapsis","repo":"open-api-public-documentation-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af883875400fbb020663982","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"en","tag":"REST API","count":25},{"language":"es","tag":"API REST","count":25},{"language":"pt-BR","tag":"API REST","count":25},{"language":"en","tag":"Getting started","count":14},{"language":"es","tag":"Primeros pasos","count":14},{"language":"pt-BR","tag":"Primeiros passos","count":14},{"language":"en","tag":"Start here","count":7},{"language":"es","tag":"Empieza aquí","count":7},{"language":"pt-BR","tag":"Comece aqui","count":7},{"language":"en","tag":"Custom Connections","count":6},{"language":"en","tag":"Contacts API","count":6},{"language":"es","tag":"Custom Connections","count":6},{"language":"es","tag":"Contacts API","count":6},{"language":"pt-BR","tag":"Custom Connections","count":6},{"language":"pt-BR","tag":"Contacts API","count":6},{"language":"en","tag":"Reference","count":5},{"language":"en","tag":"Build your integration","count":5},{"language":"en","tag":"Webhooks","count":5},{"language":"en","tag":"Conversations API","count":5},{"language":"es","tag":"Referencia","count":5},{"language":"es","tag":"Crea tu integración","count":5},{"language":"es","tag":"Webhooks","count":5},{"language":"es","tag":"Conversations API","count":5},{"language":"pt-BR","tag":"Referência","count":5},{"language":"pt-BR","tag":"Crie sua integração","count":5},{"language":"pt-BR","tag":"Webhooks","count":5},{"language":"pt-BR","tag":"Conversations API","count":5},{"language":"en","tag":"Internal Users API","count":3},{"language":"es","tag":"Internal Users API","count":3},{"language":"pt-BR","tag":"Internal Users API","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{height:2rem;width:auto;max-width:9rem;object-fit:contain}:root{--bridge-blue: #3e6ee5;--bridge-navy: #0e2841;--bridge-ink: #1a1a2e;--bridge-muted: #6d6c69;--bridge-border: #e1e8f2;--bridge-soft: #f0f5fe;--bridge-teal: #3a8a9c}body{font-family:\"Helvetica Neue\", Roboto, -apple-system, BlinkMacSystemFont, system-ui, sans-serif;-webkit-font-smoothing:antialiased}#page-title{font-weight:500;letter-spacing:-0.035em;line-height:1.15}#content-area h2,#content-area h3{font-weight:500;letter-spacing:-0.02em}html:not(.dark) #page-title,html:not(.dark) #content-area h2,html:not(.dark) #content-area h3{color:var(--bridge-navy)}html:not(.dark) #navbar{background-color:rgba(255, 255, 255, 0.96)}#search-bar-entry,#search-bar-entry-mobile{border-radius:12px}html:not(.dark) #search-bar-entry{background:#fff;border-color:var(--bridge-border);box-shadow:0 1px 3px rgba(14, 40, 65, 0.04)}#topbar-cta-button{border-radius:8px}.card{border-radius:12px;transition:border-color 150ms ease, box-shadow 150ms ease, background-color 150ms ease}html:not(.dark) .card{border-color:var(--bridge-border);background-color:#fff;box-shadow:0 1px 2px rgba(14, 40, 65, 0.035)}html:not(.dark) .card:hover{border-color:#b8ccf5;background-color:#f8faff;box-shadow:0 5px 16px rgba(14, 40, 65, 0.06)}.callout,.code-block{border-radius:12px}#content p,#content li{line-height:1.65}.bridge-surfaces .card{margin-top:0}.card:focus-visible,#navbar a:focus-visible,#sidebar a:focus-visible,#search-bar-entry:focus-visible{outline:2px solid #3865d8;outline-offset:3px}#navbar a:has(.nav-logo){display:inline-flex;align-items:center;min-height:44px}@media (max-width: 640px){.nav-logo{height:1.75rem;max-width:8rem}}@media (prefers-reduced-motion: reduce){.card{transition:none}}.bridge-version-badge{display:inline-block;padding:2px 9px;border-radius:999px;background:rgba(62, 110, 229, 0.10);color:#3e6ee5;font-size:12px;line-height:20px;font-weight:600}.dark .bridge-version-badge{color:#93b5ff}.bridge-comparison{overflow-x:auto;margin:1.25rem 0;border-radius:6px}.bridge-comparison table{display:table;min-width:720px;width:100%;overflow:visible;margin:0}.bridge-comparison:focus-visible{outline:2px solid #3e6ee5;outline-offset:3px}.bridge-ai-start{margin:1.75rem 0 2rem;padding:20px 24px;border:1px solid #cbd9f5;border-radius:14px;background:linear-gradient(135deg, #f0f5fe 0%, #fafcff 100%)}.bridge-ai-start .bridge-ai-eyebrow{margin:0 0 8px;color:#2f58c4;font-size:12px;font-weight:600;line-height:1.4}.bridge-ai-start h2{margin-top:0;margin-bottom:10px;font-size:1.5rem}.bridge-ai-start>p:last-child{margin-bottom:0;font-size:13px}.bridge-ai-providers{display:flex;flex-wrap:wrap;gap:8px;margin:14px 0}.bridge-ai-providers a{display:inline-flex;align-items:center;justify-content:space-between;gap:10px;min-height:44px;padding:9px 12px;border:1px solid #c7d5f0;border-radius:8px;background:#fff;color:#234cae;font-size:14px;font-weight:600;text-decoration:none}.bridge-ai-providers a:hover{border-color:#3e6ee5;background:#f7faff}.bridge-ai-providers a:focus-visible{outline:2px solid #3e6ee5;outline-offset:3px}.dark .bridge-ai-start{background:linear-gradient(135deg, #112441, #0f1b2e);border-color:#29446b}.dark .bridge-ai-start .bridge-ai-eyebrow{color:#b3caff}.dark .bridge-ai-providers a{background:#152640;color:#c1d4ff;border-color:#38537c}.dark .bridge-ai-providers a:hover{background:#1c3356;border-color:#93b5ff}@media (max-width: 640px){.bridge-ai-start{padding:18px}.bridge-ai-providers{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr))}.bridge-ai-providers a{font-size:13px}}#content-area a[id]:not([href]){scroll-margin-top:var(--scroll-mt, 9.5rem)}"}],"page":{"pagePath":"pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido","slug":"/pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido","pageMetadata":{"title":"Iniciar conversa de saída do LeadScout com um lead conhecido","description":"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido.\n\nUm contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha.\n\nforceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado.\n\nUma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto.\n\nConsulte [o guia completo de saída](/pt-br/guides/agent-outbound) para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound","href":"/pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Um contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"forceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Uma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Consulte \", _jsx(_components.a, {\n href: \"/pt-br/guides/agent-outbound\",\n children: \"o guia completo de saída\"\n }), \" para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Iniciar conversa de saída do LeadScout com um lead conhecido","description":"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido.\n\nUm contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha.\n\nforceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado.\n\nUma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto.\n\nConsulte [o guia completo de saída](/pt-br/guides/agent-outbound) para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound","href":"/pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["LeadScout API"],"summary":"Iniciar conversa de saída do LeadScout com um lead conhecido","description":"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido.\n\nUm contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha.\n\nforceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado.\n\nUma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto.\n\nConsulte [o guia completo de saída](/pt-br/guides/agent-outbound) para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.","operationId":"initiate_leadscout_outbound_bridge_api_v1_workspaces__workspaceId__leadscout_outbound_post","security":["84478d36-4c00-4f65-94e2-e6305daeb2dd"],"parameters":["486dcd31-01a2-45d8-86eb-7d2d70aaa8a6"],"requestBody":"5c0be583-e614-44b7-b302-fa64ca0ff130","responses":{"201":"40279c99-6b6c-4399-a872-b3e79b5669e5","400":"05edfec3-b7a4-4323-8f34-35f093959d61","404":"5f8c4140-0950-4da6-9b83-f88aa6514ac5","409":"a607221d-adc7-4af9-ac61-1fa989366a6c","422":"3156f97d-db56-4dcc-97ac-e2f6de09917f","429":"5240676e-105c-4f06-803f-21e693cf877f","500":"9a5a8729-3a90-4aa7-aca7-56e8311c7512"},"method":"post","type":"path","servers":["8174b49c-3516-4888-aacd-020349209c1b"],"path":"/bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound","baseUrlOptions":["https://api-connect-us.bridge.new"],"title":"Iniciar conversa de saída do LeadScout com um lead conhecido","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"486dcd31-01a2-45d8-86eb-7d2d70aaa8a6":{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Identificador único do workspace (UUID v4).","examples":["b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"],"title":"Workspaceid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Identificador único do workspace (UUID v4)."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"contact":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"Identificador do Contact conforme identifierType: ID do Contact para ID, e-mail para EMAIL ou telefone em formato E.164 para PHONE. O Contact já deve existir no workspace.","examples":["+573001234567"],"isRequired":true,"uniqueKey":"contact.identifier","typeLabel":"string"},"identifierType":{"type":"string","enum":["ID","EMAIL","PHONE"],"title":"Identifier Type","description":"Tipo de identificador.","examples":["PHONE","EMAIL","ID"],"isRequired":true,"uniqueKey":"contact.identifierType","typeLabel":"enum\u003cstring>"},"messageProviderType":{"type":"string","enum":["WHATSAPP","SMS","TELEGRAM","INSTAGRAM","TWITTER","LINE","FACEBOOK","IMESSAGE","WHATSAPP_TEST","HEYGIA"],"title":"Message Provider Type","description":"Provedor usado para entregar o modelo.","examples":["WHATSAPP"],"isRequired":true,"uniqueKey":"contact.messageProviderType","typeLabel":"enum\u003cstring>"},"providerChannelId":{"oneOf":[{"type":"string","title":"Provider Channel Identifier","description":"ID opcional de linha explícita de WhatsApp. Quando informado, essa linha é usada, deve pertencer ao workspace e resolver para um Agent de prospecção. Se omitido, as linhas elegíveis são selecionadas automaticamente: primeiro livres, depois liberadas recuperáveis e, apenas com forceSend=true, ocupadas. Quando informado, brandId limita os candidatos à marca. O ID da linha não é um número de telefone. Consulte [identificadores](/pt-br/guides/identifiers) e [seleção de saída](/pt-br/guides/agent-outbound).","example":"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c","uniqueKey":"contact.providerChannelId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Provider Channel Identifier","description":"ID opcional de linha explícita de WhatsApp. Quando informado, essa linha é usada, deve pertencer ao workspace e resolver para um Agent de prospecção. Se omitido, as linhas elegíveis são selecionadas automaticamente: primeiro livres, depois liberadas recuperáveis e, apenas com forceSend=true, ocupadas. Quando informado, brandId limita os candidatos à marca. O ID da linha não é um número de telefone. Consulte [identificadores](/pt-br/guides/identifiers) e [seleção de saída](/pt-br/guides/agent-outbound).","example":"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c","uniqueKey":"contact.providerChannelId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.providerChannelId","typeLabel":"string | null"}},"type":"object","required":["identifier","identifierType","messageProviderType"],"title":"Contact","description":"Lead ao qual esta conversa de saída é direcionada. Já deve existir no workspace.","isRequired":true,"uniqueKey":"contact","typeLabel":"Contact · object"},"template":{"properties":{"id":{"oneOf":[{"type":"string","title":"Template Identifier","description":"ID do modelo registrado (de GET /templates). Se id e name forem enviados, usa-se id.","example":"7e1d2c3b-4a5f-6e7d-8c9b-0a1b2c3d4e5f","uniqueKey":"template.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Template Identifier","description":"ID do modelo registrado (de GET /templates). Se id e name forem enviados, usa-se id.","example":"7e1d2c3b-4a5f-6e7d-8c9b-0a1b2c3d4e5f","uniqueKey":"template.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"template.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Template Name","description":"Nome do modelo registrado e aprovado pela Meta a ser enviado. Obrigatório quando id não é enviado; ignorado quando id é enviado.","example":"leadscout_outbound_fb_v1","uniqueKey":"template.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Template Name","description":"Nome do modelo registrado e aprovado pela Meta a ser enviado. Obrigatório quando id não é enviado; ignorado quando id é enviado.","example":"leadscout_outbound_fb_v1","uniqueKey":"template.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"template.name","typeLabel":"string | null"},"orderedParams":{"items":{"type":"string","uniqueKey":"template.orderedParams.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Ordered Parameters","description":"Valores fornecidos pelo cliente para os slots de parâmetros do modelo com origem CALLER, em ordem de posição.","examples":[["Maria","ACME"]],"uniqueKey":"template.orderedParams","typeLabel":"string[]"},"parameters":{"additionalProperties":{"type":"string","uniqueKey":"template.parameters.additionalProperties","typeLabel":"string"},"type":"object","title":"Parameters","description":"Valores fornecidos pelo cliente e indexados pela chave de variável do modelo (consulte GET /templates/{id} para obter as chaves), tanto para o corpo como para os botões. Prefira esta opção a orderedParams se o modelo tiver um botão dinâmico. Uma chave desconhecida ou que se sobreponha a um slot já coberto por orderedParams é rejeitada com 422.","examples":[{"recipient_first_name":"Maria","tracking_code":"TRK123"}],"uniqueKey":"template.parameters","typeLabel":"Parameters · object"},"media":{"oneOf":[{"type":"object","title":"OutboundTemplateMedia","description":"Mídia opcional de cabeçalho anexada à mensagem do modelo inicial.\n\nForneça exatamente um: ``mediaId`` (UUID retornado por ``POST /bridge/api/v1/workspaces/{workspaceId}/files``) ou ``url`` (URL pública de origem obtida de forma assíncrona pelo serviço de download por URL).","required":["type"],"properties":{"type":{"type":"string","enum":["IMAGE","VIDEO","GIF"],"title":"Media Type","description":"Tipo de mídia do cabeçalho. Deve corresponder ao tipo configurado para o modelo na Meta.","examples":["IMAGE","VIDEO"],"isRequired":true,"uniqueKey":"template.media.oneOf.0.type","typeLabel":"enum\u003cstring>"},"mediaId":{"oneOf":[{"type":"string","title":"Media Identifier","description":"UUID retornado por POST /bridge/api/v1/workspaces/{workspaceId}/files. Mutuamente exclusivo com url.","example":null,"uniqueKey":"template.media.oneOf.0.mediaId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Media Identifier","description":"UUID retornado por POST /bridge/api/v1/workspaces/{workspaceId}/files. Mutuamente exclusivo com url.","example":null,"uniqueKey":"template.media.oneOf.0.mediaId.oneOf.1","typeLabel":"null"}],"uniqueKey":"template.media.oneOf.0.mediaId","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","title":"Source URL","description":"URL pública de origem obtida de forma assíncrona pelo serviço de download de arquivos por URL. Mutuamente exclusiva com mediaId.","example":null,"uniqueKey":"template.media.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Source URL","description":"URL pública de origem obtida de forma assíncrona pelo serviço de download de arquivos por URL. Mutuamente exclusiva com mediaId.","example":null,"uniqueKey":"template.media.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"template.media.oneOf.0.url","typeLabel":"string | null"}},"uniqueKey":"template.media.oneOf.0","typeLabel":"OutboundTemplateMedia · object"},{"type":"null","title":"Header Media","description":"Mídia opcional de cabeçalho (imagem ou vídeo) a anexar à mensagem do modelo. Aceita um mediaId pré-carregado ou uma url pública.","uniqueKey":"template.media.oneOf.1","typeLabel":"null"}],"uniqueKey":"template.media","typeLabel":"OutboundTemplateMedia · object | null"}},"type":"object","title":"Template","description":"Modelo inicial a ser enviado.","isRequired":true,"uniqueKey":"template","typeLabel":"Template · object"},"additionalMessages":{"items":{"properties":{"messageBody":{"type":"string","title":"Message Body","description":"Corpo em texto simples da mensagem de acompanhamento.","examples":["Just confirming we're still on for tomorrow at 10am."],"isRequired":true,"uniqueKey":"additionalMessages.items.[INDEX].messageBody","typeLabel":"string"},"mediaIds":{"items":{"type":"string","uniqueKey":"additionalMessages.items.[INDEX].mediaIds.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Media Identifiers","description":"O esquema da solicitação aceita o campo, mas o fluxo de saída compartilhado atual armazena os acompanhamentos apenas como texto e não anexa estes IDs de mídia. Para mídia do modelo inicial, use template.media; para uma mensagem de anexo separada, siga o fluxo de anexos de Message.","examples":[[],["7e1d2c3b-4a5f-6e7d-8c9b-0a1b2c3d4e5f"]],"uniqueKey":"additionalMessages.items.[INDEX].mediaIds","typeLabel":"string[]"}},"type":"object","required":["messageBody"],"title":"OutboundFollowUpRequest","description":"Mensagem de acompanhamento pré-carregada armazenada na conversa junto ao modelo inicial.","uniqueKey":"additionalMessages.items.[INDEX]","typeLabel":"OutboundFollowUpRequest · object"},"type":"array","maxItems":5,"title":"Additional Messages","description":"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.","uniqueKey":"additionalMessages","typeLabel":"OutboundFollowUpRequest · object[]"},"agentContext":{"oneOf":[{"type":"object","title":"OutboundAgentContextRequest","description":"Notas e mídias armazenadas na conversa como contexto do agente para revisão por IA ou uma pessoa.","properties":{"notes":{"oneOf":[{"type":"string","title":"Notes","description":"Notas em texto livre para o agente, limitadas a 2000 caracteres.","maxLength":2000,"example":"Lead asked about pricing tiers last week.","uniqueKey":"agentContext.oneOf.0.notes.oneOf.0","typeLabel":"string"},{"type":"null","title":"Notes","description":"Notas em texto livre para o agente, limitadas a 2000 caracteres.","example":"Lead asked about pricing tiers last week.","uniqueKey":"agentContext.oneOf.0.notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentContext.oneOf.0.notes","typeLabel":"string | null"},"mediaIds":{"items":{"type":"string","uniqueKey":"agentContext.oneOf.0.mediaIds.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Media Identifiers","description":"Identificadores opcionais de arquivos pré-carregados armazenados na conversa como contexto do agente.","examples":[[],["7e1d2c3b-4a5f-6e7d-8c9b-0a1b2c3d4e5f"]],"uniqueKey":"agentContext.oneOf.0.mediaIds","typeLabel":"string[]"}},"uniqueKey":"agentContext.oneOf.0","typeLabel":"OutboundAgentContextRequest · object"},{"type":"null","title":"Agent Context","description":"Notas e mídias opcionais armazenadas na conversa como contexto para o agente.","uniqueKey":"agentContext.oneOf.1","typeLabel":"null"}],"uniqueKey":"agentContext","typeLabel":"OutboundAgentContextRequest · object | null"},"consent":{"oneOf":[{"type":"object","title":"OutboundConsentRequest","description":"Evidência de consentimento declarada pela empresa e registrada sem modificações na conversa.","required":["status"],"properties":{"status":{"type":"string","enum":["GRANTED","NOT_PROVIDED"],"title":"Status","description":"Estado de consentimento declarado pela empresa. Use GRANTED (com capturedAt) para consentimento explícito ou NOT_PROVIDED quando a empresa não tiver evidências a declarar.","examples":["GRANTED","NOT_PROVIDED"],"isRequired":true,"uniqueKey":"consent.oneOf.0.status","typeLabel":"enum\u003cstring>"},"capturedAt":{"oneOf":[{"type":"string","title":"Captured At","description":"Data e hora ISO8601 (com milissegundos) em que a empresa obteve o consentimento. Obrigatório com status=GRANTED; null ou omissão são aceitos com status=NOT_PROVIDED.","format":"date-time","example":"2026-04-20T10:00:00.000Z","uniqueKey":"consent.oneOf.0.capturedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Captured At","description":"Data e hora ISO8601 (com milissegundos) em que a empresa obteve o consentimento. Obrigatório com status=GRANTED; null ou omissão são aceitos com status=NOT_PROVIDED.","example":"2026-04-20T10:00:00.000Z","uniqueKey":"consent.oneOf.0.capturedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"consent.oneOf.0.capturedAt","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"consent.oneOf.0","typeLabel":"OutboundConsentRequest · object"},{"type":"null","title":"Consent","description":"Evidência opcional de consentimento, declarada pela empresa, registrada na conversa.","uniqueKey":"consent.oneOf.1","typeLabel":"null"}],"uniqueKey":"consent","typeLabel":"OutboundConsentRequest · object | null"},"handoffOverride":{"oneOf":[{"type":"object","title":"LeadscoutOutboundHandoffOverride","description":"Substitui a atribuição padrão do consultor da conversa de saída.","required":["preAssignedUser"],"properties":{"preAssignedUser":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"Valor que identifica o usuário interno, interpretado conforme identifier_type.","examples":["advisor@acme.com","usr_01HZ2K3J4M5N6P7Q8R9S0T1UV2"],"isRequired":true,"uniqueKey":"handoffOverride.oneOf.0.preAssignedUser.identifier","typeLabel":"string"},"identifierType":{"type":"string","enum":["ID","EMAIL"],"title":"Identifier Type","description":"Como resolver o identificador. ID busca pelo ID do usuário interno; EMAIL busca pelo e-mail.","examples":["EMAIL","ID"],"isRequired":true,"uniqueKey":"handoffOverride.oneOf.0.preAssignedUser.identifierType","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"type":"object","required":["identifier","identifierType"],"title":"Pre-assigned User","description":"Usuário interno a ser atribuído como consultor quando a IA transferir a conversa. Validado durante a solicitação: se o usuário não existir, estiver inativo ou pertencer a outro workspace, a solicitação será rejeitada antes de criar uma conversa.","examples":[{"identifier":"advisor@acme.com","identifierType":"EMAIL"}],"isRequired":true,"uniqueKey":"handoffOverride.oneOf.0.preAssignedUser","typeLabel":"Pre-assigned User · object"}},"additionalProperties":false,"uniqueKey":"handoffOverride.oneOf.0","typeLabel":"LeadscoutOutboundHandoffOverride · object"},{"type":"null","title":"Handoff Override","description":"Opção para pré-atribuir um usuário interno específico como consultor da transferência. Validada durante a solicitação; em caso de falha, a criação da conversa é cancelada.","uniqueKey":"handoffOverride.oneOf.1","typeLabel":"null"}],"uniqueKey":"handoffOverride","typeLabel":"LeadscoutOutboundHandoffOverride · object | null"},"brandId":{"oneOf":[{"type":"string","title":"Brand Identifier","description":"ID opcional da marca. Quando informado, apenas os canais vinculados a ela são elegíveis. Omita para considerar todos os canais do workspace.","example":null,"uniqueKey":"brandId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Brand Identifier","description":"ID opcional da marca. Quando informado, apenas os canais vinculados a ela são elegíveis. Omita para considerar todos os canais do workspace.","example":null,"uniqueKey":"brandId.oneOf.1","typeLabel":"null"}],"uniqueKey":"brandId","typeLabel":"string | null"},"campaignId":{"oneOf":[{"type":"string","title":"Campaign Identifier","description":"Referência opcional de campanha armazenada na conversa para auditoria e relatórios.","example":null,"uniqueKey":"campaignId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Campaign Identifier","description":"Referência opcional de campanha armazenada na conversa para auditoria e relatórios.","example":null,"uniqueKey":"campaignId.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaignId","typeLabel":"string | null"},"forceSend":{"type":"boolean","title":"Force Send","description":"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](/pt-br/guides/agent-outbound).","default":false,"examples":[false,true],"uniqueKey":"forceSend","typeLabel":"boolean"}},"type":"object","required":["contact","template"],"title":"LeadscoutOutboundRequest","description":"Corpo da solicitação para iniciar uma conversa de saída do LeadScout.","uniqueKey":"","typeLabel":"LeadscoutOutboundRequest · object"},"examples":{"Example":{"title":"Example","value":{"contact":{"identifier":"+573001234567","identifierType":"PHONE","messageProviderType":"WHATSAPP","providerChannelId":"c4f2a1e0-9b8d-4e7c-a6f5-1d2e3f4a5b6c"},"template":{"id":"7e1d2c3b-4a5f-6e7d-8c9b-0a1b2c3d4e5f","name":"leadscout_outbound_fb_v1","orderedParams":["Maria","ACME"],"parameters":{"recipient_first_name":"Maria","tracking_code":"TRK123"},"media":{"type":"IMAGE","mediaId":null,"url":null}},"additionalMessages":[{"messageBody":"Just confirming we're still on for tomorrow at 10am.","mediaIds":[]}],"agentContext":{"notes":"Lead asked about pricing tiers last week.","mediaIds":[]},"consent":{"status":"GRANTED","capturedAt":"2026-04-20T10:00:00.000Z"},"handoffOverride":{"preAssignedUser":{"identifier":"advisor@acme.com","identifierType":"EMAIL"}},"brandId":null,"campaignId":null,"forceSend":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"40279c99-6b6c-4399-a872-b3e79b5669e5":{"description":"Resposta bem-sucedida","content":{"application/json":{"schema":{"properties":{"conversation":{"properties":{"id":{"type":"string","title":"Identifier","description":"Identificador único da conversa (UUID v4).","examples":["b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"],"isRequired":true,"uniqueKey":"conversation.id","typeLabel":"string"},"workspaceId":{"type":"string","title":"Workspace Identifier","description":"Identificador único do workspace (UUID v4).","examples":["b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"],"isRequired":true,"uniqueKey":"conversation.workspaceId","typeLabel":"string"},"participants":{"properties":{"externals":{"items":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"Valor do identificador do participante.","examples":["ef7ee722-5f95-415a-9a98-81eeae178b11"],"isRequired":true,"uniqueKey":"conversation.participants.externals.items.[INDEX].identifier","typeLabel":"string"},"identifierType":{"type":"string","enum":["ID","EMAIL","PHONE"],"title":"Identifier Type","description":"Tipo de identificador de participantes externos (ID, EMAIL ou PHONE).","examples":["EMAIL","PHONE","ID"],"isRequired":true,"uniqueKey":"conversation.participants.externals.items.[INDEX].identifierType","typeLabel":"enum\u003cstring>"},"role":{"type":"string","enum":["INTERNAL","EXTERNAL","BOT"],"title":"Role","description":"Papel do participante na conversa.","examples":["EXTERNAL","INTERNAL"],"isRequired":true,"uniqueKey":"conversation.participants.externals.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"joinedAt":{"type":"string","format":"date-time","title":"Joined At","description":"Data e hora em que o participante entrou na conversa.","examples":["2004-04-10T09:00:00.000Z"],"isRequired":true,"uniqueKey":"conversation.participants.externals.items.[INDEX].joinedAt","typeLabel":"string\u003cdate-time>"},"lastSeenAt":{"oneOf":[{"type":"string","title":"Last Seen At","description":"Data e hora da última atividade observada do participante.","format":"date-time","example":null,"uniqueKey":"conversation.participants.externals.items.[INDEX].lastSeenAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Seen At","description":"Data e hora da última atividade observada do participante.","example":null,"uniqueKey":"conversation.participants.externals.items.[INDEX].lastSeenAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.participants.externals.items.[INDEX].lastSeenAt","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["identifier","identifierType","role","joinedAt"],"title":"Participant","description":"Objeto que representa o participante externo da conversa.","uniqueKey":"conversation.participants.externals.items.[INDEX]","typeLabel":"Participant · object"},"type":"array","title":"Externals","description":"Lista de participantes externos.","isRequired":true,"uniqueKey":"conversation.participants.externals","typeLabel":"Participant · object[]"},"internals":{"items":{"properties":{"identifier":{"type":"string","title":"Identifier","description":"Valor do identificador do participante.","examples":["ef7ee722-5f95-415a-9a98-81eeae178b11"],"isRequired":true,"uniqueKey":"conversation.participants.internals.items.[INDEX].identifier","typeLabel":"string"},"identifierType":{"type":"string","enum":["ID","EMAIL"],"title":"Identifier Type","description":"Tipo de identificador de participantes internos (ID ou EMAIL).","examples":["EMAIL","ID"],"isRequired":true,"uniqueKey":"conversation.participants.internals.items.[INDEX].identifierType","typeLabel":"enum\u003cstring>"},"role":{"type":"string","enum":["INTERNAL","EXTERNAL","BOT"],"title":"Role","description":"Papel do participante na conversa.","examples":["EXTERNAL","INTERNAL"],"isRequired":true,"uniqueKey":"conversation.participants.internals.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"joinedAt":{"type":"string","format":"date-time","title":"Joined At","description":"Data e hora em que o participante entrou na conversa.","examples":["2004-04-10T09:00:00.000Z"],"isRequired":true,"uniqueKey":"conversation.participants.internals.items.[INDEX].joinedAt","typeLabel":"string\u003cdate-time>"},"lastSeenAt":{"oneOf":[{"type":"string","title":"Last Seen At","description":"Data e hora da última atividade observada do participante.","format":"date-time","example":null,"uniqueKey":"conversation.participants.internals.items.[INDEX].lastSeenAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Last Seen At","description":"Data e hora da última atividade observada do participante.","example":null,"uniqueKey":"conversation.participants.internals.items.[INDEX].lastSeenAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.participants.internals.items.[INDEX].lastSeenAt","typeLabel":"string\u003cdate-time> | null"}},"type":"object","required":["identifier","identifierType","role","joinedAt"],"title":"Participant","description":"Objeto que representa o participante interno da conversa.","uniqueKey":"conversation.participants.internals.items.[INDEX]","typeLabel":"Participant · object"},"type":"array","title":"Internals","description":"Lista de participantes internos.","isRequired":true,"uniqueKey":"conversation.participants.internals","typeLabel":"Participant · object[]"}},"type":"object","required":["externals","internals"],"title":"Participants","description":"Participantes da conversa.","isRequired":true,"uniqueKey":"conversation.participants","typeLabel":"Participants · object"},"createdAt":{"type":"string","format":"date-time","title":"Created At","description":"Data e hora de criação da conversa.","examples":["2003-04-10T09:00:00.000Z"],"isRequired":true,"uniqueKey":"conversation.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","title":"Updated At","description":"Data e hora da última atualização da conversa.","examples":["2003-04-10T09:00:00.000Z"],"isRequired":true,"uniqueKey":"conversation.updatedAt","typeLabel":"string\u003cdate-time>"},"name":{"oneOf":[{"type":"string","title":"Name","description":"Nome ou título opcional da conversa.","example":"Bridge Support Team","uniqueKey":"conversation.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Nome ou título opcional da conversa.","example":"Bridge Support Team","uniqueKey":"conversation.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.name","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","title":"ConversationStatus","description":"Status atual da conversa: 'ACTIVE' para conversas visíveis e 'GHOST' para conversas invisíveis até a primeira interação.","enum":["ACTIVE","GHOST","RELEASED","NOT_ASSIGNED_TO_HUMAN","BLOCKED"],"example":"ACTIVE","uniqueKey":"conversation.status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Status","description":"Status atual da conversa: 'ACTIVE' para conversas visíveis e 'GHOST' para conversas invisíveis até a primeira interação.","example":"ACTIVE","uniqueKey":"conversation.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"conversation.status","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["id","workspaceId","participants","createdAt","updatedAt"],"title":"Conversation","description":"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.","isRequired":true,"uniqueKey":"conversation","typeLabel":"Conversation · object"},"contact":{"properties":{"id":{"type":"string","title":"Identifier","description":"Identificador único do contato (UUID v4).","examples":["b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"],"isRequired":true,"uniqueKey":"contact.id","typeLabel":"string"},"workspaceId":{"type":"string","title":"Workspace Identifier","description":"Identificador único do workspace ao qual este contato pertence","examples":["92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5"],"isRequired":true,"uniqueKey":"contact.workspaceId","typeLabel":"string"},"type":{"type":"string","enum":["PARTIAL","NORMAL"],"title":"Contact Type","description":"NORMAL quando todos os campos obrigatórios de identidade e atributos personalizados estão presentes; PARTIAL caso contrário.","examples":["NORMAL","PARTIAL"],"isRequired":true,"uniqueKey":"contact.type","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","title":"Created At","description":"Data e hora de criação do contato.","examples":["2003-04-10T08:00:00.000Z"],"isRequired":true,"uniqueKey":"contact.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","title":"Updated At","description":"Data e hora da última atualização do contato.","examples":["2003-04-10T08:00:00.000Z"],"isRequired":true,"uniqueKey":"contact.updatedAt","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","title":"First Name","description":"Nome do contato.","example":"John","uniqueKey":"contact.firstName.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"Nome do contato.","example":"John","uniqueKey":"contact.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","title":"Last Name","description":"Sobrenome do contato.","example":"Doe","uniqueKey":"contact.lastName.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"Sobrenome do contato.","example":"Doe","uniqueKey":"contact.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.lastName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","description":"E-mail do contato.","format":"email","example":"john.doe@example.com","uniqueKey":"contact.email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Email","description":"E-mail do contato.","example":"john.doe@example.com","uniqueKey":"contact.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.email","typeLabel":"string\u003cemail> | null"},"cellphone":{"oneOf":[{"type":"string","title":"Cellphone","description":"Número de celular do contato.","format":"phone","example":"+14084029292","uniqueKey":"contact.cellphone.oneOf.0","typeLabel":"string\u003cphone>"},{"type":"null","title":"Cellphone","description":"Número de celular do contato.","example":"+14084029292","uniqueKey":"contact.cellphone.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.cellphone","typeLabel":"string\u003cphone> | null"},"customAttributes":{"items":{"properties":{"key":{"type":"string","title":"Key","description":"Chave ou nome do atributo","isRequired":true,"uniqueKey":"contact.customAttributes.items.[INDEX].key","typeLabel":"string"},"values":{"items":{"type":"string","uniqueKey":"contact.customAttributes.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Values","description":"Valor do atributo","uniqueKey":"contact.customAttributes.items.[INDEX].values","typeLabel":"string[]"}},"type":"object","required":["key"],"title":"CustomAttributeResponse","description":"Corpo da resposta para atributos personalizados em operações com contatos.","uniqueKey":"contact.customAttributes.items.[INDEX]","typeLabel":"CustomAttributeResponse · object"},"type":"array","title":"Custom Attributes","description":"Lista de atributos personalizados de chave e valor.","uniqueKey":"contact.customAttributes","typeLabel":"CustomAttributeResponse · object[]"},"languageCode":{"oneOf":[{"type":"string","title":"LanguageCode","description":"Código de idioma do usuário externo.","enum":["ES","EN","AF","SQ","AR","AZ","BN","BG","CA","ZH_CN","HR","CS","DA","NL","ET","FIL","FI","FR","KA","DE","EL","GU","HA","HE","HI","HU","ID","GA","IT","JA","KN","KK","RW_RW","KO","KY_KG","LO","LV","LT","MK","MS","ML","MR","NB","FA","PL","PT_BR","PA","RO","RU","SR","SK","SL","SW","SV","TA","TE","TH","TR","UK","UR","UZ","VI","ZU"],"example":"EN","uniqueKey":"contact.languageCode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Language Code","description":"Código de idioma do usuário externo.","example":"EN","uniqueKey":"contact.languageCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.languageCode","typeLabel":"enum\u003cstring> | null"},"ownerId":{"oneOf":[{"type":"string","title":"Owner Identifier","description":"ID do Bridge User proprietário do contato. Resolva-o com `GET /users/{userId}`.","example":"37673840-6259-40f9-bbe5-a7db40f8e3cf","uniqueKey":"contact.ownerId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Owner Identifier","description":"ID do Bridge User proprietário do contato. Resolva-o com `GET /users/{userId}`.","example":"37673840-6259-40f9-bbe5-a7db40f8e3cf","uniqueKey":"contact.ownerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.ownerId","typeLabel":"string | null"}},"type":"object","required":["id","workspaceId","type","createdAt","updatedAt"],"title":"Contact","description":"Contato com o qual a conversa foi iniciada.","isRequired":true,"uniqueKey":"contact","typeLabel":"Contact · object"},"templateSent":{"oneOf":[{"type":"object","title":"LeadscoutTemplateSent","description":"Resumo do modelo despachado para abrir a conversa.","required":["name"],"properties":{"name":{"type":"string","title":"Template Name","description":"Nome do modelo despachado.","examples":["leadscout_outbound_fb_v1"],"isRequired":true,"uniqueKey":"templateSent.oneOf.0.name","typeLabel":"string"},"id":{"oneOf":[{"type":"string","title":"Template Identifier","description":"ID do modelo enviado.","example":"7e1d2c3b-4a5f-6e7d-8c9b-0a1b2c3d4e5f","uniqueKey":"templateSent.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Template Identifier","description":"ID do modelo enviado.","example":"7e1d2c3b-4a5f-6e7d-8c9b-0a1b2c3d4e5f","uniqueKey":"templateSent.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateSent.oneOf.0.id","typeLabel":"string | null"},"messageId":{"oneOf":[{"type":"string","title":"Message Identifier","description":"wamid da Meta do modelo despachado. É null no fluxo bem-sucedido até que o processo de envio retorne o wamid à API de entrada.","example":null,"uniqueKey":"templateSent.oneOf.0.messageId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Message Identifier","description":"wamid da Meta do modelo despachado. É null no fluxo bem-sucedido até que o processo de envio retorne o wamid à API de entrada.","example":null,"uniqueKey":"templateSent.oneOf.0.messageId.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateSent.oneOf.0.messageId","typeLabel":"string | null"}},"uniqueKey":"templateSent.oneOf.0","typeLabel":"LeadscoutTemplateSent · object"},{"type":"null","title":"Template Sent","description":"Resumo do modelo despachado.","uniqueKey":"templateSent.oneOf.1","typeLabel":"null"}],"uniqueKey":"templateSent","typeLabel":"LeadscoutTemplateSent · object | null"},"additionalMessagesPersisted":{"type":"integer","title":"Additional Messages Persisted","description":"Número de mensagens de acompanhamento armazenadas na conversa.","default":0,"examples":[0,3],"uniqueKey":"additionalMessagesPersisted","typeLabel":"integer"},"alreadyInitiated":{"type":"boolean","title":"Already Initiated","description":"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.","default":false,"examples":[false,true],"uniqueKey":"alreadyInitiated","typeLabel":"boolean"},"recovered":{"type":"boolean","title":"Recovered","description":"True quando esta solicitação recuperou uma conversa liberada que o contato tinha no canal escolhido, em vez de criar outra.","default":false,"examples":[false,true],"uniqueKey":"recovered","typeLabel":"boolean"}},"type":"object","required":["conversation","contact"],"title":"LeadscoutOutboundResponse","description":"Corpo da resposta de uma iniciação de saída bem-sucedida do LeadScout.","uniqueKey":"","typeLabel":"LeadscoutOutboundResponse · object"},"examples":{"Example":{"title":"Example","value":{"conversation":{"id":"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234","workspaceId":"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234","participants":{"externals":[{"identifier":"ef7ee722-5f95-415a-9a98-81eeae178b11","identifierType":"EMAIL","role":"EXTERNAL","joinedAt":"2004-04-10T09:00:00.000Z","lastSeenAt":null}],"internals":[{"identifier":"ef7ee722-5f95-415a-9a98-81eeae178b11","identifierType":"EMAIL","role":"EXTERNAL","joinedAt":"2004-04-10T09:00:00.000Z","lastSeenAt":null}]},"createdAt":"2003-04-10T09:00:00.000Z","updatedAt":"2003-04-10T09:00:00.000Z","name":"Bridge Support Team","status":"ACTIVE"},"contact":{"id":"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234","workspaceId":"92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5","type":"NORMAL","createdAt":"2003-04-10T08:00:00.000Z","updatedAt":"2003-04-10T08:00:00.000Z","firstName":"John","lastName":"Doe","email":"john.doe@example.com","cellphone":"+14084029292","customAttributes":[{"key":"\u003cstring>","values":["\u003cstring>"]}],"languageCode":"EN","ownerId":"37673840-6259-40f9-bbe5-a7db40f8e3cf"},"templateSent":{"name":"leadscout_outbound_fb_v1","id":"7e1d2c3b-4a5f-6e7d-8c9b-0a1b2c3d4e5f","messageId":null},"additionalMessagesPersisted":0,"alreadyInitiated":false,"recovered":false}}},"exampleType":"generated"}},"exampleType":"generated"},"05edfec3-b7a4-4323-8f34-35f093959d61":{"description":"Solicitação inválida","content":{"application/json":{"examples":{"OUTBOUND_VALIDATION_ERROR":{"title":"OUTBOUND_VALIDATION_ERROR","value":{"title":"Outbound Validation Error","status":400,"code":"BRIDGE_AI_LEADSCOUT_0016"}},"TEMPLATE_ORDERED_PARAMS_MISMATCH":{"title":"TEMPLATE_ORDERED_PARAMS_MISMATCH","value":{"title":"Template Params Mismatch","status":400,"code":"BRIDGE_AI_LEADSCOUT_0006"}}},"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Resumo breve do tipo de problema.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Código de status HTTP gerado pelo servidor de origem para esta ocorrência do problema.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Informações adicionais sobre o problema.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Informações adicionais sobre o problema.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Objeto que representa o corpo de uma resposta Problem.","uniqueKey":"","typeLabel":"Problem · object"},"exampleType":"examples"}},"exampleType":"examples"},"5f8c4140-0950-4da6-9b83-f88aa6514ac5":{"description":"Não encontrado","content":{"application/json":{"examples":{"EXTERNAL_USER_NOT_FOUND":{"title":"EXTERNAL_USER_NOT_FOUND","value":{"title":"External User Not Found","status":404,"code":"BRIDGE_AI_LEADSCOUT_0001"}},"INTERNAL_USER_NOT_FOUND":{"title":"INTERNAL_USER_NOT_FOUND","value":{"title":"Internal User Not Found","status":404,"code":"BRIDGE_AI_LEADSCOUT_0002"}},"TEMPLATE_NOT_FOUND":{"title":"TEMPLATE_NOT_FOUND","value":{"title":"Template Not Found","status":404,"code":"BRIDGE_AI_LEADSCOUT_0004"}},"NO_CHANNELS_FOR_BRAND":{"title":"NO_CHANNELS_FOR_BRAND","value":{"title":"No Channels For Brand","status":404,"code":"BRIDGE_AI_LEADSCOUT_0009"}},"PROVIDER_CHANNEL_NOT_IN_WORKSPACE":{"title":"PROVIDER_CHANNEL_NOT_IN_WORKSPACE","value":{"title":"Channel Not In Workspace","status":404,"code":"BRIDGE_AI_LEADSCOUT_0010"}},"WORKSPACE_HAS_NO_PROVIDER_CHANNELS":{"title":"WORKSPACE_HAS_NO_PROVIDER_CHANNELS","value":{"title":"No Provider Channels","status":404,"code":"BRIDGE_AI_LEADSCOUT_0011"}},"NO_PROSPECTING_AGENT_FOR_CHANNEL":{"title":"NO_PROSPECTING_AGENT_FOR_CHANNEL","value":{"title":"No Agent For Channel","status":404,"code":"BRIDGE_AI_LEADSCOUT_0012"}}},"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Resumo breve do tipo de problema.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Código de status HTTP gerado pelo servidor de origem para esta ocorrência do problema.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Informações adicionais sobre o problema.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Informações adicionais sobre o problema.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Objeto que representa o corpo de uma resposta Problem.","uniqueKey":"","typeLabel":"Problem · object"},"exampleType":"examples"}},"exampleType":"examples"},"a607221d-adc7-4af9-ac61-1fa989366a6c":{"description":"Conflito","content":{"application/json":{"examples":{"INTERNAL_USER_DELETED":{"title":"INTERNAL_USER_DELETED","value":{"title":"Internal User Deleted","status":409,"code":"BRIDGE_AI_LEADSCOUT_0003"}},"TEMPLATE_NOT_APPROVED":{"title":"TEMPLATE_NOT_APPROVED","value":{"title":"Template Not Approved","status":409,"code":"BRIDGE_AI_LEADSCOUT_0005"}},"ACTIVE_CONVERSATION_ALREADY_EXISTS":{"title":"ACTIVE_CONVERSATION_ALREADY_EXISTS","value":{"title":"Active Conversation Exists","status":409,"code":"BRIDGE_AI_LEADSCOUT_0007"}},"ALL_PROVIDER_CHANNELS_OCCUPIED":{"title":"ALL_PROVIDER_CHANNELS_OCCUPIED","value":{"title":"All Channels Occupied","status":409,"code":"BRIDGE_AI_LEADSCOUT_0008"}},"MULTIPLE_PROSPECTING_AGENTS_FOR_BRAND":{"title":"MULTIPLE_PROSPECTING_AGENTS_FOR_BRAND","value":{"title":"Multiple Agents For Brand","status":409,"code":"BRIDGE_AI_LEADSCOUT_0013"}},"MULTIPLE_PROSPECTING_AGENTS_FOR_CHANNEL":{"title":"MULTIPLE_PROSPECTING_AGENTS_FOR_CHANNEL","value":{"title":"Multiple Agents For Channel","status":409,"code":"BRIDGE_AI_LEADSCOUT_0014"}}},"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Resumo breve do tipo de problema.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Código de status HTTP gerado pelo servidor de origem para esta ocorrência do problema.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Informações adicionais sobre o problema.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Informações adicionais sobre o problema.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Objeto que representa o corpo de uma resposta Problem.","uniqueKey":"","typeLabel":"Problem · object"},"exampleType":"examples"}},"exampleType":"examples"},"3156f97d-db56-4dcc-97ac-e2f6de09917f":{"description":"Conteúdo não processável","content":{"application/json":{"examples":{"MISSING_TEMPLATE_VARIABLES":{"title":"MISSING_TEMPLATE_VARIABLES","value":{"title":"Missing Template Variables","status":422,"code":"BRIDGE_AI_LEADSCOUT_0019"}},"CONFLICTING_TEMPLATE_PARAMETERS":{"title":"CONFLICTING_TEMPLATE_PARAMETERS","value":{"title":"Conflicting Template Parameters","status":422,"code":"BRIDGE_AI_LEADSCOUT_0020"}},"UNKNOWN_TEMPLATE_PARAMETER_KEY":{"title":"UNKNOWN_TEMPLATE_PARAMETER_KEY","value":{"title":"Unknown Template Parameter Key","status":422,"code":"BRIDGE_AI_LEADSCOUT_0021"}}},"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Resumo breve do tipo de problema.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Código de status HTTP gerado pelo servidor de origem para esta ocorrência do problema.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Informações adicionais sobre o problema.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Informações adicionais sobre o problema.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Objeto que representa o corpo de uma resposta Problem.","uniqueKey":"","typeLabel":"Problem · object"},"exampleType":"examples"}},"exampleType":"examples"},"5240676e-105c-4f06-803f-21e693cf877f":{"description":"Muitas solicitações","content":{"application/json":{"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Resumo breve do tipo de problema.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Código de status HTTP gerado pelo servidor de origem para esta ocorrência do problema.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Informações adicionais sobre o problema.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Informações adicionais sobre o problema.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Objeto que representa o corpo de uma resposta Problem.","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"WORKSPACE_BUDGET_EXHAUSTED":{"title":"WORKSPACE_BUDGET_EXHAUSTED","value":{"title":"Too Many Requests","status":429,"code":"BRIDGE_RATE_LIMIT_0001"}}},"exampleType":"examples"}},"exampleType":"examples"},"9a5a8729-3a90-4aa7-aca7-56e8311c7512":{"description":"Erro interno do servidor","content":{"application/json":{"examples":{"CONVERSATION_OPERATION_FAILED":{"title":"CONVERSATION_OPERATION_FAILED","value":{"title":"Conversation Operation Failed","status":500,"code":"BRIDGE_AI_LEADSCOUT_0015"}}},"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Resumo breve do tipo de problema.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"Código de status HTTP gerado pelo servidor de origem para esta ocorrência do problema.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explicação específica desta ocorrência do problema.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"Referência URI que identifica esta ocorrência do problema.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"ID de rastreamento para depuração.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Código para identificar o erro; consulte a página de códigos de erro para mais detalhes.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"Lista de detalhes dos erros.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Informações adicionais sobre o problema.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Informações adicionais sobre o problema.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Objeto que representa o corpo de uma resposta Problem.","uniqueKey":"","typeLabel":"Problem · object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"84478d36-4c00-4f65-94e2-e6305daeb2dd":{"x-api-key":{"type":"apiKey","description":"Copy the API key as provided by the Bridge Console.","in":"header","name":"x-api-key","scopes":[],"schemeName":"x-api-key"}}},"servers":{"8174b49c-3516-4888-aacd-020349209c1b":{"url":"https://api-connect-us.bridge.new","description":"Servidor de produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Copy the API key as provided by the Bridge Console.","in":"header","name":"x-api-key","scopes":[],"schemeName":"x-api-key"},"schema":{"title":"x-api-key","type":"string","description":"Copy the API key as provided by the Bridge Console.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-api-key","name":"x-api-key"}],"title":"x-api-key"}]},"originalFileLocation":"pt-br/api-reference/openapi.yaml"},"subdomain":"sainapsisinc","siteName":"Bridge REST Integrations API \u0026 Webhooks","title":"Iniciar conversa de saída do LeadScout com um lead conhecido - Bridge REST Integrations API \u0026 Webhooks","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/","matchLevel":4},"es":{"href":"/es","matchLevel":4},"pt-BR":{"href":"/pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido","matchLevel":0}}},"lastModified":"2026-11-14T14:03:18.481Z","originalFileLocation":"pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido.mdx","locale":"pt-BR"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido. Um contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha. forceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado. Uma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto. Consulte o guia completo de saída para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Iniciar conversa de saída do LeadScout com um lead conhecido - Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head property=\"og:description\" content=\"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido. Um contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha. forceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado. Uma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto. Consulte o guia completo de saída para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sainapsisinc.mintlify.site/_mintlify/api/og/v2?division=LeadScout+API\u0026amp;title=Iniciar+conversa+de+sa%C3%ADda+do+LeadScout+com+um+lead+conhecido\u0026amp;description=Inicia+uma+conversa+de+sa%C3%ADda+do+LeadScout+com+um+Contact+conhecido.+O+Contact+j%C3%A1+deve+existir.+A+Bridge+seleciona+um+Agent+de+prospec%C3%A7%C3%A3o+para+uma+linha+de+Whats\u0026amp;theme=54622e39a2ddcb12e13b2897\u0026amp;signature=80e431ff45c986b69c4525e59fb7a652f0ceca6b3cbf4d6278f8a26781cfda90\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Iniciar conversa de saída do LeadScout com um lead conhecido - Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido. Um contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha. forceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado. Uma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto. Consulte o guia completo de saída para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sainapsisinc.mintlify.site/_mintlify/api/og/v2?division=LeadScout+API\u0026amp;title=Iniciar+conversa+de+sa%C3%ADda+do+LeadScout+com+um+lead+conhecido\u0026amp;description=Inicia+uma+conversa+de+sa%C3%ADda+do+LeadScout+com+um+Contact+conhecido.+O+Contact+j%C3%A1+deve+existir.+A+Bridge+seleciona+um+Agent+de+prospec%C3%A7%C3%A3o+para+uma+linha+de+Whats\u0026amp;theme=54622e39a2ddcb12e13b2897\u0026amp;signature=80e431ff45c986b69c4525e59fb7a652f0ceca6b3cbf4d6278f8a26781cfda90\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3E6EE5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bridge.new/#organization\",\"name\":\"Bridge\",\"url\":\"https://docs.bridge.new\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sainapsisinc/MRBSc5DvZcNEOxd1/logo/bridge_full_logo_light.png?fit=max\u0026auto=format\u0026n=MRBSc5DvZcNEOxd1\u0026q=85\u0026s=9a9d74ac33a89d538635507ba8d12eb9\"},\"sameAs\":[\"https://www.linkedin.com/company/sainapsis-inc\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bridge.new#website\",\"name\":\"Bridge REST Integrations API \u0026 Webhooks\",\"url\":\"https://docs.bridge.new\",\"publisher\":{\"@id\":\"https://docs.bridge.new/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido#webpage\",\"url\":\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido\",\"name\":\"Iniciar conversa de saída do LeadScout com um lead conhecido\",\"description\":\"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido. Um contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha. forceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado. Uma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto. Consulte o guia completo de saída para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.\",\"dateModified\":\"2026-11-14T14:03:18.481Z\",\"isPartOf\":{\"@id\":\"https://docs.bridge.new#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Bridge REST Integrations API \u0026 Webhooks\",\"item\":\"https://docs.bridge.new\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Iniciar conversa de saída do LeadScout com um lead conhecido\",\"item\":\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido#apireference\",\"headline\":\"Iniciar conversa de saída do LeadScout com um lead conhecido\",\"name\":\"Iniciar conversa de saída do LeadScout com um lead conhecido\",\"description\":\"Inicia uma conversa de saída do LeadScout com um Contact conhecido. O Contact já deve existir. A Bridge seleciona um Agent de prospecção para uma linha de WhatsApp elegível. O template é referenciado por template.id ou template.name; id tem precedência quando ambos são informados. Ele deve existir e estar APPROVED, e qualquer Bridge User de handoffOverride deve ser válido. Um contact.providerChannelId explícito é respeitado. Sem ele, a seleção automática prefere uma linha livre, depois uma conversa liberada recuperável com este Contact e, por último, uma conversa ativa ocupada somente quando forceSend=true. A disponibilidade é avaliada por Contact em cada linha, não pela ocupação global da linha. forceSend=true reutiliza uma conversa ativa elegível; não a ignora nem cria uma nova. Uma reutilização bem-sucedida retorna alreadyInitiated=true e persiste o novo template e os acompanhamentos. Uma conversa liberada recuperável pode ser recuperada com qualquer um dos valores, mantém seu ID e retorna recovered=true. Esta opção não torna utilizáveis as conversas bloqueadas nem as liberadas não recuperáveis. A rota legada pode reutilizar uma conversa controlada por um humano ou outro Agent; ao contrário da saída de Agents, ela não exige a verificação de controle pelo Agent solicitado. Uma sessão aberta do LeadScout ainda não expirada continua bloqueando uma nova solicitação de saída com 409 BRIDGE_AI_LEADSCOUT_0017; a impossibilidade de finalizar uma sessão expirada retorna 409 BRIDGE_AI_LEADSCOUT_0018. As outras validações continuam valendo. As mensagens adicionais são persistidas; a persistência não comprova a entrega nem uma espera pela resposta do lead. Uma solicitação com falha pode deixar trabalho parcial, portanto não trate forceSend como idempotência nem repita às cegas uma solicitação com resultado incerto. Consulte o guia completo de saída para a matriz false/true, os indicadores de resposta, as diferenças em relação à saída de Agents, os erros e a transferência.\",\"url\":\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bridge.new/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido#webpage\"},\"dateModified\":\"2026-11-14T14:03:18.481Z\",\"publisher\":{\"@id\":\"https://docs.bridge.new/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bridge.new#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bridge REST Integrations API \u0026 Webhooks\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Bridge\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/pt-br/api-reference/leadscout-api/iniciar-conversa-de-sa%C3%ADda-do-leadscout-com-um-lead-conhecido.md","siteName":"Bridge REST Integrations API \u0026 Webhooks","nav":{"global":null,"languages":[{"language":"en","default":true,"navbar":{"links":[{"href":"https://docs.bridge.new/connect-your-agent","label":"Connect AI"},{"href":"https://help.bridge.new","label":"Help Center"},{"href":"mailto:support@sainapsis.com","label":"Contact Support"}],"primary":{"type":"button","label":"Bridge app","href":"https://app.bridge.new"}},"pages":[{"title":"en","href":"/"}]},{"language":"es","navbar":{"links":[{"href":"https://docs.bridge.new/es/connect-your-agent","label":"Conectar IA"},{"href":"https://help.bridge.new","label":"Centro de ayuda"},{"href":"mailto:support@sainapsis.com","label":"Contactar con soporte"}],"primary":{"type":"button","label":"Aplicación Bridge","href":"https://app.bridge.new"}},"pages":[{"title":"es","href":"/es"}]},{"language":"pt-BR","navbar":{"links":[{"href":"https://docs.bridge.new/pt-br/connect-your-agent","label":"Conectar IA"},{"href":"https://help.bridge.new","label":"Central de ajuda"},{"href":"mailto:support@sainapsis.com","label":"Falar com o suporte"}],"primary":{"type":"button","label":"Aplicativo Bridge","href":"https://app.bridge.new"}},"tabs":[{"tab":"Primeiros passos","pages":[{"title":"Primeiros passos","href":"/pt-br"}]},{"tab":"API REST","groups":[{"group":"Health","pages":[{"title":"Verificar integridade","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/health","href":"/pt-br/api-reference/health/verificar-integridade"}]},{"group":"Conversations API","pages":[{"title":"Obter conversa por ID","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}","href":"/pt-br/api-reference/conversations-api/obter-conversa-por-id"},{"title":"Atualizar conversa","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml patch /bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}","href":"/pt-br/api-reference/conversations-api/atualizar-conversa"},{"title":"Consultar conversas com filtros flexíveis","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/conversations","href":"/pt-br/api-reference/conversations-api/consultar-conversas-com-filtros-flexíveis"},{"title":"Criar conversa com identificação flexível de usuários","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/conversations","href":"/pt-br/api-reference/conversations-api/criar-conversa-com-identificação-flexível-de-usuários"},{"title":"Liberar conversa","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}/release","href":"/pt-br/api-reference/conversations-api/liberar-conversa"}]},{"group":"Messages API","pages":[{"title":"Criar mensagem","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/messages","href":"/pt-br/api-reference/messages-api/criar-mensagem"}]},{"group":"Contacts API","pages":[{"title":"Obter contato por um identificador","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts/lookup","href":"/pt-br/api-reference/contacts-api/obter-contato-por-um-identificador"},{"title":"Obter contato por ID","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}","href":"/pt-br/api-reference/contacts-api/obter-contato-por-id"},{"title":"Atualizar contato","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml patch /bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}","href":"/pt-br/api-reference/contacts-api/atualizar-contato"},{"title":"Listar contatos","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts","href":"/pt-br/api-reference/contacts-api/listar-contatos"},{"title":"Criar contato","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/contacts","href":"/pt-br/api-reference/contacts-api/criar-contato"},{"title":"Criar ou atualizar contato","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/contacts/partial","href":"/pt-br/api-reference/contacts-api/criar-ou-atualizar-contato"}]},{"group":"Files API","pages":[{"title":"Criar uploads pré-assinados de arquivos","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/files","href":"/pt-br/api-reference/files-api/criar-uploads-pré-assinados-de-arquivos"}]},{"group":"Custom attributes API","pages":[{"title":"Consultar atributos personalizados por workspaceId","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/settings/attributes","href":"/pt-br/api-reference/custom-attributes-api/consultar-atributos-personalizados-por-workspaceid"}]},{"group":"Provider channels API","pages":[{"title":"Obter canais de provedores por workspace","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/provider-channels","href":"/pt-br/api-reference/provider-channels-api/obter-canais-de-provedores-por-workspace"},{"title":"Obter canais por workspace e tipo de provedor","description":"Obtém os canais de provedores pelo identificador do workspace e tipo de provedor.","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/provider-channels/{messageProviderType}","href":"/pt-br/api-reference/provider-channels-api/obter-canais-por-workspace-e-tipo-de-provedor"}]},{"group":"LeadScout API","pages":[{"title":"Iniciar conversa de saída do LeadScout com um lead conhecido","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound","href":"/pt-br/api-reference/leadscout-api/iniciar-conversa-de-saída-do-leadscout-com-um-lead-conhecido"},{"title":"Solicitar transferência manual do LeadScout para usuários internos","description":"Solicita a transferência manual de uma conversa controlada pelo LeadScout para um ou mais usuários internos.\n\nA solicitação é confirmada com `202 Accepted`; a atribuição é processada de forma assíncrona. A resposta repete os destinatários solicitados e um ID de rastreamento para correlação. A resolução de usuários internos (por ID ou EMAIL) ocorre depois e não é refletida nesta resposta.","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/leadscout/conversations/{conversationId}/handoff","href":"/pt-br/api-reference/leadscout-api/solicitar-transferência-manual-do-leadscout-para-usuários-internos"}]},{"group":"Templates API","pages":[{"title":"Descobrir as variáveis agnósticas de um modelo","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/templates/{templateId}","href":"/pt-br/api-reference/templates-api/descobrir-as-variáveis-agnósticas-de-um-modelo"}]},{"group":"Internal Users API","pages":[{"title":"Obter usuário interno por um identificador","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/users/lookup","href":"/pt-br/api-reference/internal-users-api/obter-usuário-interno-por-um-identificador"},{"title":"Obter usuário interno por ID","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/users/{userId}","href":"/pt-br/api-reference/internal-users-api/obter-usuário-interno-por-id"},{"title":"Listar usuários internos","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/users","href":"/pt-br/api-reference/internal-users-api/listar-usuários-internos"}]},{"group":"Agents API","pages":[{"title":"Listar os Agents de um workspace","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/agents","href":"/pt-br/api-reference/agents-api/listar-os-agents-de-um-workspace"},{"title":"Iniciar conversa de saída com um Contact como Agent específico","deprecated":null,"version":null,"openapi":"/pt-br/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/agents/{agentId}/outbound","href":"/pt-br/api-reference/agents-api/iniciar-conversa-de-saída-com-um-contact-como-agent-específico"}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/pt-br/webhooks"}]},{"tab":"Custom Connections","pages":[{"title":"Custom Connections","href":"/pt-br/lead-capture"}]}]}]},"basePath":"","title":"Iniciar conversa de saída do LeadScout com um lead conhecido - Bridge REST Integrations API \u0026 Webhooks","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}