OneChat - API

Guide to make API call

API calls need to be made programmatically in regular intervals to obtain the constant stream of data for your respective development or research needs. For illustration purposes, the API call below is being made via a third-party application – Postman.

Steps to making an API call:

1. Download and install the Postman from Fire it up!
2. Make sure Http method is set to POST.
3. Enter the URL (refer to subsequent pages in this document) in the field request URL.
4. Enter your API Key under Headers.
5. Enter the message details under Body.
6. Click on the Send button.

The figure below shows the JSON response of an API call made for particulars by name API.

Mass broadcast API

URL:

Description: Allows admin/system to mass broadcast to every user in the specific domain

1-2-1 alert message relay API

URL:

Description: Allows admin/system to send message to a particular user

Group alert message relay API

URL:

Description: Allows admin/system to send message to a particular group

Chat Plugin Javascript Library Functions

The below documentation refers to the OneChat Javascript library based functions and variables which can be plugged into any website to give it OneChat messaging capabilities.

init function

 ocwp.init({  prop: value, }); 

Example

 ocwp.init({  confPath: './config/',  locale: {  path: './locale/',  default: 'enGB', // loading enGB.json as default  },  containerElement: document.getElementById('onechatContainer'),  chatbox: {  marginLeft: 5, // margins between chat box  marginRight: 5, // margins between chat box  maxHeight: 600,  maxWidth: 600,  minHeight: 100, // default height when open  minWidth: 250, // default width when open  paddingTop: 80,  outerPaddingLeft: '350px', // padding on the left, set the width of the left bar here to prevent open
chat boxes from covering the bar  outerPaddingRight: 0, // padding on right  },  // LOGIN ON INIT  login: {  usr: 'jid',  pw: 'password',  }, }); 

login function

 ocwp.login(usr: string, pw: string); 

Example

 ocwp.login(‘’, ‘your-password-goes-here’); 

logout function

 ocwp.logout(); 

Example

 ocwp.logout(); 

createNewGroupChat function

 ocwp.chat.group.create({  prop: value, }); 

Example

 ocwp.chat.group.create({  members: ['memberjid1@domain', ...],  chatName: 'Name of chat’,  chatAvatar: 'path/to/image.jpg',  chatJid: 'xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx', }); 

getConnectionStatus function

 ocwp.getConnectionStatus(); 

Example

 ocwp.getConnectionStatus(); // “XMPP_CONNECTION_IDLE" 

subscribeConnectionStatus function

 ocwp.subscribeConnectionStatus(callback :Function); 

Example

 function onConnectionStatusChanged (status) {  if (status == ‘XMPP_CONNECTION_DISCONNECTED’) {  ocwp.login(jid, pw);  } }  ocwp.subscribeConnectionStatus(onConnectionStatusChanged); 

unsubscribeConnectionStatus function

 ocwp.unsubscribeConnectionStatus(); 

Example

 ocwp.unsubscribeConnectionStatus(); 

VERSION variable

 ocwp.VERSION 

Example

 ocwp.VERSION  // 4474 

BUILD_DATE variable

 ocwp.BUILD_DATE 

Example

 ocwp.BUILD_DATE  // 20180619 

Mini App Library Functions

The below documentation refers to the OneChat Javascript library based functions and variables which can be used to integrate it with OneChat as a Mini App.

OC.user.getSessionID

 OC.user.getSessionID(); 

Example

 // JavaScript // on DOMContentLoaded document.addEventListener("DOMContentLoaded", function(event) {  const sessionId = OC.user.getSessionID();  console.log(sessionId); }); 

OC.user.deviceInfo

 OC.user.deviceInfo(); 

Example

 // JavaScript document.addEventListener("DOMContentLoaded", function(event) {  const deviceInfo = OC.user.deviceInfo();  console.log(deviceInfo);  // '{"device":"iPhone 7","os":"iOS 11.0","screenWidth":"","screenHeight":""}' }); 

OC.user.getVCard

 OC.user.getVCard(); 

Example

 // JavaScript document.addEventListener("DOMContentLoaded", function(event) {  const vCard = OC.user.getVCard();  console.log(vCard);  // '{"jid":"","userName":"Your username","avatar":"data:image/png;base64,/9j/4AAQSkZJRgABAQAASABIAAD..."}' }); 

OC.user.selectContacts

 OC.user.selectContacts({  success: function(selected) {  },  maxNumberOfSelection: 1, }); 

Example

 document.addEventListener("DOMContentLoaded", function(event) {  // selectContacts({ success, maxNumberOfSelection });  // maxNumberOfSelection (optional): 1, 2, 3..., -1 for unlimited (default)  OC.user.selectContacts({  success: function(selected) {  console.log(selected);  // 2 contacts selected  // '["",""]'  // or canceled  // '[]'  if (selected.length > 0) {  // do things  }  },  maxNumberOfSelection: 1,  }); }); 

OC.message.single.relay

 OC.message.single.relay({  recipient: '["",""]',  textMessage: 'hello friend',  success: function() {  },  fail: function(err) {  console.log(err);  }, }); 

Example

 document.addEventListener("DOMContentLoaded", function(event) {  // retrieve an array of users from selectContacts  // message will be sent to each of the user(s) in the array of contacts  // recipient and textMessage are mandatory  OC.message.single.relay({  recipient: '["",""]',  textMessage: 'hello friend',  success: function() {  // all message sent successfully  },  fail: function(err) {  // Ops, handles fail accordingly  console.log(err);  },  }); }); 

OC.message.group.relay

 OC.message.group.relay({  groupJid: '',  invitees: '["",""]',  textMessage: 'hello group',  success: function(newGroupJidCreated) {  },  fail: function(err) {  console.log(err);  }, }); 

Example

 document.addEventListener("DOMContentLoaded", function(event) {  // retrieved a array of users from selectContacts (optional, if group is provided)  // groupJid (optional): new group will be created with invitees as members if not defined  // invitees (optional): array of users, will be ignored if groupJid is given  // message will be send to the group chat  // ONE of groupJid or invitees must be provided, textMessage is mandatory  OC.message.group.relay({  groupJid: '',  invitees: '["",""]',  textMessage: 'hello group',  success: function(newGroupJidCreated) {  // message sent successfully  // if groupJid wasn’t provided, a new group will be automatically created and group jid returned here, store this value to send updates to this group  },  fail: function(err) {  // Ops, handles fail accordingly  console.log(err);  },  }); }); 

registerMiniApp

URL:

Description: Register new mini app in OneChat Admin Portal

authenticateUser

URL:

Description: Authenticate user session ID for Mini App Server