Skip to main content
POST
/
api
/
{session}
/
channels
Criar um novo canal
curl --request POST \
  --url https://{host}/api/{session}/channels \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "name": "Channel Name",
  "description": "Channel Description",
  "picture": {
    "mimetype": "image/jpeg",
    "url": "https://github.com/stgcompany/wappfy/raw/core/examples/wappfy.jpg",
    "filename": "filename.jpg"
  }
}
'
{
  "name": "Meu Canal",
  "description": "Canal de notícias e atualizações",
  "picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}

​
Descrição

Este endpoint permite criar um novo canal no WhatsApp. Canais são recursos que permitem transmitir mensagens para um grande número de seguidores de forma unidirecional.

​
Parâmetros de URL

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

​
Corpo da Requisição

​
name
string
required
Nome do canal a ser criado
​
description
string
required
Descrição do canal que aparecerá para os seguidores
​
picture
string
Imagem do canal codificada em base64 (opcional)

​
Resposta

​
success
boolean
Indica se o canal foi criado com sucesso
{
  "name": "Meu Canal",
  "description": "Canal de notícias e atualizações",
  "picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
}

​
Códigos de Status

  • 200 - Canal criado com sucesso
  • 400 - Parâmetros inválidos ou faltando
  • 401 - Não autorizado
  • 500 - Erro interno do servidor

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/my-session/channels \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Meu Canal",
    "description": "Canal de notícias e atualizações",
    "picture": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="
  }'

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)

Body

application/json
​
name
string
required
Example:

"Channel Name"

​
description
string
Example:

"Channel Description"

​
picture
object

Response

201 - 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