cURL
curl --request POST \
--url https://api.pingmee.co.il/sendMessage \
--header 'Content-Type: application/json' \
--header 'Cookie: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"sender": "<string>",
"receiver": "<string>",
"participantsIdentifiers": "<string>",
"message": "<string>",
"type": "default",
"initiator": "person",
"messagePlatform": "whatsapp",
"context": {
"from": "<string>",
"id": "<string>"
},
"attachmentBase64": {
"resourceId": "<string>",
"fileName": "<string>",
"fileMimeType": "<string>",
"fileSize": 123,
"fileType": "<string>"
}
}
'import requests
url = "https://api.pingmee.co.il/sendMessage"
payload = {
"sender": "<string>",
"receiver": "<string>",
"participantsIdentifiers": "<string>",
"message": "<string>",
"type": "default",
"initiator": "person",
"messagePlatform": "whatsapp",
"context": {
"from": "<string>",
"id": "<string>"
},
"attachmentBase64": {
"resourceId": "<string>",
"fileName": "<string>",
"fileMimeType": "<string>",
"fileSize": 123,
"fileType": "<string>"
}
}
headers = {
"Cookie": "<api-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Cookie: '<api-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sender: '<string>',
receiver: '<string>',
participantsIdentifiers: '<string>',
message: '<string>',
type: 'default',
initiator: 'person',
messagePlatform: 'whatsapp',
context: {from: '<string>', id: '<string>'},
attachmentBase64: {
resourceId: '<string>',
fileName: '<string>',
fileMimeType: '<string>',
fileSize: 123,
fileType: '<string>'
}
})
};
fetch('https://api.pingmee.co.il/sendMessage', 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.pingmee.co.il/sendMessage",
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([
'sender' => '<string>',
'receiver' => '<string>',
'participantsIdentifiers' => '<string>',
'message' => '<string>',
'type' => 'default',
'initiator' => 'person',
'messagePlatform' => 'whatsapp',
'context' => [
'from' => '<string>',
'id' => '<string>'
],
'attachmentBase64' => [
'resourceId' => '<string>',
'fileName' => '<string>',
'fileMimeType' => '<string>',
'fileSize' => 123,
'fileType' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <api-key>",
"x-api-key: <api-key>"
],
]);
$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.pingmee.co.il/sendMessage"
payload := strings.NewReader("{\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"participantsIdentifiers\": \"<string>\",\n \"message\": \"<string>\",\n \"type\": \"default\",\n \"initiator\": \"person\",\n \"messagePlatform\": \"whatsapp\",\n \"context\": {\n \"from\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"attachmentBase64\": {\n \"resourceId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileMimeType\": \"<string>\",\n \"fileSize\": 123,\n \"fileType\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Cookie", "<api-key>")
req.Header.Add("x-api-key", "<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.pingmee.co.il/sendMessage")
.header("Cookie", "<api-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"participantsIdentifiers\": \"<string>\",\n \"message\": \"<string>\",\n \"type\": \"default\",\n \"initiator\": \"person\",\n \"messagePlatform\": \"whatsapp\",\n \"context\": {\n \"from\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"attachmentBase64\": {\n \"resourceId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileMimeType\": \"<string>\",\n \"fileSize\": 123,\n \"fileType\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pingmee.co.il/sendMessage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cookie"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"participantsIdentifiers\": \"<string>\",\n \"message\": \"<string>\",\n \"type\": \"default\",\n \"initiator\": \"person\",\n \"messagePlatform\": \"whatsapp\",\n \"context\": {\n \"from\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"attachmentBase64\": {\n \"resourceId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileMimeType\": \"<string>\",\n \"fileSize\": 123,\n \"fileType\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message_generated_id": "<string>",
"sentMessage": {
"message": "<string>",
"whatsappMessageResponse": {}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Messages
Send Message
Send a message
POST
/
sendMessage
cURL
curl --request POST \
--url https://api.pingmee.co.il/sendMessage \
--header 'Content-Type: application/json' \
--header 'Cookie: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"sender": "<string>",
"receiver": "<string>",
"participantsIdentifiers": "<string>",
"message": "<string>",
"type": "default",
"initiator": "person",
"messagePlatform": "whatsapp",
"context": {
"from": "<string>",
"id": "<string>"
},
"attachmentBase64": {
"resourceId": "<string>",
"fileName": "<string>",
"fileMimeType": "<string>",
"fileSize": 123,
"fileType": "<string>"
}
}
'import requests
url = "https://api.pingmee.co.il/sendMessage"
payload = {
"sender": "<string>",
"receiver": "<string>",
"participantsIdentifiers": "<string>",
"message": "<string>",
"type": "default",
"initiator": "person",
"messagePlatform": "whatsapp",
"context": {
"from": "<string>",
"id": "<string>"
},
"attachmentBase64": {
"resourceId": "<string>",
"fileName": "<string>",
"fileMimeType": "<string>",
"fileSize": 123,
"fileType": "<string>"
}
}
headers = {
"Cookie": "<api-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Cookie: '<api-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sender: '<string>',
receiver: '<string>',
participantsIdentifiers: '<string>',
message: '<string>',
type: 'default',
initiator: 'person',
messagePlatform: 'whatsapp',
context: {from: '<string>', id: '<string>'},
attachmentBase64: {
resourceId: '<string>',
fileName: '<string>',
fileMimeType: '<string>',
fileSize: 123,
fileType: '<string>'
}
})
};
fetch('https://api.pingmee.co.il/sendMessage', 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.pingmee.co.il/sendMessage",
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([
'sender' => '<string>',
'receiver' => '<string>',
'participantsIdentifiers' => '<string>',
'message' => '<string>',
'type' => 'default',
'initiator' => 'person',
'messagePlatform' => 'whatsapp',
'context' => [
'from' => '<string>',
'id' => '<string>'
],
'attachmentBase64' => [
'resourceId' => '<string>',
'fileName' => '<string>',
'fileMimeType' => '<string>',
'fileSize' => 123,
'fileType' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <api-key>",
"x-api-key: <api-key>"
],
]);
$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.pingmee.co.il/sendMessage"
payload := strings.NewReader("{\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"participantsIdentifiers\": \"<string>\",\n \"message\": \"<string>\",\n \"type\": \"default\",\n \"initiator\": \"person\",\n \"messagePlatform\": \"whatsapp\",\n \"context\": {\n \"from\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"attachmentBase64\": {\n \"resourceId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileMimeType\": \"<string>\",\n \"fileSize\": 123,\n \"fileType\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Cookie", "<api-key>")
req.Header.Add("x-api-key", "<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.pingmee.co.il/sendMessage")
.header("Cookie", "<api-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"participantsIdentifiers\": \"<string>\",\n \"message\": \"<string>\",\n \"type\": \"default\",\n \"initiator\": \"person\",\n \"messagePlatform\": \"whatsapp\",\n \"context\": {\n \"from\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"attachmentBase64\": {\n \"resourceId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileMimeType\": \"<string>\",\n \"fileSize\": 123,\n \"fileType\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pingmee.co.il/sendMessage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cookie"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sender\": \"<string>\",\n \"receiver\": \"<string>\",\n \"participantsIdentifiers\": \"<string>\",\n \"message\": \"<string>\",\n \"type\": \"default\",\n \"initiator\": \"person\",\n \"messagePlatform\": \"whatsapp\",\n \"context\": {\n \"from\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"attachmentBase64\": {\n \"resourceId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileMimeType\": \"<string>\",\n \"fileSize\": 123,\n \"fileType\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"message_generated_id": "<string>",
"sentMessage": {
"message": "<string>",
"whatsappMessageResponse": {}
}
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Personal access token from Pingmee Settings → Developer Tools
Business API key from Pingmee Settings → Developer Tools
Body
application/json
Sender identifier
Receiver identifier
Conversation participants identifiers
Message content
Available options:
default Available options:
person Messaging platform
Available options:
instagram, facebookMessenger, whatsapp Reply to an existing WhatsApp message
Show child attributes
Show child attributes
Base64 encoded media attachment
Show child attributes
Show child attributes
⌘I