---
title: "Números · Referência REST"
description: "As rotas de Números. Todo corpo é JSON, e o erro sempre volta como um objeto com código e mensagem."
lang: "pt-BR"
canonical: "https://zaiped.com/developers/docs/reference/numbers"
alternate: "https://zaiped.com/en/developers/docs/reference/numbers"
---

# Números · Referência REST

## GET /v1/numbers

List connected numbers

All WhatsApp numbers connected to the account, oldest first, with the status Meta reports for each one (quality rating, messaging limit, throughput, health). Numbers are connected in the developer console through Meta's Embedded Signup; there is no API to connect one.

**Resposta (object[])**

- `id` · string (Obrigatório): Zaiped id (whatsappConnections)
- `status` · "active" | "incomplete" | "needs_reauth" (Obrigatório)
- `phoneNumberId` · string (Obrigatório)
- `wabaId` · string (Obrigatório)
- `displayPhoneNumber` · string
- `verifiedName` · string
- `qualityRating` · string
- `messagingLimit` · string
- `throughputLevel` · string
- `healthStatus` · string
- `nameStatus` · string
- `isOfficialAccount` · boolean
- `isOnBizApp` · boolean
- `lastNotice` · object
- `lastSyncedAt` · number

```
curl -X GET "https://zaiped.com/v1/numbers" \
  -H "Authorization: Bearer zp_..."
```

## GET /v1/numbers/{numberId}

Get a connected number

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Resposta (object)**

- `id` · string (Obrigatório): Zaiped id (whatsappConnections)
- `status` · "active" | "incomplete" | "needs_reauth" (Obrigatório)
- `phoneNumberId` · string (Obrigatório)
- `wabaId` · string (Obrigatório)
- `displayPhoneNumber` · string
- `verifiedName` · string
- `qualityRating` · string
- `messagingLimit` · string
- `throughputLevel` · string
- `healthStatus` · string
- `nameStatus` · string
- `isOfficialAccount` · boolean
- `isOnBizApp` · boolean
- `lastNotice` · object
- `lastSyncedAt` · number

```
curl -X GET "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID" \
  -H "Authorization: Bearer zp_..."
```

## GET /v1/numbers/{numberId}/profile

Get the business profile

The WhatsApp Business profile of the number, read live from Meta.

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Resposta (object)**

- `about` · string (Obrigatório)
- `address` · string (Obrigatório)
- `description` · string (Obrigatório)
- `email` · string (Obrigatório)
- `websites` · string[] (Obrigatório)
- `vertical` · string (Obrigatório)
- `pictureUrl` · string

```
curl -X GET "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/profile" \
  -H "Authorization: Bearer zp_..."
```

## PUT /v1/numbers/{numberId}/profile

Update the business profile

Replaces the profile fields. Send every field: an empty string clears it (except `about`, which Meta keeps when empty). The picture is changed in the console.

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Corpo da requisição**

- `about` · string (Obrigatório)
- `address` · string (Obrigatório)
- `description` · string (Obrigatório)
- `email` · string (Obrigatório)
- `websites` · string[] (Obrigatório)
- `vertical` · string (Obrigatório)

**Resposta (object)**

- `ok` · true (Obrigatório)

```
curl -X PUT "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/profile" \
  -H "Authorization: Bearer zp_..." \
  -H "Content-Type: application/json" \
  -d '{
  "about": "…",
  "address": "…",
  "description": "…",
  "email": "…",
  "websites": [],
  "vertical": "…"
}'
```

## GET /v1/numbers/{numberId}/automation

Get conversational components

Welcome message, ice-breaker prompts and slash commands (Meta's conversational automation).

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Resposta (object)**

- `welcomeEnabled` · boolean (Obrigatório)
- `prompts` · string[] (Obrigatório)
- `commands` · object[] (Obrigatório)

```
curl -X GET "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/automation" \
  -H "Authorization: Bearer zp_..."
```

## PUT /v1/numbers/{numberId}/automation

Update conversational components

Replaces the whole configuration: Meta substitutes, it does not merge.

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Corpo da requisição**

- `welcomeEnabled` · boolean (Obrigatório)
- `prompts` · string[] (Obrigatório)
- `commands` · object[] (Obrigatório)

**Resposta (object)**

- `ok` · true (Obrigatório)

```
curl -X PUT "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/automation" \
  -H "Authorization: Bearer zp_..." \
  -H "Content-Type: application/json" \
  -d '{
  "welcomeEnabled": true,
  "prompts": [],
  "commands": []
}'
```

## GET /v1/numbers/{numberId}/qr-codes

List QR codes

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Resposta (object[])**

- `code` · string (Obrigatório)
- `message` · string (Obrigatório)
- `deepLink` · string (Obrigatório)
- `imageUrl` · string

```
curl -X GET "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/qr-codes" \
  -H "Authorization: Bearer zp_..."
```

## POST /v1/numbers/{numberId}/qr-codes

Create a QR code with a prefilled message

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Corpo da requisição**

- `message` · string (Obrigatório)

**Resposta (object)**

- `code` · string (Obrigatório)
- `message` · string (Obrigatório)
- `deepLink` · string (Obrigatório)
- `imageUrl` · string

```
curl -X POST "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/qr-codes" \
  -H "Authorization: Bearer zp_..." \
  -H "Content-Type: application/json" \
  -d '{
  "message": "…"
}'
```

## DELETE /v1/numbers/{numberId}/qr-codes/{code}

Delete a QR code

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.
- `code` · string (Obrigatório): The QR code, as returned by list_qr_codes.

**Resposta (object)**

- `ok` · true (Obrigatório)

```
curl -X DELETE "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/qr-codes/YOUR_CODE" \
  -H "Authorization: Bearer zp_..."
```

## GET /v1/numbers/{numberId}/calling

Get voice calling settings

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Resposta (object)**

- `enabled` · boolean (Obrigatório)
- `iconVisible` · boolean (Obrigatório)

```
curl -X GET "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/calling" \
  -H "Authorization: Bearer zp_..."
```

## PUT /v1/numbers/{numberId}/calling

Enable or disable voice calling

Turns the WhatsApp Calling API on or off for the number. Calls themselves are placed from a browser (WebRTC) and have no REST route.

**Parâmetros de caminho**

- `numberId` · string (Obrigatório): The number id, as returned by list_numbers.

**Corpo da requisição**

- `enabled` · boolean (Obrigatório)

**Resposta (object)**

- `ok` · true (Obrigatório)

```
curl -X PUT "https://zaiped.com/v1/numbers/YOUR_NUMBER_ID/calling" \
  -H "Authorization: Bearer zp_..." \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true
}'
```