Send document

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

import requests

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

payload = {
    "phone": "<string>",
    "document": "<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>', document: '<string>'})
};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-document/{extension}', 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-document/{extension}",
  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>',
    'document' => '<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-document/{extension}"

	payload := strings.NewReader("{\n  \"phone\": \"<string>\",\n  \"document\": \"<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-document/{extension}")
  .header("Client-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"<string>\",\n  \"document\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"document\": \"<string>\"\n}"

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

POST

instances

{instanceId}

token

{token}

send-document

{extension}

Send document

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

import requests

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

payload = {
    "phone": "<string>",
    "document": "<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>', document: '<string>'})
};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/send-document/{extension}', 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-document/{extension}",
  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>',
    'document' => '<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-document/{extension}"

	payload := strings.NewReader("{\n  \"phone\": \"<string>\",\n  \"document\": \"<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-document/{extension}")
  .header("Client-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"<string>\",\n  \"document\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"document\": \"<string>\"\n}"

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

Overview

Method responsible for sending documents to your contacts, it is simple and straightforward. You can work with documents in 2 ways:

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

Example on the application

Attributes

string

required

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

string

required

Your Z-API instance token.

Path

string

required

File extension being sent (e.g.: pdf, xlsx, docx)

Required

string

required

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

string

required

Document link or Base64

Optional

string

Document display name

string

File description

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 secShort intervals and bulk sending increase the risk of the number being blocked or banned. Before sending at volume, read the Best Practices Guide and Blocks and Bans.

string

Allows editing the description of a previously sent document through the caption field. Webhook configuration is required before use

Request Body

By link:

{
  "phone": "5511999999999",
  "document": "https://expoforest.com.br/wp-content/uploads/2017/05/example.pdf",
  "fileName": "My PDF"
}

By Base64:

{
  "phone": "5511999999999",
  "document": "data:application/pdf;base64,JVBERiN0YXJ0eHJlZg0KMjg3NDINCiUlRU9G0xLj...",
  "fileName": "My PDF"
}

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 the application

​Attributes

​Header

​Path

​Required

​Optional

​Request Body

​Response

​200

​405

​415

Overview

Example on the application

Attributes

Header

Path

Required

Optional

Request Body

Response

200

405

415