> For the complete documentation index, see [llms.txt](https://docs.otima.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.otima.io/whatsapp/recursos-de-api/numero.md).

# Número

Consulte os dados consolidados de um número oficial do WhatsApp Business.

### Consultar dados do número

Use o endpoint abaixo para consultar os dados consolidados de um número oficial:

```http
GET https://sync-core-api.otima.io/whatsapp/provider/{{numero_aqui}}/phone-number
```

Informe `numero_aqui` no formato internacional, somente com dígitos. A resposta reúne identificação, status, perfil, WABA, segmento, qualidade, limite de mensagens e configurações de roteamento.

### Exemplo de resposta

```json
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000001",
    "name": "Empresa Exemplo",
    "display_phone_number": "5511999999999",
    "status": {
      "id": 7,
      "description": "Número ativo"
    },
    "avatar": {
      "mime_type": "image/jpeg",
      "url": "https://cdn.exemplo.com/avatars/numero.jpg"
    },
    "waba": {
      "id": 1000,
      "name": "WABA Exemplo",
      "business_id": "BUSINESS_ID_EXEMPLO",
      "waba_id": "WABA_ID_EXEMPLO",
      "limit": 2000,
      "connected": 1
    },
    "segment": {
      "segment_id": "00000000-0000-0000-0000-000000000002",
      "segment_name": "Varejo"
    },
    "quality_status": {
      "code": "UNKNOWN"
    },
    "quality_rating": {
      "code": "GREEN"
    },
    "messaging_limit": {
      "amount": 2000,
      "formatted_amount": "2.000"
    },
    "calling_enabled": {
      "code": "ENABLED"
    },
    "inbound_routing": "managed",
    "conversation_routing_settings": {
      "enabled": false,
      "role": "primary",
      "standby_enabled": true
    },
    "is_verified": true,
    "webhook_configured": true,
    "workspace": {
      "id": 100,
      "name": "Workspace Exemplo"
    },
    "updated_at": "2026-09-15T10:04:46+00:00"
  }
}
```

### Campos principais

| Campo                           | Significado                                                                                                |
| ------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `status.description`            | Situação operacional atual do número. Por exemplo, `Número ativo` indica que ele está ativo.               |
| `quality_status.code`           | Estado de qualidade informado pela Meta. `UNKNOWN` indica que não há classificação disponível.             |
| `quality_rating.code`           | Avaliação de qualidade do número. `GREEN` indica uma classificação saudável.                               |
| `messaging_limit.amount`        | Limite de conversas ou mensagens atribuído ao número. `formatted_amount` traz o mesmo valor para exibição. |
| `waba`                          | Conta WhatsApp Business vinculada. Use `name`, `business_id` e `waba_id` para identificá-la.               |
| `segment`                       | Segmento operacional associado ao número, quando configurado.                                              |
| `webhook_configured`            | Indica se há um webhook configurado para receber eventos do número.                                        |
| `calling_enabled.code`          | Indica se as chamadas estão habilitadas.                                                                   |
| `inbound_routing`               | Define o roteamento das chamadas recebidas. `managed` usa o roteamento gerenciado pela plataforma.         |
| `conversation_routing_settings` | Informa as configurações de roteamento de conversas, como papel do número e uso de standby.                |
| `is_verified`                   | Indica se o número está verificado.                                                                        |
| `updated_at`                    | Data e hora da última atualização dos dados retornados.                                                    |

> A resposta completa pode incluir URLs de webhook e dados de trunk SIP. Trate senhas, tokens e identificadores privados como credenciais. Não os exponha em logs ou documentação.