Skip to content

Navigation

API documentation

Explore endpoints, request parameters, and examples for your bot.

Open playground
Endpoints v1 ? Number
Endpoints v2 ? JID
POST/v1/text
Send Text Message

Sends a plain text message.

Headers
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
numberstringRequiredRecipient number with country code (e.g., 62812xxxx).
textstringRequiredThe 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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
numberstringRequiredRecipient number.
textstringRequiredThe message content.
titlestringOptionalTitle for the link preview.
thumbnailstringRequiredURL of the thumbnail image.
urlstringOptionalTarget 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": "© violetix",
    "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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
numberstringRequiredRecipient number.
urlstringRequiredPublic URL of the image/video.
captionstringOptionalCaption 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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
numberstringRequiredRecipient number.
urlstringRequiredPublic 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://example.com/audio/sample.mp3"
  }'
POST/v1/file
Send Document

Sends a file as a document.

Headers
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
numberstringRequiredRecipient number.
urlstringRequiredPublic URL of the file.
filenamestringRequiredFile name with extension.
captionstringOptionalOptional 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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
numberstringRequiredRecipient number.
mediaarrayRequiredArray 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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
numberstringRequiredRecipient number.
contactsarrayRequiredArray of contact objects (name, number, about).
orgstringOptionalOrganization name.
websitestringOptionalWebsite URL.
emailstringOptionalEmail 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": "John Doe", "number": "6281234567890", "about": "Owner"}
    ],
    "org": "Violetix",
    "website": "__BASE_URL__",
    "email": "[email protected]"
  }'
POST/v1/button
Send Button Message

Sends a message with interactive buttons.

Headers
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
numberstringRequiredRecipient number.
textstringRequiredMain text content.
buttonstringRequiredJSON string of button objects.
mediastringOptionalOptional 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\\\":\\\"6281234567890\\\"}\"},{\"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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
jidstringRequiredRecipient JID (e.g., [email protected] or [email protected]).
textstringRequiredThe 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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
jidstringRequiredRecipient JID.
textstringRequiredThe message content.
titlestringOptionalTitle for the link preview.
thumbnailstringRequiredURL of the thumbnail image.
urlstringOptionalTarget 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": "© violetix",
    "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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
jidstringRequiredRecipient JID.
urlstringRequiredPublic URL of the image/video.
captionstringOptionalCaption 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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
jidstringRequiredRecipient JID.
urlstringRequiredPublic 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://example.com/audio/sample.mp3"
  }'
POST/v2/file
Send Document (JID)

Sends a file as a document using a JID.

Headers
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
jidstringRequiredRecipient JID.
urlstringRequiredPublic URL of the file.
filenamestringRequiredFile name with extension.
captionstringOptionalOptional 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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
jidstringRequiredRecipient JID.
mediaarrayRequiredArray 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
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
jidstringRequiredRecipient JID.
contactsarrayRequiredArray of contact objects (name, number, about).
orgstringOptionalOrganization name.
websitestringOptionalWebsite URL.
emailstringOptionalEmail 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": "John Doe", "number": "6281234567890", "about": "Owner"}
    ],
    "org": "Violetix",
    "website": "__BASE_URL__",
    "email": "[email protected]"
  }'
POST/v2/button
Send Button Message (JID)

Sends a message with interactive buttons using a JID.

Headers
KeyDescription
x-neoxr-tokenYour bot instance token. (Required)
Body Parameters (application/json)
ParameterTypeStatusDescription
jidstringRequiredRecipient JID.
textstringRequiredMain text content.
buttonstringRequiredJSON string of button objects.
mediastringOptionalOptional 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\\\":\\\"6281234567890\\\"}\"},{\"name\":\"single_select\",\"buttonParamsJson\":\"{\\\"title\\\":\\\"Tap!\\\",\\\"sections\\\":[{\\\"rows\\\":[{\\\"title\\\":\\\"Owner\\\",\\\"description\\\":\\\"X\\\",\\\"id\\\":\\\".owner\\\"},{\\\"title\\\":\\\"Runtime\\\",\\\"description\\\":\\\"Y\\\",\\\"id\\\":\\\".run\\\"}]}]}\"}]"
  }'