Whatsapp Remote

Send Contacts

POST

/module/v1/message/send-contacts

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

contacts

array [object {3}]

required

List contacts for sending on message

>= 1 items<= 10 items

full_name

string

required

Full name contact

organization

string

required

Organization contact

phone_number

string

required

Phone Number contact

Example

{
    "to": "6281234567890",
    "contacts": [
        {
            "full_name": "Jhon Doe",
            "organization": "WhatsPi",
            "phone_number": "6281234567891"
        },
        {
            "full_name": "Jane Doe",
            "organization": "WhatsPi",
            "phone_number": "6281234567892"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/module/v1/message/send-contacts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "to": "6281234567890",
    "contacts": [
        {
            "full_name": "Jhon Doe",
            "organization": "WhatsPi",
            "phone_number": "6281234567891"
        },
        {
            "full_name": "Jane Doe",
            "organization": "WhatsPi",
            "phone_number": "6281234567892"
        }
    ]
}'

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

Send Location

Send Image