Skip to main content
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>"
  }
}
'
{
  "temporaryMessageId": "<string>",
  "message_generated_id": "<string>",
  "sentMessage": {
    "message": "<string>",
    "whatsappMessageResponse": {}
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
sender
string
required

Sender identifier

receiver
string
required

Receiver identifier

participantsIdentifiers
string
required

Conversation participants identifiers

message
string
required

Message content

type
enum<string>
default:default
required
Available options:
default
initiator
enum<string>
default:person
required
Available options:
person
messagePlatform
enum<string>
default:whatsapp
required

Messaging platform

Available options:
instagram,
facebookMessenger,
whatsapp
context
object

Reply to an existing WhatsApp message

attachmentBase64
object

Base64 encoded media attachment

Response

Message sent successfully

temporaryMessageId
string
required

Client-side temporary message ID

message_generated_id
string
required

Platform-generated message ID

sentMessage
object

Returned only when initiator is bot or ai