> ## Documentation Index
> Fetch the complete documentation index at: https://docs.olie.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Abrir conversa externa

> Abre uma conversa externa em um projeto, pela integração de comunicação informada. A resposta é HTTP 201 com o canal, inclusive quando a conversa ativa deste projeto é reaproveitada.

Se o destinatário já tem uma conversa ativa neste projeto, a chamada devolve esse canal. Se a conversa ativa estiver em outro projeto, o resultado depende de **Permitir múltiplas conversas ativas com o mesmo contato**. Com a opção ligada na empresa ou na integração, a chamada abre outra conversa neste projeto. Com a opção desligada, a chamada responde HTTP 409 com `message: "active_channel_elsewhere"`.

Para encerrar as conversas ativas do destinatário e abrir uma nova neste projeto, envie `force_reopen: true`. Informe `close_reason` para gravar o motivo do encerramento na conversa encerrada.



## OpenAPI

````yaml /api-reference/openapi.json post /api/management/channels/open
openapi: 3.0.0
info:
  title: Olie API
  version: 1.0.0
  description: >
    # Introdução 👋


    Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/).
    Aqui você encontra as referências e exemplos de uso dos nossos endpoints.


    Para uma visão completa, recomendamos fortemente que você leia a
    [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá
    estão detalhados tópicos essenciais como
    [autenticação](https://docs.olie.ai/api-reference/introduction/authentication),
    [estrutura de
    respostas](https://docs.olie.ai/api-reference/general/response-structure),
    [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros
    guias de integração.


    No Postman, esta coleção foca nas informações específicas de cada requisição
    (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e
    desenvolvimento.
servers:
  - url: https://api.olie.ai
security:
  - BearerAuth: []
paths:
  /api/management/channels/open:
    post:
      tags:
        - channels
      summary: Abrir conversa externa
      description: >-
        Abre uma conversa externa em um projeto, pela integração de comunicação
        informada. A resposta é HTTP 201 com o canal, inclusive quando a
        conversa ativa deste projeto é reaproveitada.


        Se o destinatário já tem uma conversa ativa neste projeto, a chamada
        devolve esse canal. Se a conversa ativa estiver em outro projeto, o
        resultado depende de **Permitir múltiplas conversas ativas com o mesmo
        contato**. Com a opção ligada na empresa ou na integração, a chamada
        abre outra conversa neste projeto. Com a opção desligada, a chamada
        responde HTTP 409 com `message: "active_channel_elsewhere"`.


        Para encerrar as conversas ativas do destinatário e abrir uma nova neste
        projeto, envie `force_reopen: true`. Informe `close_reason` para gravar
        o motivo do encerramento na conversa encerrada.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                project_id:
                  type: string
                  description: Projeto em que a conversa abre.
                  format: uuid
                integration_id:
                  type: string
                  description: Integração de comunicação pela qual a conversa acontece.
                  format: uuid
                external_ref:
                  type: string
                  maxLength: 255
                  description: >-
                    Identificador do contato no conector, enviado exatamente
                    como informado.
                force_reopen:
                  type: boolean
                  description: >-
                    Encerra todas as conversas ativas com o destinatário nessa
                    integração, em qualquer projeto, e abre uma nova neste.
                close_reason:
                  type: string
                  maxLength: 500
                  description: >-
                    Nota registrada na conversa encerrada. No máximo 500
                    caracteres.
              required:
                - project_id
                - integration_id
                - external_ref
            example:
              project_id: 8a1f2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
              integration_id: 6b9e0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d
              external_ref: 5511999990000@s.whatsapp.net
      responses:
        '201':
          description: Sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: boolean
                  channel:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      audience:
                        type: string
                      integration_id:
                        type: string
                      external_ref:
                        type: string
                      is_active:
                        type: boolean
                      project_id:
                        type: string
                      frame_id:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
              example:
                response: true
                channel:
                  id: 9b2a1c3e-4d5f-6789-abcd-ef0123456789
                  name: WhatsApp
                  audience: client
                  integration_id: 6b9e0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d
                  external_ref: 5511999990000@s.whatsapp.net
                  is_active: true
                  project_id: 8a1f2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
                  frame_id: 7c0e1d2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f
                  created_at: '2026-06-18T12:00:00.000000Z'
                  updated_at: '2026-06-18T12:00:00.000000Z'
        '404':
          description: Não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: boolean
                  message:
                    type: string
                  error:
                    type: string
              example:
                response: false
                message: project_model_not_found
                error: No query results for model [Project].
        '409':
          description: >-
            O destinatário já tem uma conversa ativa em outro projeto, e a
            empresa ou a integração não permite várias conversas ativas com o
            mesmo contato. Envie `force_reopen: true` para encerrar essa
            conversa e abrir uma nova neste projeto.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: boolean
                  message:
                    type: string
                  error:
                    type: string
                  conflicting_channel_id:
                    type: string
                    description: ID do canal ativo em outro projeto.
                  conflicting_project_id:
                    type: string
                    description: ID do projeto em que a conversa está ativa.
                  conflicting_project_name:
                    type: string
                    description: Nome do projeto em que a conversa está ativa.
              example:
                response: false
                message: active_channel_elsewhere
                error: >-
                  The counterpart already has an active conversation in another
                  project.
                conflicting_channel_id: 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d
                conflicting_project_id: 2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e
                conflicting_project_name: Atendimento Maria
        '422':
          description: Erro de validação
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: boolean
                  message:
                    type: string
                  error:
                    type: string
                  validation:
                    type: object
                    properties:
                      project_id:
                        type: array
                        items:
                          type: string
                      integration_id:
                        type: array
                        items:
                          type: string
                      external_ref:
                        type: array
                        items:
                          type: string
              example:
                response: false
                message: validation_errors
                error: The given data was invalid.
                validation:
                  project_id:
                    - O campo project id é obrigatório.
                  integration_id:
                    - O campo integration id é obrigatório.
                  external_ref:
                    - O campo external ref é obrigatório.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.