Skip to main content
POST
/
api
/
v1
/
whatsapp
/
subscriber
/
list
curl -X POST \
  'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list' \
  -d 'apiToken=SUA_API_KEY_AQUI' \
  -d 'phone_number_id=SEU_PHONE_NUMBER_ID' \
  -d 'limit=10' \
  -d 'offset=0'
{
  "status": "1",
  "message": [
    {
      "subscriber_id": 144,
      "chat_id": "880152145XXX",
      "first_name": "Jonas",
      "last_name": "Souza",
      "email": "jonas@gmail.com",
      "gender": "male",
      "label_names": "One ,two"
    },
    {
      "subscriber_id": 157,
      "chat_id": "8801518951XXX",
      "first_name": "Jonas",
      "last_name": "Souza",
      "email": "null",
      "gender": "Male",
      "label_names": "ChatTest,remove tag,One"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://help.wizebot.com.br/llms.txt

Use this file to discover all available pages before exploring further.

Listar Assinantes

Esta API permite obter uma lista de assinantes da sua conta do WhatsApp Business.

Endpoint da API

Parâmetros

apiToken
string
required
Sua chave de API
phone_number_id
string
required
Seu número de telefone do WhatsApp
limit
number
required
Obter número de assinantes
offset
number
Deslocamento de paginação

Exemplo de Solicitação

curl -X POST \ 
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'limit=10' \
-d 'offset=1'

Exemplo de Resposta

{
  "status": "1",
  "message": [
    {
      "subscriber_id": 144,
      "chat_id": "880152145XXX",
      "first_name": "Jonas",
      "last_name": "Souza",
      "email": "jonas@gmail.com",
      "gender": "male",
      "label_names": "One ,two"
    },
    {
      "subscriber_id": 157,
      "chat_id": "8801518951XXX",
      "first_name": "Rahim",
      "last_name": "Karim",
      "email": "null",
      "gender": "Male",
      "label_names": "ChatTest,remove tag,One"
    }
  ]
}

Teste a API

Para testar esta API, você precisará de sua chave API (apiToken) que pode ser encontrada no painel da WizeBot em Configurações > API.
curl -X POST \
  'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list' \
  -d 'apiToken=SUA_API_KEY_AQUI' \
  -d 'phone_number_id=SEU_PHONE_NUMBER_ID' \
  -d 'limit=10' \
  -d 'offset=0'
{
  "status": "1",
  "message": [
    {
      "subscriber_id": 144,
      "chat_id": "880152145XXX",
      "first_name": "Jonas",
      "last_name": "Souza",
      "email": "jonas@gmail.com",
      "gender": "male",
      "label_names": "One ,two"
    },
    {
      "subscriber_id": 157,
      "chat_id": "8801518951XXX",
      "first_name": "Jonas",
      "last_name": "Souza",
      "email": "null",
      "gender": "Male",
      "label_names": "ChatTest,remove tag,One"
    }
  ]
}