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

# Gerenciar números de telefone do WhatsApp

> Registre números de telefone e gerencie perfis, comércio e configurações de chamadas.

## O que é

Um número de telefone comercial do WhatsApp é a identidade do remetente que os clientes veem em uma
conversa. Use estas APIs para descobrir números registrados, configurar seu
perfil comercial, solicitar uma alteração de nome de exibição, controlar a visibilidade
do comércio e gerenciar configurações específicas do telefone.

## Antes de começar

* Conecte a WABA pai à YCloud.
* Adicione o número de telefone à WABA.
* Armazene o ID da WABA e o número de telefone no formato E.164.
* Envie uma foto de perfil à Meta antes de definir `profilePictureUrl`.

## Como funciona

1. Liste os números ou recupere um número para inspecionar seu estado.
2. Registre um número antes de usá-lo para envio de mensagens.
3. Atualize o perfil comercial voltado ao cliente.
4. Atualize o nome de exibição, a visibilidade de comércio ou as configurações de chamadas conforme necessário.
5. Recupere o recurso novamente para confirmar a configuração atual.

Mudanças de nome de exibição e algumas configurações de plataforma podem exigir processamento
assíncrono pela Meta.

## Requisição

### Registrar um número de telefone

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request POST \
  https://api.ycloud.com/v2/whatsapp/phoneNumbers/WABA_ID/+16315551111/register \
  --header "X-API-Key: $YCLOUD_API_KEY"
```

### Atualizar o perfil comercial

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request PATCH \
  https://api.ycloud.com/v2/whatsapp/phoneNumbers/WABA_ID/+16315551111/profile \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "about": "Customer support and order updates",
    "address": "100 Market Street",
    "description": "Example Store",
    "email": "support@example.com",
    "vertical": "RETAIL",
    "websites": ["https://example.com"]
  }'
```

### Atualizar a visibilidade do comércio

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request PATCH \
  https://api.ycloud.com/v2/whatsapp/phoneNumbers/WABA_ID/+16315551111/whatsappCommerceSettings \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "isCartEnabled": true,
    "isCatalogVisible": true
  }'
```

## Resposta

As operações de perfil e configurações retornam o recurso atualizado.

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "about": "Customer support and order updates",
  "email": "support@example.com",
  "vertical": "RETAIL",
  "websites": ["https://example.com"]
}
```

O registro retorna o recurso do número de telefone. Armazene seus IDs e inspecione seu
estado de registro e qualidade antes de enviar.

## Áreas de configuração

| Área | Use para |
| - | - |
| Perfil | Texto sobre, endereço, descrição, e-mail, segmento, websites e foto de perfil. |
| Nome de exibição | Nome do remetente voltado ao cliente enviado para processamento pela Meta. |
| Comércio | Controles de visibilidade do catálogo e do carrinho de compras. |
| Configurações | Recursos específicos do telefone, como Chamadas do WhatsApp. |

## Limites e solução de problemas

* Os campos do perfil têm limites de formato e tamanho; consulte a Referência da API para as
  restrições completas.
* URLs de site devem incluir `http://` ou `https://`.
* Uma atualização de nome de exibição pode não entrar em vigor imediatamente.
* Registro, qualidade e estado da WABA podem afetar o envio de forma independente.
* Use o ID da WABA e o número E.164 exato em cada caminho.

<CardGroup cols={2}>
  <Card title="Listar números de telefone" icon="list" href="/api-reference/whatsapp-phone-numbers/list-phone-numbers">
    Descubra os números registrados e sua WABA pai.
  </Card>

  <Card title="Atualizar perfil" icon="address-card" href="/api-reference/whatsapp-phone-numbers/update-a-phone-number-profile">
    Inspecione todos os campos e restrições do perfil.
  </Card>
</CardGroup>


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