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

# Iniciar ligação

> Liga para um número pela integração. A ligação fica com a API: não aparece para os atendentes, e o áudio é trocado pelo WebSocket `/call/audio` assim que o contato atende. Pode ser transferida para a fila depois.



## OpenAPI

````yaml POST /call/start
openapi: 3.1.0
info:
  title: OpenAPI Multchats
  description: Multchats API
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.multchats.com/v2
security:
  - bearerAuth: []
paths:
  /call/start:
    post:
      tags:
        - Calls
      summary: Iniciar ligação
      description: >-
        Liga para um número pela integração. A ligação fica com a API: não
        aparece para os atendentes, e o áudio é trocado pelo WebSocket
        `/call/audio` assim que o contato atende. Pode ser transferida para a
        fila depois.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartCallRequest'
      responses:
        '200':
          description: Ligação iniciada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallResponse'
        '400':
          description: >-
            Erro na requisição. Códigos: `INVALID_PHONE_NUMBER` (o número
            precisa ter de 8 a 15 dígitos, com DDI), `CALL_NOT_SUPPORTED` (a
            integração não faz ligações)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    StartCallRequest:
      type: object
      required:
        - integrationId
        - phoneNumber
      properties:
        integrationId:
          description: ID da integração (tipo HyperMeow com ligações)
          type: string
          pattern: ^c[a-z0-9]{24}$
        phoneNumber:
          description: >-
            Número que vai receber a ligação, com DDI. Só os dígitos são usados:
            `+55 (11) 99999-9999` é o mesmo que `5511999999999`
          type: string
          minLength: 8
          maxLength: 30
    CallResponse:
      type: object
      properties:
        success:
          description: Indica se a operação foi bem-sucedida
          type: boolean
          default: true
        call:
          $ref: '#/components/schemas/Call'
    Error:
      required:
        - success
        - message
      type: object
      properties:
        success:
          description: Indica se a operação foi bem-sucedida
          type: boolean
          default: false
        message:
          description: Mensagem de erro (quando success é false)
          type: string
          default: Erro ao enviar mensagem
    Call:
      type: object
      properties:
        callId:
          description: ID da ligação
          type: string
        integrationId:
          description: ID da integração
          type: string
        direction:
          description: Sentido da ligação
          type: string
          enum:
            - incoming
            - outgoing
        chatId:
          description: WhatsApp ID do contato
          type: string
        peer:
          description: ID do contato na ligação
          type: string
        isVideo:
          description: Se é uma chamada de vídeo
          type: boolean
        state:
          description: Estado da ligação
          type: string
          enum:
            - ringing
            - connecting
            - active
            - ended
        reason:
          description: Motivo do encerramento, quando terminou
          type: string
        startedAt:
          description: Início da ligação (Unix, ms)
          type: integer
        answeredAt:
          description: Quando foi atendida (Unix, ms); 0 se ainda não foi
          type: integer
        endedAt:
          description: Quando terminou (Unix, ms); 0 se não terminou
          type: integer
        chatInternalId:
          description: ID da conversa do contato, quando existe
          type:
            - string
            - 'null'
        contactName:
          description: Nome do contato
          type:
            - string
            - 'null'
        contactPicture:
          description: Foto do contato
          type:
            - string
            - 'null'
        answeredBy:
          description: >-
            Com quem está a ligação: `api` para a API, o ID do atendente, ou
            null se ninguém atendeu
          type:
            - string
            - 'null'
        queued:
          description: Se a ligação foi transferida para a fila pela API
          type: boolean
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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