Visualizar Mensagens do Canal

Visualizar mensagens do canal

curl --request GET \
  --url https://{host}/api/{session}/channels/{id}/messages/preview \
  --header 'apikey: <api-key>'

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{host}/api/{session}/channels/{id}/messages/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/{session}/channels/{id}/messages/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/{session}/channels/{id}/messages/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/{session}/channels/{id}/messages/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "messages": [
    {
      "id": "msg_123",
      "content": "Bem-vindo ao nosso canal!",
      "timestamp": 1672531200
    },
    {
      "id": "msg_124",
      "content": "Confira as novidades desta semana",
      "timestamp": 1672617600
    }
  ]
}

GET

api

{session}

channels

{id}

messages

preview

Visualizar mensagens do canal

curl --request GET \
  --url https://{host}/api/{session}/channels/{id}/messages/preview \
  --header 'apikey: <api-key>'

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{host}/api/{session}/channels/{id}/messages/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/{session}/channels/{id}/messages/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/{session}/channels/{id}/messages/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/api/{session}/channels/{id}/messages/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "messages": [
    {
      "id": "msg_123",
      "content": "Bem-vindo ao nosso canal!",
      "timestamp": 1672531200
    },
    {
      "id": "msg_124",
      "content": "Confira as novidades desta semana",
      "timestamp": 1672617600
    }
  ]
}

Descrição

Este endpoint permite visualizar uma prévia das mensagens de um canal sem precisar segui-lo. É útil para ver o conteúdo do canal antes de decidir se deseja segui-lo.

Parâmetros de URL

string

required

ID único da sessão WhatsApp autenticada

string

required

ID único do canal que deseja visualizar as mensagens

Parâmetros de Query

string

required

Código de convite do canal

number

default:"10"

Número máximo de mensagens a retornar (padrão: 10)

Resposta

array

Array contendo as mensagens do canal

Show Propriedades da mensagem

string

ID único da mensagem

string

Conteúdo da mensagem

number

Timestamp da mensagem

{
  "messages": [
    {
      "id": "msg_123",
      "content": "Bem-vindo ao nosso canal!",
      "timestamp": 1672531200
    },
    {
      "id": "msg_124",
      "content": "Confira as novidades desta semana",
      "timestamp": 1672617600
    }
  ]
}

Códigos de Status

200 - Prévia obtida com sucesso
400 - Parâmetros inválidos ou faltando código de convite
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/messages/preview?invite=ABC123&limit=10"

const session = 'my-session';
const channelId = '123456789@newsletter';
const invite = 'ABC123';
const limit = 10;
const response = await fetch(
  `https://api.wappfy.com.br/api/${session}/channels/${channelId}/messages/preview?invite=${invite}&limit=${limit}`
);
const data = await response.json();
console.log(data.messages);

import requests

session = 'my-session'
channel_id = '123456789@newsletter'
invite = 'ABC123'
limit = 10
response = requests.get(
  f'https://api.wappfy.com.br/api/{session}/channels/{channel_id}/messages/preview',
  params={'invite': invite, 'limit': limit}
)
data = response.json()
print(data['messages'])

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)

Query Parameters

downloadMedia

boolean

default:false

required

limit

number

default:10

required

Response

200 - application/json

reactions

object

required

Show child attributes

Example:

{ "👍": 10, "❤️": 5 }

message

object

required

Show child attributes

viewCount

number

required

Status

Início

Integrações

Autenticação

Sessões

Mensagens

Conversas

Contatos

Grupos

Etiquetas

Status

Canais

Presença

Perfil

Eventos

Descrição

Parâmetros de URL

Parâmetros de Query

Resposta

Códigos de Status

Exemplo de Uso

Authorizations

Path Parameters

Query Parameters

Response

​Descrição

​Parâmetros de URL

​Parâmetros de Query

​Resposta

​Códigos de Status

​Exemplo de Uso

Authorizations

Path Parameters

Query Parameters

Response

Descrição

Parâmetros de URL

Parâmetros de Query

Resposta

Códigos de Status

Exemplo de Uso