External APISend Messages API

API Endpoints

Send WhatsApp Template Messages

This API allows external systems to send WhatsApp Template Messages through WappCloud’s platform.

Endpoint

POST https://client-api.wappcloud.com/api/v1/external/process

Headers

HeaderDescription
x-api-key(Required) Your API Key for authentication.
AuthorizationPass Bearer Token.
Content-Typeapplication/json

Setting Up the Request Body in Postman

  • In Postman, select the Body tab.

  • Choose raw.

  • From the dropdown, select JSON.

  • Paste your JSON payload in the text area.

Template Request Payloads

1. Static Template

{
  "contact_number": "+919876541230",
  "message_uid": "1234",          // optional
  "message": {
    "template_name": "hello_world"
  }
}

2. Dynamic Text Header and Body

{
  "contact_number": "+919876541230",
  "message_uid": "1234",          // optional
  "message": {
    "template_name": "sample_v9",
    "header": {
      "type": "text",
      "text": "sample"
    },
    "body": {
      "variables": {
        "1": "John Doe",
        "2": "Gojo"
      }
    }
  }
}

3. Dynamic Header Image

{
  "contact_number": "+919876541230",
  "message_uid": "1234",          // optional
  "message": {
    "template_name": "img1",
    "header": {
      "type": "image",
      "url": "https://example.com/image.png"
    }
  }
}

4. Dynamic Button

{
  "contact_number": "+919876541230",
  "message_uid": "1234",          // optional
  "message": {
    "template_name": "dynamic_button_v1",
    "buttons": [
      {
        "type": "url",
        "text": "1223454"
      }
    ]
  }
}

Response (Success)

{
  "code": 200,
  "success": true,
  "data": {
    "message_uid": "DSFDS223432432"
  },
  "message": "Request processed and messages sent successfully."
}

Notes

  • Do not change field names — they must match exactly (contact_number, message, template_name, etc.).

  • Contact number must start with + and include country code. No dashes or spaces. Example: +919876541230.

  • message_uid is optional.

  • Template names must match exactly as configured in Meta WhatsApp Business Manager.

  • For templates, variable order must follow (1, 2, 3, …).


WhatsApp Direct Messaging API

This API allows external systems to send direct text and media messages through WappCloud’s platform.

Endpoint

POST https://client-api.wappcloud.com/api/v1/external/process

Headers

HeaderDescription
x-api-key(Required) Your API Key for authentication.
AuthorizationPass Bearer Token.
Content-Typemultipart/form-data (for media) or application/json (for text)

Text Message — Request Payload

{
  "contact_number": "+919876541230",
  "messageType": "text",
  "message": {
    "messageBody": "Hello, this is a test message"
  }
}

Text Message — Response (Success)

{
  "success": true,
  "code": 200,
  "message": "Message sent successfully"
}

Media Messages (Image, Video, Document, Audio)

To send media, use form-data in Postman:

  • Go to the Body tab.

  • Select form-data.

  • Add the following fields:

KeyValue (Example)Type
chatMediaUpload your file (image, video, or document)File
messageTypefileText
mediaTypeimage (or video, audio, document)Text
contact_number+919876541230Text

Media Response (Success)

{
  "success": true,
  "code": 200,
  "message": "Message sent successfully"
}

Notes:

  • Do not change field names — they must match exactly (contact_number, messageType, mediaType, chatMedia).

  • Contact number must start with + and include country code. No dashes or spaces. Example: +919876541230.

  • For media messages, use form-data instead of raw JSON.

  • Supported media types: image, video, document, audio.

  • Make sure to set the correct mediaType that matches your uploaded file type.