Send text messages, multimedia content/documents and message templates to your customers.

POST

messages

object

recipient_type

string

type

string

preview_url

boolean

text

object

body

string

image

object

string

link

string

caption

string

filename

string

provider

string

document

object

string

link

string

caption

string

filename

string

provider

string

audio

object

string

link

string

caption

string

filename

string

provider

string

video

object

string

link

string

caption

string

filename

string

provider

string

contacts

array

location

object

longitude

number

latitude

number

name

string

address

string

interactive

object

type

enum<string>

header

object

type

enum<string>

text

string

video

object

string

link

string

caption

string

filename

string

provider

string

image

object

string

link

string

caption

string

filename

string

provider

string

document

object

string

link

string

caption

string

filename

string

provider

string

body

object

text

string

footer

object

text

string

action

object

button

string

buttons

array

sections

array

catalog_id

string

template

object

namespace

string

name

string

language

object

policy

string

code

string

components

array

curl --request POST \
  --url https://docs0.lafricamobile.com/dev/whatsapp/messages \
  --header 'Content-Type: application/json' \
  --header 'LAM-API-KEY: <lam-api-key>' \
  --data '{
  "recipient_type": "individual",
  "to": 221771234567,
  "type": "text",
  "text": {
    "body": "Hello Mr. John Doe."
  }
}'

Headers

LAM-API-KEY

string

required

Body

application/json

string

required

The WhatsApp ID for the recipient of your message.

type

string

required

The type of message you would like to send.

recipient_type

string

The type of recipient the message is being sent to.

preview_url

boolean

Allows for URL previews in text messages (Only used with messages of text type.)

text

object

Contains a text object (Required for messages of text type).

image

object

Required when type is audio, document, image or video. Do not use this field when message type is set to text

document

object

Required when type is audio, document, image or video. Do not use this field when message type is set to text

audio

object

Required when type is audio, document, image or video. Do not use this field when message type is set to text

video

object

Required when type is audio, document, image or video. Do not use this field when message type is set to text

contacts

object[]

Required when type is contacts.

location

object

Required when type is location.

interactive

object

Required when type is interactive. Usually contains four main components (header, body, footer and action).

template

object

Required when message type is "template". Do not use this field when message type is set to text

Response

201 - application/json

contacts

object[]

messages

object[]

WhatsApp Business

Headers

Body

Response