Skip to main content
GET
/
api
/
{session}
/
channels
Obter lista de canais conhecidos
curl --request GET \
  --url https://{host}/api/{session}/channels \
  --header 'apikey: <api-key>'
{
  "newsletters": [
    {
      "id": "123456789@newsletter",
      "name": "Canal de Notícias",
      "description": "Últimas notícias e atualizações"
    },
    {
      "id": "987654321@newsletter",
      "name": "Canal de Tecnologia",
      "description": "Novidades do mundo tech"
    }
  ]
}

​
Descrição

Este endpoint retorna a lista de todos os canais que a sessão conhece, incluindo canais seguidos e outros canais disponíveis no WhatsApp.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp autenticada

​
Resposta

​
newsletters
array
Array contendo os canais conhecidos
{
  "newsletters": [
    {
      "id": "123456789@newsletter",
      "name": "Canal de Notícias",
      "description": "Últimas notícias e atualizações"
    },
    {
      "id": "987654321@newsletter",
      "name": "Canal de Tecnologia",
      "description": "Novidades do mundo tech"
    }
  ]
}

​
Códigos de Status

  • 200 - Lista obtida com sucesso
  • 401 - Não autorizado
  • 500 - Erro interno do servidor

​
Exemplo de Uso

curl -X GET https://api.wappfy.com.br/api/my-session/channels

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Query Parameters

​
role
enum<string>
Available options:
OWNER,
ADMIN,
SUBSCRIBER

Response

200 - application/json
​
id
string
required

Newsletter id

Example:

"123123123123@newsletter"

​
name
string
required

Channel name

Example:

"Channel Name"

​
invite
string
required

Invite link

Example:

"https://www.whatsapp.com/channel/111111111111111111111111"

​
role
enum<string>
required
Available options:
OWNER,
ADMIN,
SUBSCRIBER,
GUEST
​
verified
boolean
required
​
subscribersCount
number
required
​
preview
string

Preview for channel's picture

Example:

"https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10"

​
picture
string

Channel's picture

Example:

"https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10"

​
description
string
⌘I