Skip to main content

Description Parameter

The following section explains each parameter used in the JSON request to send a message.

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
signature	SHA 256 HASH	YES	Encrypted (Username+Password+Time), time refers to time field
time	String (Unix timestamp)	YES	Current Request Time (Unix Timestamp) Example: Friday, November 1, 2024, 5:47:43 PM GMT+07:00 become “1730458063”
type	N (Numeric)	YES	1 (Send Primary Backup), 2 (Single channel / Send All)
username	AN (Alpha Numeric)	YES	Username Division
ref_id	AN (Alpha Numeric) (≤50)	YES	Unique Id generated by client (lowercase)
subject	ANS (Alpha Numeric Space) (< 100)	YES	Sending Message Subject
sender_ID	ANS (Alpha Numeric Space)	YES	Sender Name (provided by sprint)
budget_code	ANS (Alpha Numeric Space)	NO	Additional information, maximum 180 character
channel	JSON Object	YES	Describe the channels used for sending messages Channel: SMS, Email, Line, Telegram, Facebook, & WhatsApp Example: "channel": "sms":

Description Fields For Sending Message Use Channel SMS

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
message	Text	YES	Message to be sent Sample: YTH. Bapak/Ibu……
msisdn	N (Numeric), Plus (+)	YES	Mobile phone number, with 0, 62 or +
backup_on	AN (Alpha Numeric)	NO	Format: status1;status2 Mapping: 1 – Unsent 2 – Undelivered 3 – Pending 4 – Failed Sample: 1;3
backup_exp	AN (Alpha Numeric)	NO	Expire in minutes. Except pending, set 0. Format: expire1;expire2 Sample: 0;10
use_backup_sender	Boolean	NO	Used to back up messages via SMS with credit deduction default “false” → Message backup is not enabled true → Message backup is active

Description Fields For Sending Message Use Channel Email

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
message	Text	NO	If not using a template, you can write free text. Static with template: This value can empty Dynamic with template: Dynamic Values Separator: “:” dan “;" Sample: nama:Sprint;alamat:Jl. Fatmawati
email	Valid Email Format	YES	Must be a valid email format
attachment	Text	NO	Path Format: https://Path/filename Note: https protocol is a must File Extension: Email: jpg, png, xls, xlsx, pdf, ppt, pptx, doc, docx, wav, mp4, txt Max Size: 5MB/file Separator: “;” Sample: https://www.domain.com/test.pdf; https://www.domain.com/test2.pdf
template_id	AN (Alpha Numeric)	NO	Id template generated from sandeza web Template_id mandatory, If the email is sent using a template Then param message follows dynamic parameter
backup_on	AN (Alpha Numeric)	NO	Format: status1; status2 Mapping: 1 – Unsent 2 – Undelivered 3 – Pending 5 – Spam 6 – Bounced 7 – Blacklist Sample: 1;3
backup_exp	AN (Alpha Numeric) (≤50)	NO	Expire in minutes. Except pending, set 0. Format: expire1; expire2 Sample: 0;5

Description Fields For Sending Message Use Channel Line, Telegram, Facebook

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
message	Text	YES	Body (non-HTML format)
chat_id	AN (Alpha Numeric)	YES	Social id / metadata id
attachment	Text	NO	Path Format: https://Path/filename Note: https protocol is a must File Extension: Line: jpg, png Telegram: jpg, png, pdf, mp4 Facebook: jpg, png, xls, xlsx, pdf, ppt, pptx, doc, docx, wav, mp4, txt Max File Size: 5MB/file Separator: “;” Sample: https://www.domain.com/test.pdf; https://www.domain.com/test2.pdf
backup_on	AN (Alpha Numeric)	NO	Format: status1; status2 Mapping: 1 – Unsent 3 – Pending 4 – Failed Sample: 1;4
backup_exp	AN (Alpha Numeric) (≤50)	NO	Expire in minutes. Except pending, set 0. Format: expire1; expire2 Sample: 0;5

Description Fields For Sending Message Use Channel WhatsApp Template Use Delimeter Format

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
msisdn	N (Numeric), Plus (+)	YES	Mobile phone number, with 0, 62 or +
template_id	AN (Alpha Numeric)	YES	Template Code registered in Saneza
header	Text	NO	Message on header Note: This field for dynamic parameter Format: type:=:value Type: text, Image, video, document, location Allowed sample extension: .jpeg, .png, 3gp, .mp4, .txt, .xls, .xlsx, .doc, .ppt Size limit image: 2MB Size limit video: 10MB Size limit document: 15MB Sample: Text: text:=:Sprint Doc: document:=:https://www.domain.com/test.pdf Image : image:=:https://www.domain.com/test.jpg
message	Text	NO	Message on body Note: This field for dynamic parameter Format: type:=:value1\|\|type:=:value2 Type: text Separator: \|\| Sample : text:=:Sprint \|\| text:=:Sandeza NOTE: if the template type is authentication, then the text value of the message must match the value of 'value_otp' on the button."
button	Text	NO	Message on button Note: This field for dynamic parameter Format : Template button otp : button:=:url:=:value_otp Template button visit website: button:=:url:=:value_path_url Type: button URL Sample: button:=:url:=:123456 button:=:url:=:login.html NOTE: if the template type is authentication, then the text value of the message must match the value of 'value_otp' on the button."
attachment	Text	NO	Path Format: https://Path/filename Note: https protocol is a must File Extension: Whatsapp: jpg, png, xls, xlsx, pdf, ppt, pptx, doc, docx, wav, mp4, txt Max Size: 5MB/file Separator: “;” Sample: https://www.domain.com/test.pdf; https://www. domain.com/test2.pdf
backup_on	AN (Alpha Numeric)	NO	Format: status1; status2 Mapping: 1 – Unsent 2 – Undelivered 3 – Pending 4 – Failed 9 – Delivered Sample: 2;3
backup_exp	AN (Alpha Numeric)	NO	Expire in minutes. Except pending, set 0. Format: expire1; expire2 Sample: 0;10

Description Fields For Sending Message Use Channel WhatsApp Template Use JSON Format

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
msisdn	N (Numeric), Plus (+)	YES	Mobile phone number, with 0, 62 or +
template_id	AN (Alpha Numeric)	YES	Template Id registered
header	JSON Object	NO	Message on header This field for dynamic parameter header (Mandatory) Type dynamic parameter: text, Image, video, document, location See “Description Field Header” for details
message	JSON Object	NO	Message on body This field for dynamic parameter message (Mandatory) Type dynamic parameter: text See “Description Field Message” for details NOTE: if the template type is authentication, then the text value of the message must match the value of 'value_otp' on the button."
button	JSON Object	NO	Message on button This field for a dynamic card carousel component (Mandatory) Type dynamic parameter: button URL, button catalog, button MPM See “Description Field Button” for details NOTE: if the template type is authentication, then the text value of the message must match the value of 'value_otp' on the button."
carousel	JSON Object	NO	Message on card carousel This field for dynamic component card carousel (Mandatory) Sample Type of carousel card component that can be dynamic: Header à image & video Body à text Button à Quick_Reply & URL See “Description Field Carousel” for details
attachment	Text	NO	Path Format: https://Path/filename Note: https protocol is a must File Extension: WhatsApp: jpg, png, xls, xlsx, pdf, ppt, pptx, doc, docx, wav, mp4, txt Max Size: 5MB/file Separator: “;” Sample: https://www.domain.com/test.pdf; https://www. domain.com/test2.pdf
backup_on	AN (Alpha Numeric)	NO	Format: status1; status2 Mapping: 1 – Unsent 2 – Undelivered 3 – Pending 4 – Failed 9 – Delivered Sample: 2;3
backup_exp	AN (Alpha Numeric)	NO	Expire in minutes. Except pending, set 0. Format: expire1; expire2 Sample: 0;10

Description Fields Header

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type of header This value always “Header” for component template type header
parameter	Array	YES	Detail information for parameter header dynamic

Description For field parameter header

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type for header dynamic Example: text, Image, video, document, location
text	String	NO	Sample text dynamic from header Mandatory if header type text
image	JSON Object	NO	Placeholder for image Allowed sample extension: .jpeg, .png Size limit: 2MB Mandatory if header type image
video	JSON Object	NO	Placeholder for video Allowed sample extension: .3gp, .mp4 Size limit: 10MB Mandatory if header type video
document	JSON Object	NO	Placeholder for document Allowed sample extension: .txt, .xls, .xlsx, .doc, .ppt, .pdf Size limit: 15MB Mandatory if header type document
location	JSON Object	NO	Placeholder for location Mandatory if header type location

Additional fields required when the type of header is media or location

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
link	String	NO	Storage location for media (image/video/document) file This field for header type: image, video, document
filename	String	NO	Displayed Document Filename
latitude	Float	NO	Type Location (coordinates point) This field for header type: location
longitude	Float	NO	Type Location (coordinates point) This field for header type: location
name	String	NO	Detail name of the location This field for header type: location
address	String	NO	Detail address of the location This field for header type: location

Description Fields Message

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type of message This value always “Body” for component template type message
parameter	Array	YES	Detail information for parameter body dynamic

Description For field parameter body

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type for body dynamic Example: text
text	String	YES	Sample text dynamic from body Mandatory if body type text

Description Fields Button

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type of button This value always “Button” for component template type button
sub_type	String	YES	Sub type for button dynamic Example: URL, catalog, MPM
index	Integer	YES	index is the order of the button, starting from 0 to 9
parameter	Array	YES	Detail information for parameter button dynamic

Description For field parameter button

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
Type	String	YES	Type for sub_type button dynamic: Text for Type URL Action for Type catalog & MPM
text	String	NO	Sample text dynamic from button Mandatory if button type text
action	JSON Object	NO	Detail of the action information

Additional fields required when the type of Button is Catalog or MPM

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
Thumbnail_ product _retailer_id	String	YES	Item SKU number. Labelled as Content ID in the Commerce Manager. The thumbnail of this item will be used as the message's header image.
sections	JSON Object	NO	Detail of the sections information

Additional fields required when the type of button is MPM

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
title	String	YES	Section title text. You can specify up to 10 sections. Maximum 24 characters. Markdown is not supported
product_items	Array	YES	Detail of the product_item information

Additional fields required when the type of button is MPM

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
product_retailer_id	String	YES	SKU number of the items you want to display in the section. The SKU number is labeled as Content ID in Commerce Manager. Supports a total of up to 30 products across all sections.

Description Fields Carousel

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type of Carousel This value always “Carousel” for component template type Carousel
cards	Array	YES	Detail of the cards information

Description For field Carousel Cards

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
card_index	Integer	YES	Zero-indexed order in which card should appear within the card carousel. 0 indicates first card, 1 indicates second card, etc.
components	String	YES	Detail of the components cards information

Description For Field Components Cards

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type from component carousel card Example: header, body, button
sub_type	String	NO	This field is used if components type is button Example: Quick_reply, URL
index	Integer	NO	This field is used if components type is button index is the order of the button starting from 0 to 9
parameters	Array	YES	Detail information for parameter component dynamic for detail see:“Additional fields required If field type is “header" , “body” , “button” “

Additional fields required in parameters If type carousel card is “header."

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type message in header Example: Image or Video
image	JSON Object	NO	The field is used when the header type is an image.
video	JSON Object	NO	The field is used when the header type is an image.

Additional fields required for image or video

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
link	String	YES	Storage location for media files: image or video

Additional fields required in parameters If type carousel card is “body."

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type message in body
text	JSON Object	YES	Sample message for param dynamic body

Additional fields required in parameters If type carousel card is “button"

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type from sub type button This value is always payload for the sub-type button Quick_Reply
payload	String	NO	The payload defined by the developer that is displayed when the button is clicked, in addition to the display text on the button

Description Fields For Sending Message Use Channel WhatsApp Non-Template

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
msisdn	N (Numeric), Plus (+)	YES	Mobile phone number, with 0, 62 or +
message	JSON Object	YES	Message on WhatsApp See “Description Field Message” for details

Description Field Message

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type of message Example: Text, Media (Audio, Image, Video, Document), Button, List, Location
header	JSON Object	NO	This field is used for the message type Button & List See “Description Field in header” for details
body	JSON Object	YES	This field is used for all message types See “Description Field in body” for details
footer	JSON Object	NO	This field is used for the message type Button & List See “Description Field in footer” for details

Additional Fields When Message Type is “text” or “Media” (Audio, Image, Video, Document)

Description Field In Body

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
text	String	YES	Text message content in header This field used if type message is text
media	JSON Object	NO	This field used if type message is media (audio, image, video, document)

Additional fields required for media

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
url	String	YES	Storage location for media files: audio, image, video, document
name	String	NO	Display name of the media file

Description For field Type when message type is Button

Description Field In Header

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type message from header example: · If type message is button: text, image, video, document · If type message is list: text
text	String	YES	Text message content in header
media_url	String	NO	Storage location for media files: image or video
name	String	NO	Display name of the media file

Description Field In Footer

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
text	String	NO	Text message content in footer

Description Field In Body

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
text	String	YES	Text message content in header This field used if type message is text
button	JSON Object	NO	This field used if type message is button

Additional fields required for button

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
Type	String	YES	Type from button in body
key	String	YES	Button ID received from the client and returned if there is a post back from the client.
title	String	YES	As a button label (name of the button to be selected).

Description For field Type when message type is List

Description Field In Header

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type message from header example: · If type message is button: text, image, video, document · If type message is list: text
text	String	YES	Text message content in header
media_url	String	NO	Storage location for media files: image or video

Description Field In Footer

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
text	String	NO	Text message content in footer

Description Field In Body

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
text	String	YES	Text message content in header This field used if type message is text
list	JSON Object	NO	This field used if type message is list

Additional fields required for List

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
title	String	YES	As a button label (name of the button to be selected).
section	JSON Object	YES	Details of the section information

Additional fields required for section

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
title	String	YES	Name of the section
description	JSON Object	YES	Description of the section.
actions	Array	YES	Details of the action information

Additional fields required for actioon

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
type	String	YES	Type from section list
key	String	YES	list ID received from the client and returned if there is a post back from the client.
title	String	YES	Name of the selected list

Additional Fields When Message Type is “Location”

Description Field In Body

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
location	JSON Object	YES	This field used if type message is location

Additional fields required for location

FIELD	TYPE ALLOWED	MANDATORY	DESCRIPTION
latitude	Float	YES	Type Location (coordinates point).
longitude	Float	YES	Type Location (coordinates point).