Whatsapp Messages API (pass-through)

POST

/v1/ext/plugin/whatsapp/{pluginId}/api/{whatstappApiVersion}/{whatsappPhoneNumberId}/message

The following API allows you to invoke the whatsapp messages api directly. The complete documentation for this api can be found here

Please note that chakra provides only a thin wrapper on top of the original whatsapp API.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

pluginId

string

required

The whatsapp plugin id where you have connected your whatsapp account. Its an UUID. You can copy it from the plugin details page url /admin/plugin/d83e1d23-50b8-4d87-8f92-842a0ac516f6 The last part of the url is the plugin id

Example:

d83e1d23-50b8-4d87-8f92-842a0ac516f6

whatstappApiVersion

string

required

The whatsapp api version you want to use like v17.0, v19.0 ...

Example:

v19.0

whatsappPhoneNumberId

string

required

Provide the whatsapp phone number id for the phone number you are going to use to send this message. Connected phone numbers and their Ids can be found in the plugin page

Body Params application/json

messaging_product

string

required

recipient_type

string

required

string

required

type

string

required

template

object

required

name

string

required

language

object

required

components

array [object {2}]

required

Example

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "919901258433",
  "type": "template",
  "template": {
    "name": "hello_world",
    "language": {
      "policy": "deterministic",
      "code": "en_US"
    },
    "components": [
      {
        "type": "body",
        "parameters": []
      }
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/ext/plugin/whatsapp/d83e1d23-50b8-4d87-8f92-842a0ac516f6/api/v19.0//message' \
--header 'Content-Type: application/json' \
--data-raw '{
	"messaging_product": "whatsapp",
	"recipient_type": "individual",
	"to": "919901258433",
	"type": "template",
	"template": {
		"name": "hello_world",
		"language": {
			"policy": "deterministic",
			"code": "en_US"
		},
		"components": [
			{
				"type": "body",
				"parameters": [
				]
			}
		]
	}
}'

Responses

🟢200Success

application/json

Body

_data

object

required

whatsappMessageId

string

required

Example

{
  "_data": {
    "whatsappMessageId": "wamid.HBgMOTE5OTAxMjU4NDMzFQIAERgSREM5NDZGMjRFNzc1QUFDOEExAA=="
  }
}

Modified at 2024-11-04 17:29:16

Upload Public Media

Fetch Process By Id