Inscrever-se em eventos de presença para a conversa
curl --request POST \
--url https://{host}/api/{session}/presence/{chatId}/subscribe \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/{session}/presence/{chatId}/subscribe"
headers = {"apikey": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/{session}/presence/{chatId}/subscribe', 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}/presence/{chatId}/subscribe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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}/presence/{chatId}/subscribe"
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://{host}/api/{session}/presence/{chatId}/subscribe")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/{session}/presence/{chatId}/subscribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Subscrição de presença criada com sucesso",
"chatId": "5511999999999@s.whatsapp.net"
}
Presença
Subscrever Eventos de Presença do Chat
Subscrever para receber notificações de presença (online/offline) de um chat específico
POST
/
api
/
{session}
/
presence
/
{chatId}
/
subscribe
Inscrever-se em eventos de presença para a conversa
curl --request POST \
--url https://{host}/api/{session}/presence/{chatId}/subscribe \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/{session}/presence/{chatId}/subscribe"
headers = {"apikey": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/{session}/presence/{chatId}/subscribe', 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}/presence/{chatId}/subscribe",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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}/presence/{chatId}/subscribe"
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://{host}/api/{session}/presence/{chatId}/subscribe")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/{session}/presence/{chatId}/subscribe")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Subscrição de presença criada com sucesso",
"chatId": "5511999999999@s.whatsapp.net"
}
Descrição
Este endpoint permite subscrever para receber atualizações de presença (status online/offline) de um contato específico. Após a subscrição, você receberá eventos sempre que o contato ficar online ou offline.Parâmetros de URL
string
required
ID único da sessão WhatsApp
string
required
ID do chat/contato no formato
5511999999999@s.whatsapp.netResposta
{
"success": true,
"message": "Subscrição de presença criada com sucesso",
"chatId": "5511999999999@s.whatsapp.net"
}
Códigos de Status
200- Subscrição criada com sucesso400- Parâmetros inválidos401- Não autorizado404- Chat/Sessão não encontrado
Exemplo de Uso
curl -X POST https://api.wappfy.com.br/api/my-session/presence/5511999999999@s.whatsapp.net/subscribe
const session = 'my-session';
const chatId = '5511999999999@s.whatsapp.net';
const response = await fetch(`https://api.wappfy.com.br/api/${session}/presence/${chatId}/subscribe`, {
method: 'POST'
});
const data = await response.json();
console.log(data);
import requests
session = 'my-session'
chat_id = '5511999999999@s.whatsapp.net'
response = requests.post(
f'https://api.wappfy.com.br/api/{session}/presence/{chat_id}/subscribe'
)
data = response.json()
print(data)
Notas
- Após subscrever, você receberá eventos de presença através do stream de eventos
- Use o endpoint
/api/events/stream/{sessionId}para receber os eventos em tempo real - Os eventos informarão quando o contato ficar online (
AVAILABLE) ou offline (UNAVAILABLE) - Útil para implementar indicadores de status online em aplicações
