Send a Message

To send the message to the user, use the below methods. Different messages such as text, image, audio, video & document type messages can be sent using the below methods.

Text Message

await SDK.sendTextMessage({

toJid: "",

messageText: "",

mentionedUsersIds: [],

topicId: "",

metaData: {}

});

Param	Description	Type	Required
toJid	JID of the To User	JID String	true
messageText	Text Message Body	String	true
mentionedUsersIds	Array of Group Mentioned UsersIds	Array of Strings	false
topicId	Topic Id for the Message	String	false
metaData	MetaData for the Message	Object	false

Response Format:

statusCode: 200, // Number - status code

message: "", // String - Success/Error Message

data:

{

chatType: "", // String - Chat Type - "chat"

createdAt: "", // String - Message Created Time

deleteStatus: "", // Number - Delete Status

favouriteBy: "", // String - Favourited By - User

favouriteStatus: "", //Number - Favourite status

fromUserId: "", // String - From User Id

fromUserJid: "", // String - From User Jid

metaData: {}, //Object - Meta data for the message

msgBody: {

mentionedUsersIds: [] // Array of mentioned users

message: "", // String - Message Body

message_type: "", // String - Message Type

nickname: "", // String - nick name

},

msgId: "", // String - Unique Message Id

msgType: "", // String - Message Type

publisherId: "", // String - user Id

timestamp: 1681185232000, // Number - TimeStamp - Milliseconds

toUserId: "", // String - toUser Id

toUserJid: "", // String - toUser Jid

topicId: "", //String - Topic id for the message

},

Image Message

caution

If Image attachment feature is unavailable for your plan, then it will throw 403 exception

await SDK.sendMediaFileMessage({

toJid: "",

messageType: "image",

fileMessageParams: {

file: FILE, // Or .fileUrl = FILE_URL (You can also send a file message with a file URL.)

caption: "",

},

replyMessageId: "",

mentionedUsersIds: [],

topicId: "",

metaData: {}

},

onPending((msgId) => {

// ...

}),

.onSuccess((response) => {

// ...

}),

.onError((error) => {

// ...

})

);

Param	Description	Type	Required
toJid	JID of the To User	JID String	true
fileMessageParams	File Message Params	Object	true
fileMessageParams.file	Image File - Should be of type png, jpg, jpeg, svg & gif	File	true
fileMessageParams.thumbImage	Image File Thumb Image. When the value not given, SDK will generate thumb image for the given FILE. When using the fileUrl SDK won't generate the thumb image.	String	false
fileMessageParams.fileSize	Image File Size. When the value not given, SDK will detect the size of the given FILE. When using the fileUrl SDK won't detect the size.	String	false
fileMessageParams.fileName	Image File Name. When the value not given, SDK will detect the name of the given FILE. When using the fileUrl SDK won't detect the name.	String	false
fileMessageParams.caption	Image Caption	String	false
replyMessageId	Message ID of Original Message	String	false
mentionedUsersIds	Array of Group Mentioned UsersIds	Array of Strings	false
topicId	Topic Id for the Message	String	false
metaData	MetaData for the Message	Object	false
onPending	Pending call back	function	true
onSuccess	Send Message success call back	function	true
onError	Send Message error call back	function	true

onSuccess:

{

chatType: "", // String - Chat Type - "chat"

createdAt: "", // String - Message Created Time

deleteStatus: "", // Number - Delete Status

favouriteBy: "", // String - Favourited By - User

favouriteStatus: "", //Number - Favourite status

fromUserId: "", // String - From User Id

fromUserJid: "", // String - From User Jid

metaData: {}, //Object - Meta data for the message

msgBody: {

media: { // For Media Message Only

caption: "", // String - Media Caption

duration: "", // String - Duration - For Audio/Videos

fileName: "", // String - File Name

file_size: "", // Number - File Size

fileToken: "", // String - File Url

is_downloaded: "", // Number - Downloaded Status

is_uploading: "", // Number - Uploading Status

local_path: "", // String - Local Path

thumb_image: "", // Base64 - Thumb Image

}

mentionedUsersIds: [] // Array of mentioned users

message_type: "", // String - Message Type

nickname: "", // String - nick name

},

msgId: "", // String - Unique Message Id

msgType: "", // String - Message Type

publisherId: "", // String - user Id

timestamp: 1681185232000, // Number - TimeStamp - Milliseconds

toUserId: "", // String - toUser Id

toUserJid: "", // String - toUser Jid

topicId: "", //String - Topic id for the message

},

caution

SDK.sendFileMessage() method was deprecated and will be removed in the future release. migrate to SDK.sendMediaFileMessage() method to send Image files.

Audio Message

caution

If Audio attachment feature is unavailable for your plan, then it will throw 403 exception

await SDK.sendMediaFileMessage({

toJid: "",

messageType: "audio",

fileMessageParams: {

file: FILE, // Or .fileUrl = FILE_URL (You can also send a file message with a file URL.)

caption: "",

},

replyMessageId: "",

mentionedUsersIds: [],

topicId: "",

metaData: {}

},

onPending((msgId) => {

// ...

}),

.onSuccess((response) => {

// ...

}),

.onError((error) => {

// ...

})

);

Param	Description	Type	Required
toJid	JID of the To User	JID String	true
fileMessageParams	File Message Params	Object	true
fileMessageParams.file	Audio File - Should be of type mp3, mpeg & wav	File	true
fileMessageParams.fileSize	Audio File Size. When the value not given, SDK will detect the size of the given FILE. When using the fileUrl SDK won't detect the size.	String	false
fileMessageParams.fileName	Audio File Name. When the value not given, SDK will detect the name of the given FILE. When using the fileUrl SDK won't detect the name.	String	false
fileMessageParams.duration	Audio File Duration. When the value not given, SDK will detect the duration of the given FILE. When using the fileUrl SDK won't detect the duration.	String	false
fileMessageParams.caption	Audio Caption	String	false
replyMessageId	Message ID of Original Message	String	false
mentionedUsersIds	Array of Group Mentioned UsersIds	Array of Strings	false
topicId	Topic Id for the Message	String	false
metaData	MetaData for the Message	Object	false
onPending	Pending call back	function	true
onSuccess	Send Message success call back	function	true
onError	Send Message error call back	function	true

onSuccess:

{

chatType: "", // String - Chat Type - "chat"

createdAt: "", // String - Message Created Time

deleteStatus: "", // Number - Delete Status

favouriteBy: "", // String - Favourited By - User

favouriteStatus: "", //Number - Favourite status

fromUserId: "", // String - From User Id

fromUserJid: "", // String - From User Jid

metaData: {}, //Object - Meta data for the message

msgBody: {

media: { // For Media Message Only

caption: "", // String - Media Caption

duration: "", // String - Duration - For Audio/Videos

fileName: "", // String - File Name

file_size: "", // Number - File Size

fileToken: "", // String - File Url

is_downloaded: "", // Number - Downloaded Status

is_uploading: "", // Number - Uploading Status

local_path: "", // String - Local Path

thumb_image: "", // Base64 - Thumb Image

}

mentionedUsersIds: [] // Array of mentioned users

message_type: "", // String - Message Type

nickname: "", // String - nick name

},

msgId: "", // String - Unique Message Id

msgType: "", // String - Message Type

publisherId: "", // String - user Id

timestamp: 1681185232000, // Number - TimeStamp - Milliseconds

toUserId: "", // String - toUser Id

toUserJid: "", // String - toUser Jid

topicId: "", //String - Topic id for the message

},

caution

SDK.sendFileMessage() method was deprecated and will be removed in the future release. migrate to SDK.sendMediaFileMessage() method to send Audio files.

Video Message

caution

If Video attachment feature is unavailable for your plan, then it will throw 403 exception

await SDK.sendMediaFileMessage({

toJid: "",

messageType: "video",

fileMessageParams: {

file: FILE, // Or .fileUrl = FILE_URL (You can also send a file message with a file URL.)

caption: ""

},

replyMessageId: "",

mentionedUsersIds: [],

topicId: "",

metaData: {}

},

onPending((msgId) => {

// ...

}),

.onSuccess((response) => {

// ...

}),

.onError((error) => {

// ...

})

);

Param	Description	Type	Required
toJid	JID of the To User	JID String	true
fileMessageParams	File Message Params	Object	true
fileMessageParams.file	Video File - Should be of type mp4	File	true
fileMessageParams.fileSize	Video File Size. When the value not given, SDK will detect the size of the given FILE. When using the fileUrl SDK won't detect the size.	String	false
fileMessageParams.fileName	Video File Name. When the value not given, SDK will detect the name of the given FILE. When using the fileUrl SDK won't detect the name.	String	false
fileMessageParams.duration	Video File Duration. When the value not given, SDK will detect the duration of the given FILE. When using the fileUrl SDK won't detect the duration.	String	false
fileMessageParams.thumbImage	Video File Thumb Image. When the value not given, SDK will generate thumb image for the given FILE. When using the fileUrl SDK won't generate the thumb image.	String	false
fileMessageParams.caption	Video Caption	String	false
replyMessageId	Message ID of Original Message	String	false
mentionedUsersIds	Array of Group Mentioned UsersIds	Array of Strings	false
topicId	Topic Id for the Message	String	false
metaData	MetaData for the Message	Object	false
onPending	Pending call back	function	true
onSuccess	Send Message success call back	function	true
onError	Send Message error call back	function	true

onSuccess:

{

chatType: "", // String - Chat Type - "chat"

createdAt: "", // String - Message Created Time

deleteStatus: "", // Number - Delete Status

favouriteBy: "", // String - Favourited By - User

favouriteStatus: "", //Number - Favourite status

fromUserId: "", // String - From User Id

fromUserJid: "", // String - From User Jid

metaData: {}, //Object - Meta data for the message

msgBody: {

media: { // For Media Message Only

caption: "", // String - Media Caption

duration: "", // String - Duration - For Audio/Videos

fileName: "", // String - File Name

file_size: "", // Number - File Size

fileToken: "", // String - File Url

is_downloaded: "", // Number - Downloaded Status

is_uploading: "", // Number - Uploading Status

local_path: "", // String - Local Path

thumb_image: "", // Base64 - Thumb Image

}

mentionedUsersIds: [] // Array of mentioned users

message_type: "", // String - Message Type

nickname: "", // String - nick name

},

msgId: "", // String - Unique Message Id

msgType: "", // String - Message Type

publisherId: "", // String - user Id

timestamp: 1681185232000, // Number - TimeStamp - Milliseconds

toUserId: "", // String - toUser Id

toUserJid: "", // String - toUser Jid

topicId: "", //String - Topic id for the message

},

caution

SDK.sendFileMessage() method was deprecated and will be removed in the future release. migrate to SDK.sendMediaFileMessage() method to send Video files.

Document Message

caution

If Document attachment feature is unavailable for your plan, then it will throw 403 exception

await SDK.sendMediaFileMessage({

toJid: "",

messageType: "file",

fileMessageParams: {

file: FILE, // Or .fileUrl = FILE_URL (You can also send a file message with a file URL.)

caption: ""

},

replyMessageId: "",

mentionedUsersIds: [],

topicId: "",

metaData: {}

},

onPending((msgId) => {

// ...

}),

.onSuccess((response) => {

// ...

}),

.onError((error) => {

// ...

})

);

Param	Description	Type	Required
toJid	JID of the To User	JID String	true
fileMessageParams	File Message Params	Object	true
fileMessageParams.file	Document File - Accepted files are pdf, doc, xls, csv, ppt & txt	File	true
fileMessageParams.fileSize	Document File Size. When the value not given, SDK will detect the size of the given FILE. When using the fileUrl SDK won't detect the size.	String	false
fileMessageParams.fileName	Document File Name. When the value not given, SDK will detect the name of the given FILE. When using the fileUrl SDK won't detect the name.	String	false
fileMessageParams.caption	Document Caption	String	false
replyMessageId	Message ID of Original Message	String	false
mentionedUsersIds	Array of Group Mentioned UsersIds	Array of Strings	false
topicId	Topic Id for the Message	String	false
metaData	MetaData for the Message	Object	false
onPending	Pending call back	function	true
onSuccess	Send Message success call back	function	true
onError	Send Message error call back	function	true

onSuccess:

{

chatType: "", // String - Chat Type - "chat"

createdAt: "", // String - Message Created Time

deleteStatus: "", // Number - Delete Status

favouriteBy: "", // String - Favourited By - User

favouriteStatus: "", //Number - Favourite status

fromUserId: "", // String - From User Id

fromUserJid: "", // String - From User Jid

metaData: {}, //Object - Meta data for the message

msgBody: {

media: { // For Media Message Only

caption: "", // String - Media Caption

duration: "", // String - Duration - For Audio/Videos

fileName: "", // String - File Name

file_size: "", // Number - File Size

fileToken: "", // String - File Url

is_downloaded: "", // Number - Downloaded Status

is_uploading: "", // Number - Uploading Status

local_path: "", // String - Local Path

thumb_image: "", // Base64 - Thumb Image

}

mentionedUsersIds: [] // Array of mentioned users

message_type: "", // String - Message Type

nickname: "", // String - nick name

},

msgId: "", // String - Unique Message Id

msgType: "", // String - Message Type

publisherId: "", // String - user Id

timestamp: 1681185232000, // Number - TimeStamp - Milliseconds

toUserId: "", // String - toUser Id

toUserJid: "", // String - toUser Jid

topicId: "", //String - Topic id for the message

},

caution

SDK.sendFileMessage() method was deprecated and will be removed in the future release. migrate to SDK.sendMediaFileMessage() method to send Document files.

Meet Message

Before you send the meet message, you need to create the meet link using the createMeetLink method. Once the meet link has been created successfully, you can send the Meet message.

caution

If Group call feature is unavailable for your plan, then it will throw 403 exception

SDK.createMeetLink();

Response Format

{

statusCode: `STATUS_CODE`,

message: `ERROR|SUCCESS message`,

data: "ehl-niyc-wcc"

}

You can send the meet message by using the sendMeetMessage method. You can share the title, link and schdueled date and time using this method.

caution

If Group call feature is unavailable for your plan, then it will throw 403 exception

await SDK.sendMeetMessage({

toJid: "",

link: "",

scheduledDateTime: 0,

title: "",

mentionedUsersIds: [],

topicId: "",

metaData: {}

});

Param	Description	Type	Required
toJid	JID of the To User/GROUP	JID String	true
link	Meet Link which we need to share	String	true
scheduledDateTime	Scheduled Date and Time	Number (Timestamp)	true
title	Meet Title which we need to share	String	false
mentionedUsersIds	Array of Group Mentioned UsersIds	Array of String	false
topicId	Topic Id for the Message	String	false
metaData	MetaData for the Message	String	false

Response Format:

statusCode: 200, // Number - status code

message: "", // String - Success/Error Message

data:

{

chatType: "", // String - Chat Type - "chat"

createdAt: "", // String - Message Created Time

deleteStatus: "", // Number - Delete Status

favouriteBy: "", // String - Favourited By - User

favouriteStatus: "", //Number - Favourite status

fromUserId: "", // String - From User Id

fromUserJid: "", // String - From User Jid

metaData: {}, //Object - Meta data for the message

msgBody: {

meet: {

        link: "ehl-niyc-wcc" // String - Link

        scheduledDateTime: 1695202750020, // Number - Timestamp - Milliseconds

      title: "", // String - Title

      }

      mentionedUsersIds: [], // Array of mentioned users

    message_type: "meet", // String - Message Type

      nickName: "", // String - nick name

    }

msgId: "", // String - Unique Message Id

msgType: "", // String - Message Type

publisherId: "", // String - user Id

timestamp: 1681185232000, // Number - TimeStamp - Milliseconds

toUserId: "", // String - toUser Jid

toUserJid: "", // String - toUser Jid

topicId: "", //String - Topic id for the message

},

Download Media

This method is used to get the media file url when we download the media.

await SDK.downloadMedia(msgId,

onPending((msgId) => {

// ...

}),

.onSuccess((response) => {

// ...

}),

.onError((error) => {

// ...

})

);

Request Param

Status	Description	Type	Required
msgId	msgId for the download message	String	true
onPending	Pending call back	function	true
onSuccess	Download Message success call back	function	true
onError	Download Message error call back	function	true

onSuccess:

{

msgId: "" , // String

blobUrl: "", // String - blobUrl

blob: {

"size" : "", // Number - size

"type" : "" // String

}

}

Send Reply Message

To send a reply to the original message, we are using sendTextMessage by passing in the additional parameter original message-id.

await SDK.sendTextMessage({

toJid: "",

messageText: "",

replyMessageId: "",

mentionedUsersIds: [],

topicId: "",

metaData: {}

});

Request Param

Param	Description	Type	Required
toJid	JID of the To User/Group	JID String	true
messageText	Text Message Body	String	true
replyMessageId	Message ID of Original Message	String	true
mentionedUsersIds	Array of Group Mentioned UsersIds	Array	false
topicId	Topic Id for the Message	String	false
metaData	MetaData for the Message	Object	false