API Documentation - WhatsApp Gateway & Bot Otomatisasi

Endpoint

ENDPOINTS V1 (BY NUMBER)

Send Text Message
Send Message Modify
Send Media
Send Voice Note
Send Document
Send Album
Send Contact
Send Button Message

ENDPOINTS V2 (BY JID)

Send Text Message (JID)
Send Message Modify (JID)
Send Media (JID)
Send Voice Note (JID)
Send Document (JID)
Send Album (JID)
Send Contact (JID)
Send Button Message (JID)

POST/v1/text

Send Text Message

Sends a plain text message.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`number`	`string`	Required	Recipient number with country code (e.g., 62812xxxx).
`text`	`string`	Required	The message content.

numberstring

Required

Recipient number with country code (e.g., 62812xxxx).

textstring

Required

The message content.

Example (cURL)

curl -X POST '__BASE_URL__/v1/text' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number": "6281234567890",
    "text": "Hello, this is a test message."
  }'

POST/v1/modify

Send Message Modify

Sends a text message with a custom thumbnail and link preview.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`number`	`string`	Required	Recipient number.
`text`	`string`	Required	The message content.
`title`	`string`	Optional	Title for the link preview.
`thumbnail`	`string`	Required	URL of the thumbnail image.
`url`	`string`	Optional	Target URL for the link preview.

numberstring

Required

Recipient number.

textstring

Required

The message content.

titlestring

Optional

Title for the link preview.

thumbnailstring

Required

URL of the thumbnail image.

urlstring

Optional

Target URL for the link preview.

Notes

Useful for sending messages that look like link previews.

Example (cURL)

curl -X POST '__BASE_URL__/v1/modify' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number": "6281234567890",
    "text": "Test!",
    "title": "© neoxr-bot",
    "thumbnail": "https://iili.io/HP3ODj2.jpg",
    "url": "https://chat.whatsapp.com/HYknAquOTrECm9KPJJQO1V"
  }'

POST/v1/media

Send Media

Sends a media file from a URL.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`number`	`string`	Required	Recipient number.
`url`	`string`	Required	Public URL of the image/video.
`caption`	`string`	Optional	Caption for the media.

numberstring

Required

Recipient number.

urlstring

Required

Public URL of the image/video.

captionstring

Optional

Caption for the media.

Notes

Supported types: image, video.

Example (cURL)

curl -X POST '__BASE_URL__/v1/media' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number": "6281234567890",
    "url": "https://i.pinimg.com/736x/39/cc/b3/39ccb37903402f63a990e8cc004bef5d.jpg",
    "caption": "This is an image."
  }'

POST/v1/voice

Send Voice Note

Sends an audio file as a voice note.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`number`	`string`	Required	Recipient number.
`url`	`string`	Required	Public URL of the audio file.

numberstring

Required

Recipient number.

urlstring

Required

Public URL of the audio file.

Notes

Audio will be sent as a Push-to-Talk (PTT) message.

Example (cURL)

curl -X POST '__BASE_URL__/v1/voice' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number": "6281234567890",
    "url": "https://cdn.neoxr.eu/audio/chicken.mp3"
  }'

POST/v1/file

Send Document

Sends a file as a document.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`number`	`string`	Required	Recipient number.
`url`	`string`	Required	Public URL of the file.
`filename`	`string`	Required	File name with extension.
`caption`	`string`	Optional	Optional caption.

numberstring

Required

Recipient number.

urlstring

Required

Public URL of the file.

filenamestring

Required

File name with extension.

captionstring

Optional

Optional caption.

Example (cURL)

curl -X POST '__BASE_URL__/v1/file' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number": "6281234567890",
    "url": "https://pdfobject.com/pdf/sample.pdf",
    "filename": "sample.pdf"
  }'

POST/v1/album

Send Album

Sends multiple media files as an album.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`number`	`string`	Required	Recipient number.
`media`	`array`	Required	Array of media objects containing `url`, `caption`, and `type`.

numberstring

Required

Recipient number.

mediaarray

Required

Array of media objects containing url, caption, and type.

Notes

Only image and video types are supported for albums.

Example (cURL)

curl -X POST '__BASE_URL__/v1/album' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number": "6281234567890",
    "media": [
      {"url": "https://i.pinimg.com/736x/09/d2/b9/09d2b9f1e452f54a8260de445120cc76.jpg", "caption": "Image 1", "type": "image"},
      {"url": "https://i.pinimg.com/1200x/a0/3a/2b/a03a2b9c7291739ce7cb27d380f26143.jpg", "caption": "Image 2", "type": "image"},
      {"url": "https://i.pinimg.com/736x/86/57/97/865797107d1552e2dbb3a28177e18056.jpg", "caption": "Image 3", "type": "image"}
    ]
  }'

POST/v1/contact

Send Contact

Sends a contact card (vCard).

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`number`	`string`	Required	Recipient number.
`contacts`	`array`	Required	Array of contact objects (name, number, about).
`org`	`string`	Optional	Organization name.
`website`	`string`	Optional	Website URL.
`email`	`string`	Optional	Email address.

numberstring

Required

Recipient number.

contactsarray

Required

Array of contact objects (name, number, about).

orgstring

Optional

Organization name.

websitestring

Optional

Website URL.

emailstring

Optional

Email address.

Example (cURL)

curl -X POST '__BASE_URL__/v1/contact' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number": "6281234567890",
    "contacts": [
      {"name": "Wildan Izzudin", "number": "6285887776722", "about": "Owner"}
    ],
    "org": "Neoxr Network",
    "website": "__BASE_URL__",
    "email": "[email protected]"
  }'

POST/v1/button

Send Button Message

Sends a message with interactive buttons.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`number`	`string`	Required	Recipient number.
`text`	`string`	Required	Main text content.
`button`	`string`	Required	JSON string of button objects.
`media`	`string`	Optional	Optional image/video URL for header.

numberstring

Required

Recipient number.

textstring

Required

Main text content.

buttonstring

Required

JSON string of button objects.

mediastring

Optional

Optional image/video URL for header.

Notes

This feature may not work on WhatsApp Business accounts.
Interactive buttons are currently not supported on iOS (iPhone). Use an Android device to access this feature.

Example (cURL)

curl -X POST '__BASE_URL__/v1/button' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "number": "6281234567890",
    "text": "Select an option",
    "button": "[{\"name\":\"quick_reply\",\"buttonParamsJson\":\"{\\\"display_text\\\":\\\"OWNER\\\",\\\"id\\\":\\\".owner\\\"}\"},{\"name\":\"cta_url\",\"buttonParamsJson\":\"{\\\"display_text\\\":\\\"Rest API\\\",\\\"url\\\":\\\"__BASE_URL__\\\",\\\"merchant_url\\\":\\\"__BASE_URL__\\\"}\"},{\"name\":\"cta_copy\",\"buttonParamsJson\":\"{\\\"display_text\\\":\\\"Copy\\\",\\\"copy_code\\\":\\\"123456\\\"}\"},{\"name\":\"cta_call\",\"buttonParamsJson\":\"{\\\"display_text\\\":\\\"Call\\\",\\\"phone_number\\\":\\\"6285887776722\\\"}\"},{\"name\":\"single_select\",\"buttonParamsJson\":\"{\\\"title\\\":\\\"Tap!\\\",\\\"sections\\\":[{\\\"rows\\\":[{\\\"title\\\":\\\"Owner\\\",\\\"description\\\":\\\"X\\\",\\\"id\\\":\\\".owner\\\"},{\\\"title\\\":\\\"Runtime\\\",\\\"description\\\":\\\"Y\\\",\\\"id\\\":\\\".run\\\"}]}]}\"}]"
  }'

POST/v2/text

Send Text Message (JID)

Sends a plain text message using a JID.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`jid`	`string`	Required	Recipient JID (e.g., [email protected] or [email protected]).
`text`	`string`	Required	The message content.

jidstring

Required

Recipient JID (e.g., [email protected] or [email protected]).

textstring

Required

The message content.

Example (cURL)

curl -X POST '__BASE_URL__/v2/text' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "jid": "[email protected]",
    "text": "Hello, this is a test message."
  }'

POST/v2/modify

Send Message Modify (JID)

Sends a text message with a custom thumbnail and link preview using a JID.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`jid`	`string`	Required	Recipient JID.
`text`	`string`	Required	The message content.
`title`	`string`	Optional	Title for the link preview.
`thumbnail`	`string`	Required	URL of the thumbnail image.
`url`	`string`	Optional	Target URL for the link preview.

jidstring

Required

Recipient JID.

textstring

Required

The message content.

titlestring

Optional

Title for the link preview.

thumbnailstring

Required

URL of the thumbnail image.

urlstring

Optional

Target URL for the link preview.

Notes

Useful for sending messages that look like link previews.

Example (cURL)

curl -X POST '__BASE_URL__/v2/modify' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "jid": "[email protected]",
    "text": "Test!",
    "title": "© neoxr-bot",
    "thumbnail": "https://iili.io/HP3ODj2.jpg",
    "url": "https://chat.whatsapp.com/HYknAquOTrECm9KPJJQO1V"
  }'

POST/v2/media

Send Media (JID)

Sends a media file from a URL using a JID.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`jid`	`string`	Required	Recipient JID.
`url`	`string`	Required	Public URL of the image/video.
`caption`	`string`	Optional	Caption for the media.

jidstring

Required

Recipient JID.

urlstring

Required

Public URL of the image/video.

captionstring

Optional

Caption for the media.

Notes

Supported types: image, video.

Example (cURL)

curl -X POST '__BASE_URL__/v2/media' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "jid": "[email protected]",
    "url": "https://i.pinimg.com/736x/39/cc/b3/39ccb37903402f63a990e8cc004bef5d.jpg",
    "caption": "This is an image."
  }'

POST/v2/voice

Send Voice Note (JID)

Sends an audio file as a voice note using a JID.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`jid`	`string`	Required	Recipient JID.
`url`	`string`	Required	Public URL of the audio file.

jidstring

Required

Recipient JID.

urlstring

Required

Public URL of the audio file.

Notes

Audio will be sent as a Push-to-Talk (PTT) message.

Example (cURL)

curl -X POST '__BASE_URL__/v2/voice' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "jid": "[email protected]",
    "url": "https://cdn.neoxr.eu/audio/chicken.mp3"
  }'

POST/v2/file

Send Document (JID)

Sends a file as a document using a JID.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`jid`	`string`	Required	Recipient JID.
`url`	`string`	Required	Public URL of the file.
`filename`	`string`	Required	File name with extension.
`caption`	`string`	Optional	Optional caption.

jidstring

Required

Recipient JID.

urlstring

Required

Public URL of the file.

filenamestring

Required

File name with extension.

captionstring

Optional

Optional caption.

Example (cURL)

curl -X POST '__BASE_URL__/v2/file' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "jid": "[email protected]",
    "url": "https://pdfobject.com/pdf/sample.pdf",
    "filename": "sample.pdf"
  }'

POST/v2/album

Send Album (JID)

Sends multiple media files as an album using a JID.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`jid`	`string`	Required	Recipient JID.
`media`	`array`	Required	Array of media objects containing `url`, `caption`, and `type`.

jidstring

Required

Recipient JID.

mediaarray

Required

Array of media objects containing url, caption, and type.

Notes

Only image and video types are supported for albums.

Example (cURL)

curl -X POST '__BASE_URL__/v2/album' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "jid": "[email protected]",
    "media": [
      {"url": "https://i.pinimg.com/736x/09/d2/b9/09d2b9f1e452f54a8260de445120cc76.jpg", "caption": "Image 1", "type": "image"},
      {"url": "https://i.pinimg.com/1200x/a0/3a/2b/a03a2b9c7291739ce7cb27d380f26143.jpg", "caption": "Image 2", "type": "image"},
      {"url": "https://i.pinimg.com/736x/86/57/97/865797107d1552e2dbb3a28177e18056.jpg", "caption": "Image 3", "type": "image"}
    ]
  }'

POST/v2/contact

Send Contact (JID)

Sends a contact card (vCard) using a JID.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`jid`	`string`	Required	Recipient JID.
`contacts`	`array`	Required	Array of contact objects (name, number, about).
`org`	`string`	Optional	Organization name.
`website`	`string`	Optional	Website URL.
`email`	`string`	Optional	Email address.

jidstring

Required

Recipient JID.

contactsarray

Required

Array of contact objects (name, number, about).

orgstring

Optional

Organization name.

websitestring

Optional

Website URL.

emailstring

Optional

Email address.

Example (cURL)

curl -X POST '__BASE_URL__/v2/contact' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "jid": "[email protected]",
    "contacts": [
      {"name": "Wildan Izzudin", "number": "6285887776722", "about": "Owner"}
    ],
    "org": "Neoxr Network",
    "website": "__BASE_URL__",
    "email": "[email protected]"
  }'

POST/v2/button

Send Button Message (JID)

Sends a message with interactive buttons using a JID.

Headers

Key	Description
`x-neoxr-token`	Your bot instance token. (Required)

Body Parameters (application/json)

Parameter	Type	Status	Description
`jid`	`string`	Required	Recipient JID.
`text`	`string`	Required	Main text content.
`button`	`string`	Required	JSON string of button objects.
`media`	`string`	Optional	Optional image/video URL for header.

jidstring

Required

Recipient JID.

textstring

Required

Main text content.

buttonstring

Required

JSON string of button objects.

mediastring

Optional

Optional image/video URL for header.

Notes

This feature may not work on WhatsApp Business accounts.
Interactive buttons are currently not supported on iOS (iPhone). Use an Android device to access this feature.

Example (cURL)

curl -X POST '__BASE_URL__/v2/button' \
  --header 'x-neoxr-token: __YOUR_TOKEN__' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "jid": "[email protected]",
    "text": "Select an option",
    "button": "[{\"name\":\"quick_reply\",\"buttonParamsJson\":\"{\\\"display_text\\\":\\\"OWNER\\\",\\\"id\\\":\\\".owner\\\"}\"},{\"name\":\"cta_url\",\"buttonParamsJson\":\"{\\\"display_text\\\":\\\"Rest API\\\",\\\"url\\\":\\\"__BASE_URL__\\\",\\\"merchant_url\\\":\\\"__BASE_URL__\\\"}\"},{\"name\":\"cta_copy\",\"buttonParamsJson\":\"{\\\"display_text\\\":\\\"Copy\\\",\\\"copy_code\\\":\\\"123456\\\"}\"},{\"name\":\"cta_call\",\"buttonParamsJson\":\"{\\\"display_text\\\":\\\"Call\\\",\\\"phone_number\\\":\\\"6285887776722\\\"}\"},{\"name\":\"single_select\",\"buttonParamsJson\":\"{\\\"title\\\":\\\"Tap!\\\",\\\"sections\\\":[{\\\"rows\\\":[{\\\"title\\\":\\\"Owner\\\",\\\"description\\\":\\\"X\\\",\\\"id\\\":\\\".owner\\\"},{\\\"title\\\":\\\"Runtime\\\",\\\"description\\\":\\\"Y\\\",\\\"id\\\":\\\".run\\\"}]}]}\"}]"
  }'

Janoz

Janoz

ENDPOINTS V1 (BY NUMBER)

ENDPOINTS V2 (BY JID)

Send Text Message

Headers

Body Parameters (application/json)

Example (cURL)

Send Message Modify

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Media

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Voice Note

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Document

Headers

Body Parameters (application/json)

Example (cURL)

Send Album

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Contact

Headers

Body Parameters (application/json)

Example (cURL)

Send Button Message

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Text Message (JID)

Headers

Body Parameters (application/json)

Example (cURL)

Send Message Modify (JID)

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Media (JID)

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Voice Note (JID)

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Document (JID)

Headers

Body Parameters (application/json)

Example (cURL)

Send Album (JID)

Headers

Body Parameters (application/json)

Notes

Example (cURL)

Send Contact (JID)

Headers

Body Parameters (application/json)

Example (cURL)

Send Button Message (JID)

Headers

Body Parameters (application/json)

Notes

Example (cURL)