> ## 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.

# Status de conexão do número

> Sincroniza e retorna o estado de conexão atual do número (OPEN/CONNECTING/CLOSE). Números Meta retornam OPEN. Um número Meta criado por POST /v1/numbers/remote-pairing responde PENDING enquanto o usuário final ainda está no diálogo do Embedded Signup e EXPIRED depois que essa janela fecha sem conclusão — os dois trazem `expiresAt`. Um 200 NÃO significa conectado: faça polling até `state` ser OPEN e pare em EXPIRED. Útil para consultar após criar/conectar.



## OpenAPI

````yaml openapi.pt.json GET /v1/numbers/{id}/status
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/numbers/{id}/status:
    get:
      tags:
        - Numbers
      summary: Status de conexão do número
      description: >-
        Sincroniza e retorna o estado de conexão atual do número
        (OPEN/CONNECTING/CLOSE). Números Meta retornam OPEN. Um número Meta
        criado por POST /v1/numbers/remote-pairing responde PENDING enquanto o
        usuário final ainda está no diálogo do Embedded Signup e EXPIRED depois
        que essa janela fecha sem conclusão — os dois trazem `expiresAt`. Um 200
        NÃO significa conectado: faça polling até `state` ser OPEN e pare em
        EXPIRED. Útil para consultar após criar/conectar.
      operationId: get_numbers_id_status
      parameters:
        - name: id
          in: path
          required: true
          description: Id do número/instância.
          schema:
            type: string
          example: num_01HZX...
      responses:
        '200':
          description: Status
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Id público do número.
                    example: num_01HZX...
                  state:
                    type: string
                    enum:
                      - OPEN
                      - CONNECTING
                      - CLOSE
                      - PENDING
                      - EXPIRED
                    description: >-
                      OPEN = conectado. PENDING/EXPIRED = número Meta aguardando
                      (ou já fora d)a janela do Embedded Signup.
                    example: OPEN
                  stale:
                    type: boolean
                    description: >-
                      false = leitura ao vivo (com checkedAt); true = último
                      estado lembrado (com lastKnownAt).
                    example: false
                  checkedAt:
                    type: string
                    description: ISO 8601. Só quando stale é false.
                    example: '2026-07-22T12:34:56.000Z'
                  lastKnownAt:
                    type: string
                    description: ISO 8601. Só quando stale é true.
                    example: '2026-07-22T12:34:56.000Z'
                  expiresAt:
                    type: string
                    description: >-
                      ISO 8601, fim da janela de pareamento. Só em
                      PENDING/EXPIRED.
                    example: '2026-08-04T18:27:31.000Z'
              example:
                id: num_01HZX...
                state: OPEN
        '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
        '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)

````

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