Whatsapp Remote

Send Document

POST

/module/v1/message/send-document

Request

Query Params

device-secret

string

optional

This key for sending by specific device, found key on the customer dashboard page at Device Menu (Detail -> Secret). Copy and Paste here!

Example:

global-secret

string

optional

This key for sending by random device, found key on the customer dashboard page at Device Menu (Detail -> Global Secret). Copy and Paste here!

Example:

Header Params

x-device-secret

string

optional

false

Example:

x-global-secret

string

optional

Example:

Body Params application/json

string

required

Message recipient ID. It can be a Whatsapp number or Chat ID

file

string

required

File for send to message. You can use an audo URL or base64 string, size 10MB. only mimetype file .ogg

caption

string

required

Text message to be sent. Can be text characters or emojis

mimetype

string

required

Mimetype file on message view

file_name

string

required

File name on message view

Example

{
  "to": "6281234567890",
  "file": "https://static.whatspi.id/example/example-pdf.pdf",
  "caption": "Welcome back to WhatsPi",
  "mimetype": "application/pdf",
  "file_name": "whatspi.pdf"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/module/v1/message/send-document' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": "6281234567890",
    "file": "https://static.whatspi.id/example/example-pdf.pdf",
    "caption": "Welcome back to WhatsPi",
    "mimetype": "application/pdf",
    "file_name": "whatspi.pdf"
}'

Responses

🟢200OK

application/json

Body

success

boolean

required

API response status if success or failed

message

string

required

API response message

data

required

API response data

Example

{
  "success": true,
  "message": "Successfully",
  "data": "BAE505716AA91242"
}

🟠400Bad Request

🟠403Forbidden

🟠404Not Found

Modified at 2024-09-05 02:39:43

Send Sticker