Obter todas as etiquetas
curl --request GET \
--url https://{host}/api/{session}/labels \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/{session}/labels"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/{session}/labels', 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}/labels",
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}/labels"
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))
}HttpResponse<String> response = Unirest.get("https://{host}/api/{session}/labels")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/{session}/labels")
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{
"labels": [
{
"id": "label123",
"name": "Clientes VIP",
"color": 1
},
{
"id": "label456",
"name": "Suporte",
"color": 2
}
]
}
Etiquetas
Listar Todos os Rótulos
Listar todos os rótulos criados na sessão
GET
/
api
/
{session}
/
labels
Obter todas as etiquetas
curl --request GET \
--url https://{host}/api/{session}/labels \
--header 'apikey: <api-key>'import requests
url = "https://{host}/api/{session}/labels"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{host}/api/{session}/labels', 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}/labels",
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}/labels"
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))
}HttpResponse<String> response = Unirest.get("https://{host}/api/{session}/labels")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/{session}/labels")
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{
"labels": [
{
"id": "label123",
"name": "Clientes VIP",
"color": 1
},
{
"id": "label456",
"name": "Suporte",
"color": 2
}
]
}
Descrição
Este endpoint retorna todos os rótulos (labels) criados na sessão WhatsApp, permitindo visualizar todas as categorias disponíveis para organização de chats.Parâmetros de URL
string
required
ID único da sessão WhatsApp
Resposta
array
Lista de todos os rótulos criados
{
"labels": [
{
"id": "label123",
"name": "Clientes VIP",
"color": 1
},
{
"id": "label456",
"name": "Suporte",
"color": 2
}
]
}
Códigos de Status
200- Lista retornada com sucesso400- Parâmetros inválidos401- Não autorizado
Exemplo de Uso
curl -X GET https://api.wappfy.com.br/api/my-session/labels
const session = 'my-session';
const response = await fetch(`https://api.wappfy.com.br/api/${session}/labels`);
const data = await response.json();
console.log(data.labels);
import requests
session = 'my-session'
response = requests.get(f'https://api.wappfy.com.br/api/{session}/labels')
data = response.json()
print(data['labels'])
Authorizations
Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)
Path Parameters
Nome da sessão (instanceName)
