Data Types

Available Payload

Attribute
Type
Description

type

String (Required)

Only available for : text, media, location and poll

device_id

string (Required)

The number used to send the message. You can get this device_id from devices list and then click copy device id button

contact

object (Required)

The destination contact to which the message is sent

  • name

string (Required)

Name of contact

  • phone

string (Required)

Number phone of contact with country code without + symbol. Example : 62, 1 or 43 6285708956744 185708956744 4385708956744

content

object (Required)

  • text

string (Optional)

Only Required for type : text

  • caption

string (Optional)

Only Required for type : media

  • file

string (Optional)

Only Required for type : media Use Fullpath URL

  • title

string (Optional)

Only Required for type : location

  • address

string (Optional)

Only Required for type : location

  • latitude

string (Optional)

Only Required for type : location

  • longitude

string (Optional)

Only Required for type : location

schedule

object (Optional)

Used for send message with schedule

  • frequency

string (Required)

Only available for : runOnce : run schedule only one time at specific date and time. dailyAt : send message every day at specific time. wiklyOn : send message every week on specific day and time. montlyOn : send message every month on specific date and time. yearlyOn : send message every year on specific year, date and time.

  • datetime

string (Required)

Date and time when the message will be sent. Format : (YYYY-MM-DD hh:mm:ss)

  • YYYY: Year in 4 digit (2024)

  • MM: Month in 2 digit (01, which means January)

  • DD: Day in 2 digit (19)

  • HH: Hours in format 24 hours (21, which means 9pm)

  • MM: Minutes in 2 digit (34)

  • SS: Second in 2 digit (00)

Sample Json Payload

Send Text Message

Body Payload

Send Text Message - Schedule

Body Payload

Send Media Message

Body Payload

Send Media Message - Schedule

Body Payload

Send Location

Body Payload

Last updated