Send sticker

curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "sticker": "<string>"
}
'

import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker"

payload = {
    "phone": "<string>",
    "sticker": "<string>"
}
headers = {
    "Client-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone: '<string>', sticker: '<string>'})
};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker', 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}/send-sticker",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone' => '<string>',
    'sticker' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker"

	payload := strings.NewReader("{\n  \"phone\": \"<string>\",\n  \"sticker\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Client-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker")
  .header("Client-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"<string>\",\n  \"sticker\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker")

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

request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone\": \"<string>\",\n  \"sticker\": \"<string>\"\n}"

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

POST

instances

{instanceId}

token

{token}

send-sticker

Send sticker

curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "<string>",
  "sticker": "<string>"
}
'

import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker"

payload = {
    "phone": "<string>",
    "sticker": "<string>"
}
headers = {
    "Client-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phone: '<string>', sticker: '<string>'})
};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker', 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}/send-sticker",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'phone' => '<string>',
    'sticker' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker"

	payload := strings.NewReader("{\n  \"phone\": \"<string>\",\n  \"sticker\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Client-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker")
  .header("Client-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"<string>\",\n  \"sticker\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/send-sticker")

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

request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phone\": \"<string>\",\n  \"sticker\": \"<string>\"\n}"

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

Overview

Method responsible for sending stickers to your chats. You can work with stickers in 2 ways:

By Link: if you have the sticker hosted somewhere on the internet, just send the link;
By Base64: if you want to send the sticker in Base64 format.

If you choose Base64, before the binary you need to add the following expression: data:image/png;base64, followed by your Base64 code.You can verify if the Base64 is correct by pasting it into your browser’s address bar.

Example on WhatsApp

Attributes

string

required

Your instance ID. Available in the Z-API panel under Instances.

string

required

Your Z-API instance token.

Required

string

required

Recipient’s phone number (or group ID for group messages) in DDI DDD NUMBER format. E.g.: 551199999999

string

required

Sticker link or Base64

Optional

string

Attribute used to reply to a chat message, just add the messageId of the message you want to reply to

number

Delay added to the message. You can choose between a range of 1 to 15 sec, meaning how many seconds it will wait before sending the next message. (E.g.: “delayMessage”: 5). The default delay if not provided is 1 to 3 sec

string

Sticker author name

Request Body

By link:

{
  "phone": "5511999999999",
  "sticker": "https://example.com/sticker.png"
}

By Base64:

{
  "phone": "5511999999999",
  "sticker": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAyAAAAMgCAIAAABUEpE..."
}

Response

200

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.

​Overview

​Example on WhatsApp

​Attributes

​Header

​Required

​Optional

​Request Body

​Response

​200

​405

​415

Overview

Example on WhatsApp

Attributes

Header

Required

Optional

Request Body

Response

200

405

415