Skip to main content
GET
/
api
/
{session}
/
channels
/
{id}
Obter informações do canal
curl --request GET \
  --url https://{host}/api/{session}/channels/{id} \
  --header 'apikey: <api-key>'
{
  "id": "123456789@newsletter",
  "name": "Canal de Notícias",
  "description": "Últimas notícias e atualizações",
  "followersCount": 1523,
  "picture": "https://..."
}

​
Descrição

Este endpoint retorna as informações detalhadas de um canal específico através do seu ID.

​
Parâmetros de URL

​
session
string
required
ID único da sessão WhatsApp autenticada
​
id
string
required
ID único do canal que deseja obter informações

​
Resposta

​
id
string
ID único do canal
​
name
string
Nome do canal
​
description
string
Descrição do canal
​
followersCount
number
Número de seguidores do canal
​
picture
string
URL da imagem do canal
{
  "id": "123456789@newsletter",
  "name": "Canal de Notícias",
  "description": "Últimas notícias e atualizações",
  "followersCount": 1523,
  "picture": "https://..."
}

​
Códigos de Status

  • 200 - Informações obtidas com sucesso
  • 400 - ID inválido
  • 401 - Não autorizado
  • 404 - Canal não encontrado
  • 500 - Erro interno do servidor

​
Exemplo de Uso

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

Authorizations

​
apikey
string
header
required

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

Path Parameters

​
session
string
required

Nome da sessão (instanceName)

​
id
any
required

WhatsApp Channel ID or invite code from invite link https://www.whatsapp.com/channel/11111

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