Once authenticed, users can send or received messages such as: text, photo, vieo, audio, location, contact... To send a message contains media content (photo, video, audio, file...), you need to upload media content to your server first. Then you use Stringee SDK to send the uploaded url.
Create a message in JSON format:
// Text message
var txtMsg = {
type: 1,
convId: "YOUR_CONVERSATION_ID",
message: {
content: 'Hello',
metadata: {
key: 'value'
}
}
};In which:
message: {
// Audio
audio: {
duration: // number type, value in milliseconds.
filePath: // audio file's url.
},
// Contact
contact: {
vcard: // contact as vcard, string value.
}
// File
file: {
filePath: // file's url.
filename: ,
length: // number type, number of bytes
}
// Location
location: {
lat: // number type, latitude
lon: // number type, longitude
}
// Photo
photo: {
filePath: // photo file's url.
thumbnail: // thumbnail file's url.
ratio: // number type
}
// Text
content: ''
// Video
video: {
filePath: // photo file's url.
thumbnail: // thumbnail file's url.
ratio: // number type
duration: // number type, value in milliseconds.
}
// Sticker
sticker: {
name: // string type
category: // string type
}
}Ex: Location message.
var locationMsg = {
convId: 'ABC',
type: 9, // location message type
message: {
location: {
lat: 123
lon: 456
},
metadata: {
key: 'value'
}
},
}Send a Message by calling:
var txtMsg = {
type: 1,
convId: "YOUR_CONVERSATION_ID",
message: {
content: 'Hello'
}
};
stringeeChat.sendMessage(txtMsg, function (status, code, message, msg) {
console.log(status + code + message + "msg result " + JSON.stringify(msg));
});Messages are stored on Stringee server. You can get messages as follows:
To get latest messages from Stringee server, you call:
var convId = 'YOUR_CONVERSATION_ID';
var count = 50;
var isAscending = false;
stringeeChat.getLastMessages(convId, count, isAscending, function (status, code, message, msgs) {
console.log('status:' + status + ' code:' + code + ' message:' + message + ' conv:' + JSON.stringify(msgs));
});In which:
To get a list of messages tied to a conversation from server which have sequence greater than another sequence, you call:
var convId = 'YOUR_CONVERSATION_ID';
var count = 50;
var isAscending = false;
var sequence = 10;
stringeeChat.getMessagesAfter(convId, sequence, count, isAscending, function (status, code, message, msgs) {
console.log('status:' + status + ' code:' + code + ' message:' + message + ' conv:' + JSON.stringify(msgs));
});In which:
To get a list of messages tied to a conversation from server which have sequence smaller than seq, you call:
var convId = 'YOUR_CONVERSATION_ID';
var count = 50;
var isAscending = false;
var sequence = 10;
stringeeChat.getMessagesBefore(convId, sequence, count, isAscending, function (status, code, message, msgs) {
console.log('status:' + status + ' code:' + code + ' message:' + message + ' conv:' + JSON.stringify(msgs));
});In which:
Stringee keeps track of the recipient status of each message. There are five possible statuses: INITIALIZE, SENDING, SENT, DELIVERED, READ. Stringee automatically updates the recipient status to sent, delivered. The only update your app can perform is to mark a conversation's messages as read:
var convId = 'YOUR_CONVERSATION_ID';
stringeeChat.markConversationAsRead(convId, (status, code, message) => {
console.log("status-" + status + " code-" + code + " message-" + message);
});Stringee notify you the status update of a message via the onObjectChange event of StringeeChat.
To delete a message, you call:
var convId = 'YOUR_CONVERSATION_ID';
var msgId = 'YOUR_MESSAGE_ID';
stringeeChat.deleteMessage(convId, msgId, function (status, code, message) {
console.log('status:' + status + ' code:' + code + ' message:' + message);
});In order to pin a message in a conversation, call the following function:
var convId = 'YOUR_CONVERSATION_ID';
var msgId = 'YOUR_MESSAGE_ID';
stringeeChat.pinMessage(convId, msgId, isPin, function (status, code, message) {
console.log('status:' + status + ' code:' + code + ' message:' + message);
});In which:
Other participants in conversation will receive an event, implement the following event to listen:
stringeeChat.on('pinMsgFromServer', function (info) {
console.log('pinMsgFromServer ' + JSON.stringify(info));
});You can only text message, you can call the following function to do that:
var convId = 'YOUR_CONVERSATION_ID';
var msgId = 'YOUR_MESSAGE_ID';
var chatContent = "New text";
stringeeChat.editMessage(convId, msgId, chatContent, function (status, code, message) {
console.log('status:' + status + ' code:' + code + ' message:' + message);
});In which:
Other participants in conversation will receive an event, implement the following event to listen:
stringeeChat.on('editMsgFromServer', function (info) {
console.log('editMsgFromServer ' + JSON.stringify(info));
});In order to revoke a message, call the following function:
var convId = 'YOUR_CONVERSATION_ID';
var msgId = 'YOUR_MESSAGE_ID';
stringeeChat.revokeMessage(convId, msgId, function (status, code, message) {
console.log('status:' + status + ' code:' + code + ' message:' + message);
});In which:
Other participants in conversation will receive an event, implement the following event to listen:
stringeeChat.on('revokeMsgFromServer', function (info) {
console.log('revokeMsgFromServer ' + JSON.stringify(info));
});