Instance data
curl --request GET \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/me \
--header 'Client-Token: <api-key>'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/me"
headers = {"Client-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/me', 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.z-api.io/instances/{instanceId}/token/{token}/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Client-Token: <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.z-api.io/instances/{instanceId}/token/{token}/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-Token", "<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.z-api.io/instances/{instanceId}/token/{token}/me")
.header("Client-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"token": "<string>",
"name": "<string>",
"due": 123,
"connected": true,
"paymentStatus": "<string>",
"created": "<string>",
"connectedCallbackUrl": "<string>",
"deliveryCallbackUrl": "<string>",
"disconnectedCallbackUrl": "<string>",
"messageStatusCallbackUrl": "<string>",
"presenceChatCallbackUrl": "<string>",
"receivedCallbackUrl": "<string>",
"receiveCallbackSentByMe": true,
"callRejectAuto": true,
"callRejectMessage": "<string>",
"autoReadMessage": true,
"initialDataCallbackUrl": "<string>",
"proxyUrl": "<string>",
"useProxy": true,
"announcementGuard": true
}Instance
Instance data
Returns the instance data and settings
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
me
Instance data
curl --request GET \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/me \
--header 'Client-Token: <api-key>'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/me"
headers = {"Client-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/me', 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.z-api.io/instances/{instanceId}/token/{token}/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Client-Token: <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.z-api.io/instances/{instanceId}/token/{token}/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-Token", "<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.z-api.io/instances/{instanceId}/token/{token}/me")
.header("Client-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"token": "<string>",
"name": "<string>",
"due": 123,
"connected": true,
"paymentStatus": "<string>",
"created": "<string>",
"connectedCallbackUrl": "<string>",
"deliveryCallbackUrl": "<string>",
"disconnectedCallbackUrl": "<string>",
"messageStatusCallbackUrl": "<string>",
"presenceChatCallbackUrl": "<string>",
"receivedCallbackUrl": "<string>",
"receiveCallbackSentByMe": true,
"callRejectAuto": true,
"callRejectMessage": "<string>",
"autoReadMessage": true,
"initialDataCallbackUrl": "<string>",
"proxyUrl": "<string>",
"useProxy": true,
"announcementGuard": true
}Overview
This method returns your instance data and settings.Attributes
Header
Response
200
Defines whether the instance with the anti-fraud protection feature in warning groups is active.
{
"id": "123456",
"token": "abcdef-ghij-klmn-opqr",
"name": "My instance",
"due": 1700000000,
"connected": true,
"paymentStatus": "ACTIVE",
"created": "2024-01-01T00:00:00.000Z",
"connectedCallbackUrl": "https://mysite.com/webhook/connected",
"deliveryCallbackUrl": "https://mysite.com/webhook/delivery",
"disconnectedCallbackUrl": "https://mysite.com/webhook/disconnected",
"messageStatusCallbackUrl": "https://mysite.com/webhook/message-status",
"presenceChatCallbackUrl": "https://mysite.com/webhook/presence",
"receivedCallbackUrl": "https://mysite.com/webhook/received",
"receiveCallbackSentByMe": false,
"callRejectAuto": false,
"callRejectMessage": "",
"autoReadMessage": false,
"initialDataCallbackUrl": "",
"proxyUrl": "socks5://user:senha123@localhost:1080",
"useProxy": true,
"announcementGuard": true
}