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

# Obter Remetentes WhatsApp

> Listar todos os remetentes WhatsApp Business para o usuário autenticado

Este endpoint retorna uma lista de remetentes WhatsApp Business (números de telefone) configurados para sua conta. Use isso para obter IDs de remetentes necessários para enviar mensagens.

### Parâmetros de Consulta

<ParamField query="status" type="string" optional>
  Filtrar remetentes por status. Padrão: `online`. Use `all` para retornar todos os remetentes independentemente do status.
</ParamField>

### Campos de Resposta

<ResponseField name="data" type="array">
  <Expandable title="Propriedades do objeto remetente">
    <ResponseField name="id" type="integer">
      O identificador único do remetente WhatsApp. Use este ID ao enviar mensagens.
    </ResponseField>

    <ResponseField name="phone_number" type="string">
      O número de telefone do remetente em formato E.164 (ex: `+14155551234`)
    </ResponseField>

    <ResponseField name="display_name" type="string">
      O nome de exibição do WhatsApp Business (nome da empresa mostrado aos destinatários)
    </ResponseField>

    <ResponseField name="status" type="string">
      O status atual do remetente: `online` ou `offline`
    </ResponseField>

    <ResponseField name="quality_rating" type="string">
      Classificação de qualidade da Meta para este remetente: `GREEN`, `YELLOW` ou `RED`
    </ResponseField>

    <ResponseField name="messaging_limit" type="integer">
      O limite atual de mensagens (número de destinatários únicos por 24 horas). `null` significa ilimitado.
    </ResponseField>

    <ResponseField name="messaging_limit_formatted" type="string">
      Limite de mensagens legível para humanos (ex: `1,000 / 24hr`, `10,000 / 24hr` ou `Unlimited`)
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://suasofia.online/api/user/whatsapp/senders" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```bash Filtrar todos os remetentes theme={null}
  curl -X GET "https://suasofia.online/api/user/whatsapp/senders?status=all" \
    -H "Authorization: Bearer YOUR_API_KEY"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://suasofia.online/api/user/whatsapp/senders',
    {
      headers: {
        'Authorization': 'Bearer YOUR_API_KEY'
      }
    }
  );

  const data = await response.json();
  console.log(data.data); // Array de remetentes
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://suasofia.online/api/user/whatsapp/senders',
      headers={'Authorization': 'Bearer YOUR_API_KEY'}
  )

  senders = response.json()['data']
  for sender in senders:
      print(f"{sender['display_name']}: {sender['phone_number']}")
  ```
</RequestExample>

<ResponseExample>
  ```json 200 Resposta theme={null}
  {
    "data": [
      {
        "id": 12,
        "phone_number": "+14155551234",
        "display_name": "Acme Corp Support",
        "status": "online",
        "quality_rating": "GREEN",
        "messaging_limit": 10000,
        "messaging_limit_formatted": "10,000 / 24hr"
      },
      {
        "id": 15,
        "phone_number": "+442071234567",
        "display_name": "Acme Corp Sales",
        "status": "online",
        "quality_rating": "GREEN",
        "messaging_limit": null,
        "messaging_limit_formatted": "Unlimited"
      }
    ]
  }
  ```

  ```json 200 Resposta Vazia theme={null}
  {
    "data": []
  }
  ```
</ResponseExample>

### Notas

* Apenas remetentes com status `online` são retornados por padrão. Use `?status=all` para incluir remetentes offline.
* O status do remetente é sincronizado com a Meta a cada 5 minutos automaticamente.
* O campo `id` é o que você precisa passar como `sender_id` ao enviar mensagens.
* A classificação de qualidade afeta seus limites de mensagens. Uma classificação `RED` pode restringir sua capacidade de enviar mensagens.