Send File / Media

POST

send

file

Send File / Media

curl --request POST \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/send/file \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data apiToken=API-KEY \
  --data phone_number_id=PHONE-NUMBER-ID \
  --data phone_number=PHONE-NUMBER \
  --data media_url=https://example.com/image.jpg \
  --data media_id=1739230482390482 \
  --data media_type=image \
  --data media_name=invoice.pdf \
  --data 'media_caption_text=Here'\''s your invoice'

import requests

url = "https://platform.chatsyncs.com/api/v1/whatsapp/send/file"

payload = {
    "apiToken": "API-KEY",
    "phone_number_id": "PHONE-NUMBER-ID",
    "phone_number": "PHONE-NUMBER",
    "media_url": "https://example.com/image.jpg",
    "media_id": "1739230482390482",
    "media_type": "image",
    "media_name": "invoice.pdf",
    "media_caption_text": "Here's your invoice"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams({
    apiToken: 'API-KEY',
    phone_number_id: 'PHONE-NUMBER-ID',
    phone_number: 'PHONE-NUMBER',
    media_url: 'https://example.com/image.jpg',
    media_id: '1739230482390482',
    media_type: 'image',
    media_name: 'invoice.pdf',
    media_caption_text: 'Here\'s your invoice'
  })
};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/send/file', 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://platform.chatsyncs.com/api/v1/whatsapp/send/file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_url=https%3A%2F%2Fexample.com%2Fimage.jpg&media_id=1739230482390482&media_type=image&media_name=invoice.pdf&media_caption_text=Here%27s%20your%20invoice",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$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://platform.chatsyncs.com/api/v1/whatsapp/send/file"

	payload := strings.NewReader("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_url=https%3A%2F%2Fexample.com%2Fimage.jpg&media_id=1739230482390482&media_type=image&media_name=invoice.pdf&media_caption_text=Here%27s%20your%20invoice")

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

	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.chatsyncs.com/api/v1/whatsapp/send/file")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_url=https%3A%2F%2Fexample.com%2Fimage.jpg&media_id=1739230482390482&media_type=image&media_name=invoice.pdf&media_caption_text=Here%27s%20your%20invoice")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/send/file")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_url=https%3A%2F%2Fexample.com%2Fimage.jpg&media_id=1739230482390482&media_type=image&media_name=invoice.pdf&media_caption_text=Here%27s%20your%20invoice"

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

{
  "status": "1",
  "wa_message_id": "wamid.HBgNODgwMTcyMzMwOTAwMxUCABEYEjlGQkY3MEFEMEVGODhCNDkxNQA=",
  "message": "Message sent successfully."
}

Sends an image, video, audio, or document to a WhatsApp number — the single endpoint for all media types.

You must provide either media_url or media_id — at least one is required.

Sending a document

A document also needs media_name — the filename the recipient sees. Without it the API answers media_name is required when media_type is document.

With media_url, any filename is accepted. Use the last part of the URL, such as invoice.pdf.
With media_id, pass the media_name that Upload Media returned.
media_name is only for documents. Leave it out for images, video and audio.

curl -X POST 'https://platform.chatsyncs.com/api/v1/whatsapp/send/file' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID' \
  -d 'phone_number=PHONE-NUMBER' \
  -d 'media_type=document' \
  -d 'media_name=invoice.pdf' \
  --data-urlencode 'media_url=https://example.com/invoice.pdf'

The response includes the wa_message_id, which you can pass to Get Delivery Message Status.

Body

application/x-www-form-urlencoded

apiToken

string

required

Your ChatSyncs API key (not a WhatsApp/Meta access token). Where to find it.

Example:

"API-KEY"

phone_number_id

string

required

The WhatsApp account's phone number ID. Where to find it.

Example:

"PHONE-NUMBER-ID"

phone_number

string

required

The subscriber's phone number, with country code, digits only.

Example:

"PHONE-NUMBER"

media_url

string

Public HTTPS URL of the file. Required if media_id isn't set.

Example:

"https://example.com/image.jpg"

media_id

string

A WhatsApp media ID from Upload Media or Graph. Required if media_url isn't set; requires media_type when used alone.

Example:

"1739230482390482"

media_type

string

One of image, video, audio, document. Required when using media_id alone, or when media_url has no file extension.

Example:

"image"

media_name

string

The filename shown to the recipient. Required when media_type is document (also when the type is inferred from the URL); not used for image, video or audio. With media_url any filename is accepted, such as the last part of the URL; with a media_id, pass the media_name that Upload Media returned.

Example:

"invoice.pdf"

media_caption_text

string

Caption for an image, video, or document (not supported for audio). Falls back to message if omitted.

Example:

"Here's your invoice"

Response

Standard ChatSyncs response. status is "1" on success and "0" on failure.

status

string

"1" = success, "0" = failure.

message

string

Human-readable result message.

Send File / Media

curl --request POST \
  --url https://platform.chatsyncs.com/api/v1/whatsapp/send/file \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data apiToken=API-KEY \
  --data phone_number_id=PHONE-NUMBER-ID \
  --data phone_number=PHONE-NUMBER \
  --data media_url=https://example.com/image.jpg \
  --data media_id=1739230482390482 \
  --data media_type=image \
  --data media_name=invoice.pdf \
  --data 'media_caption_text=Here'\''s your invoice'

import requests

url = "https://platform.chatsyncs.com/api/v1/whatsapp/send/file"

payload = {
    "apiToken": "API-KEY",
    "phone_number_id": "PHONE-NUMBER-ID",
    "phone_number": "PHONE-NUMBER",
    "media_url": "https://example.com/image.jpg",
    "media_id": "1739230482390482",
    "media_type": "image",
    "media_name": "invoice.pdf",
    "media_caption_text": "Here's your invoice"
}
headers = {"Content-Type": "application/x-www-form-urlencoded"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/x-www-form-urlencoded'},
  body: new URLSearchParams({
    apiToken: 'API-KEY',
    phone_number_id: 'PHONE-NUMBER-ID',
    phone_number: 'PHONE-NUMBER',
    media_url: 'https://example.com/image.jpg',
    media_id: '1739230482390482',
    media_type: 'image',
    media_name: 'invoice.pdf',
    media_caption_text: 'Here\'s your invoice'
  })
};

fetch('https://platform.chatsyncs.com/api/v1/whatsapp/send/file', 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://platform.chatsyncs.com/api/v1/whatsapp/send/file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_url=https%3A%2F%2Fexample.com%2Fimage.jpg&media_id=1739230482390482&media_type=image&media_name=invoice.pdf&media_caption_text=Here%27s%20your%20invoice",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$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://platform.chatsyncs.com/api/v1/whatsapp/send/file"

	payload := strings.NewReader("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_url=https%3A%2F%2Fexample.com%2Fimage.jpg&media_id=1739230482390482&media_type=image&media_name=invoice.pdf&media_caption_text=Here%27s%20your%20invoice")

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

	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.chatsyncs.com/api/v1/whatsapp/send/file")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_url=https%3A%2F%2Fexample.com%2Fimage.jpg&media_id=1739230482390482&media_type=image&media_name=invoice.pdf&media_caption_text=Here%27s%20your%20invoice")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.chatsyncs.com/api/v1/whatsapp/send/file")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&media_url=https%3A%2F%2Fexample.com%2Fimage.jpg&media_id=1739230482390482&media_type=image&media_name=invoice.pdf&media_caption_text=Here%27s%20your%20invoice"

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

{
  "status": "1",
  "wa_message_id": "wamid.HBgNODgwMTcyMzMwOTAwMxUCABEYEjlGQkY3MEFEMEVGODhCNDkxNQA=",
  "message": "Message sent successfully."
}

Get Started

WhatsApp API

Subscriber API

Label API

Catalog API

User API

Sending a document

Body

Response

​Sending a document

Body

Response

Sending a document