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

# Iniciar chamada (BIC)

> Inicia uma chamada de voz do negócio para o usuário (business-initiated call). Body: { to, sdp?, sdpType?:"offer", bizOpaqueCallbackData? }. Números Meta: o sdp é OBRIGATÓRIO — a oferta RFC 8866 do SEU cliente WebRTC (lado do negócio deve usar a=setup:active) — e exige permissão prévia do usuário (senão a Meta retorna 138006 → META_CALL_PERMISSION_REQUIRED); cobrança por minuto pela Meta, direto na sua WABA, só quando atendida. Números web (não-oficiais): OMITA o sdp — a mídia é tratada no servidor — sem etapa de permissão e sem cobrança da Meta.

**Requer uma chave com escopo de número.**



## OpenAPI

````yaml openapi.pt.json POST /v1/calls
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/calls:
    post:
      tags:
        - Calls
      summary: Iniciar chamada (BIC)
      description: >-
        Inicia uma chamada de voz do negócio para o usuário (business-initiated
        call). Body: { to, sdp?, sdpType?:"offer", bizOpaqueCallbackData? }.
        Números Meta: o sdp é OBRIGATÓRIO — a oferta RFC 8866 do SEU cliente
        WebRTC (lado do negócio deve usar a=setup:active) — e exige permissão
        prévia do usuário (senão a Meta retorna 138006 →
        META_CALL_PERMISSION_REQUIRED); cobrança por minuto pela Meta, direto na
        sua WABA, só quando atendida. Números web (não-oficiais): OMITA o sdp —
        a mídia é tratada no servidor — sem etapa de permissão e sem cobrança da
        Meta.


        **Requer uma chave com escopo de número.**
      operationId: post_calls
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                to:
                  type: string
                  description: Número do usuário a ligar.
                  example: '+5511999999999'
                sdp:
                  type: string
                  description: >-
                    Oferta SDP do seu cliente WebRTC (a=setup:active).
                    Obrigatório em números Meta; omita em números web.
                sdpType:
                  type: string
                  description: Sempre "offer" (padrão).
                  example: offer
                bizOpaqueCallbackData:
                  type: string
                  description: Dado opaco ecoado no evento de término.
                  example: order-42
              required:
                - to
            example:
              to: '+5511999999999'
              sdp: "v=0\r\n..."
              bizOpaqueCallbackData: order-42
      responses:
        '201':
          description: Iniciar chamada
          content:
            application/json:
              example:
                id: call_01HZX...
                externalCallId: wacid.ABGG...
                status: INITIATED
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de tenant usada em endpoint com escopo de número
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '409':
          description: Número web não conectado
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: WhatsApp instance not connected
                code: WHATSAPP_INSTANCE_NOT_CONNECTED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````