Sending Document Messages

Use this api to send document messages.

To send a document message, make a POST call to /messages and attach a message object with type=document .

Parameters

This is the main parameter used in send document message requests:

NameDescription

to

Required

WhatsApp ID or phone number for the person you want to send a message to.

The phone numbers in this requests can be provided in any dialable format, as long as they include their country code. It's recommended that you explicitly prefix the country code with a plus sign (+).

Here are some examples of supported phone number formats:

  • +1-000-000-0000
  • +1 (000) 000-0000
  • +1 000 000 0000
  • +1 (000) 000 0000

reply_message_id

Optional
You can send any message as a reply to a previous message in a conversation by including the previous message's ID. The recipient will receive the new message along with a contextual bubble that displays the previous message's content.

type

Required
The type of message you want to send. Set this as individual

document

.

document

Required
A document object.

document.id

Optional

Required

when you are not using a link.

The media object ID.

document.link

Optional

Required

when you are not using an uploaded media ID.

The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs.

document.caption

Optional

Describes the specified document.

document.filename

Optional

Describes the filename for the specific document.

Example

Sample request:

curl -X POST 'https://waofficial.botika.online/api/whatsapp/v1/messages' \
-H 'Authorization: Bearer {{ API_TOKEN }}' \
-H 'Content-Type: application/json' \
-d '{
    "to": "+62821xxxxxx",
    "reply_message_id": "{{ MESSAGE_ID }}",
    "type": "document",
    "document": {
        "id": "{{ MEDIA_ID }}",
        # OR "
        link": "http(s)://document-url",
        "caption": "DOCUMENT_CAPTION",
        "filename": "Example.pdf"
    }
}'

A successful response includes an object with an identifier for the message:

{
    "data": {
        "id": "{{ MESSAGE_ID }}"
    }
}

Copyright © 2023 Botika Teknologi Indonesia