curl --request GET \
--url https://api.zappaz.io/api/v1/session/{sessionId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.zappaz.io/api/v1/session/{sessionId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.zappaz.io/api/v1/session/{sessionId}', 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://api.zappaz.io/api/v1/session/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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://api.zappaz.io/api/v1/session/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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://api.zappaz.io/api/v1/session/{sessionId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zappaz.io/api/v1/session/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "05f02fa6-d7b0-4120-9f08-f60cd7337c72",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"displayName": "Zappaz - Prod",
"status": "open",
"jid": "5519981979779@s.whatsapp.net",
"profilePictureUrl": "https://pps.whatsapp.net/v/t61.24694-24/...",
"enabled": true,
"archived": true,
"disconnectedAt": "2023-11-07T05:31:56Z",
"connectedAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"workerNodeId": "<string>",
"stripeSubscription": {
"id": "<string>",
"subscriptionId": "<string>",
"waSessionId": "<string>",
"status": "<string>",
"customerId": "<string>",
"subscriptionItemId": "<string>",
"subscriptionItemAmount": 123,
"latestInvoice": "<string>",
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"trialEnd": "2023-11-07T05:31:56Z",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"config": {
"messageOnCall": "<string>",
"rejectCalls": false,
"ignoreGroups": false,
"syncFullHistory": false,
"markOnlineOnConnect": false,
"clientConnectionName": "<string>"
}
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}Get session details
Recupera detalhes de uma sessão específica, incluindo informações opcionais de assinatura
curl --request GET \
--url https://api.zappaz.io/api/v1/session/{sessionId} \
--header 'Authorization: <api-key>'import requests
url = "https://api.zappaz.io/api/v1/session/{sessionId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.zappaz.io/api/v1/session/{sessionId}', 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://api.zappaz.io/api/v1/session/{sessionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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://api.zappaz.io/api/v1/session/{sessionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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://api.zappaz.io/api/v1/session/{sessionId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zappaz.io/api/v1/session/{sessionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "05f02fa6-d7b0-4120-9f08-f60cd7337c72",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"displayName": "Zappaz - Prod",
"status": "open",
"jid": "5519981979779@s.whatsapp.net",
"profilePictureUrl": "https://pps.whatsapp.net/v/t61.24694-24/...",
"enabled": true,
"archived": true,
"disconnectedAt": "2023-11-07T05:31:56Z",
"connectedAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"workerNodeId": "<string>",
"stripeSubscription": {
"id": "<string>",
"subscriptionId": "<string>",
"waSessionId": "<string>",
"status": "<string>",
"customerId": "<string>",
"subscriptionItemId": "<string>",
"subscriptionItemAmount": 123,
"latestInvoice": "<string>",
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"trialEnd": "2023-11-07T05:31:56Z",
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"config": {
"messageOnCall": "<string>",
"rejectCalls": false,
"ignoreGroups": false,
"syncFullHistory": false,
"markOnlineOnConnect": false,
"clientConnectionName": "<string>"
}
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}Authorizations
Token de usuário ou sessão, passado diretamente como uma string no cabeçalho 'Authorization'. O token de usuário tem escopo sobre todas as sessões pertencentes ao usuário. O token de sessão é limitado à própria sessão.
Path Parameters
Identificador único da sessão
Query Parameters
Se deve incluir informações de assinatura na resposta
Response
Detalhes da sessão recuperados com sucesso
Identificador único da sessão
"05f02fa6-d7b0-4120-9f08-f60cd7337c72"
Token JWT da sessão
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Nome de exibição da sessão
"Zappaz - Prod"
Status atual da sessão
"open"
JID do WhatsApp da sessão
"5519981979779@s.whatsapp.net"
URL da foto de perfil do WhatsApp
"https://pps.whatsapp.net/v/t61.24694-24/..."
Se a sessão está habilitada
Se a sessão está arquivada
Data da última desconexão
Data da última conexão
ID do usuário proprietário da sessão
ID do nó do worker
Informações da assinatura Stripe (apenas quando includeSubscription=true)
Show child attributes
Show child attributes
Configurações da sessão
Show child attributes
Show child attributes

