Mesibo Backend APIs (Server-side APIs) on mesibo documentation

Mesibo Backend APIs - User Management

Mon, 01 Jan 0001 00:00:00 +0000

Before your users can use mesibo services, mesibo need to know about your users so that mesibo can enable real-time messaging, calls, and conference between them.

mesibo identifies each user by a unique random string, called address. The address can be anything, for example, phone number, email address, your enterprise user ID, etc. You need to create a mesibo user for each of your app users.

mesibo will generate an authentication token when you create a user. This user token is also called the access token. You need to send this token to your apps so that your app can initialize mesibo Mesibo Real-time APIs using this token. Refer to the Get Started tutorial to learn more about it.

Mesibo Backend APIs - Group Management

Mon, 01 Jan 0001 00:00:00 +0000

mesibo allows you to create groups having a set of users as group members. Once you create a group, you can send messages to the group, and all the group members will receive the messages.

Unless you have a specific need for creating groups using backend API, we recommend using real-time Group Management APIs to create groups and add members. It is real-time, powerful, and works across both cloud and on-premise deployment without any changes.

Mesibo Backend APIs - Messaging

Mon, 01 Jan 0001 00:00:00 +0000

While your users can send messages to each other or groups using Mesibo real-time APIs, your backend can also send messages to one of your users or groups using backend API.

To send a message, you need to send a message JSON request to the backend API, for example:

{
 "op": "message",
 "token": "ptlk9hdel1gqxf3p0s15f5f5gtusldej18tl794suzit",

 "message": {
 "from": "me",
 "to": "you,she,he",
 "gid": 111,
 "type": 0,
 "expiry": 3600,
 "flags": null,
 "forced": true,
 "message": "This is my message"
 }
}

Parameter	Description	Default
op	MUST have the value - “message” (see example above)	Mandatory
token	Application Token obtained from the mesibo console	Mandatory
message.from	From address [MUST be a valid user]
message.to	To addresses, comma separated
message.gid	Group ID	0
message.type	Message Type	0
message.expiry	Expiry in seconds	1 year
message.when	Schedule after `when` seconds	0 (now)
message.message	Message
message.url	File URL
message.title	Title, when sending a file URL

If the request is successful, the response will be like,

Mesibo Backend APIs - Push Notifications

Mon, 01 Jan 0001 00:00:00 +0000

This section describes how to configure push notification credentials using backend APIs. For in-depth details on how to use mesibo push notifications and configuration using the console, refer to the mesibo push notification documents.

If you are using the mesibo on-premise server, it is highly recommended to use backend APIs to configure push notifications instead of the mesibo console. This ensures complete privacy of your push notification credentials. If you configure push notifications using both the backend API and the console, the on-premise server will give preference to the credentials configured via the backend APIs, which are saved in your database.

Mesibo Backend APIs - Scripting and Chatbot Configuration

Mon, 01 Jan 0001 00:00:00 +0000

This section describes how to upload and manage scripts for the mesibo scripting and chatbot feature using the Backend APIs. For in-depth details on how to use mesibo scripting and chatbot features, refer to the mesibo Scripting and Chatbot Documentation.

If you are using the mesibo on-premise server, you must use the Backend APIs to upload and manage scripts. This also ensures complete privacy of your scripts.

If you are using the mesibo cloud service, you can use either the Console or the Backend APIs.

Mon, 01 Jan 0001 00:00:00 +0000

Mesibo Backend APIs - User Access Control (UAC)

UAC allows you to assign different feature sets to different classes of users instead of managing each user and each feature individually. UAC provides granular controls across messaging, calls, presence, group calls, location, files, and more, enabling you to configure and assign precise capabilities to different user segments in your app. User segments vary by application type, for example:

Social Apps: Free users vs. paid subscribers
Telemedicine: Doctors, patients, administrative staff
Enterprise: HR, managers, employees, contractors
Education: Teachers, students, administrators
Marketplaces: Buyers, sellers, verified merchants

Each segment can be assigned different UAC configurations with specific feature sets tailored to their needs and subscription level. When you need to change feature sets or enhance your app with new capabilities, simply modify the UAC configuration once and it automatically applies to all assigned users, eliminating the need to update each user individually. Similarly, you can instantly change a user’s feature set by switching their assigned UAC. For example, when a free user becomes a paid subscriber, assigning them a different UAC immediately grants them the enhanced feature set without any manual configuration.

Mesibo Backend APIs - Hosting Backend APIs

Mon, 01 Jan 0001 00:00:00 +0000

If you are using mesibo on-premise, mesibo (and mesibo console) will NOT have any access to your on-premise setup or database. Hence, there are only limited operations (useradd, userset, and usertoken) you can perform with mesibo hosted backend API when using on-premise. For all other operations like group management or sending messages, you will need to use real-time APIs, for example, real-time group APIs.

Alternatively (though OPTIONAL), you can host entire backend APIs to your own server. This will enable you to access entire backend APIs while using mesibo on-premise. Even if you are not using backend APIs for group management or sending messages, it is highly recommended that you enable and use backend APIs bundled with mesibo docker image as it will update your database instantly and also give you access to additionals ops like usersget, groupsget, etc.

mesibo Backend API Playground

Mon, 01 Jan 0001 00:00:00 +0000

mesibo Backend API Playground

This is an interactive playground for trying out REST based mesibo Backend APIs. You can administer your account, manage apps, manage users and groups etc using backend APIs. Refer to Backend API Documentation to know more.

Mesibo Backend APIs - Group Management

Mon, 01 Jan 0001 00:00:00 +0000

mesibo allows you to create groups having a set of users as group members. Once you create a group, you can send messages to the group, and all the group members will receive the messages.

Unless you have a specific need for creating groups using backend API, we recommend using real-time Group Management APIs to create groups and adding members. It is real-time, powerful, and works across both cloud and on-premise deployment without any changes.