QuickBlox Documentation

QuickBlox provides powerful Chat API and SDK to add real-time messaging and video calls to your web and mobile apps. Learn how to integrate QuickBlox across multiple platforms and devices. Check out our detailed guides to make integration easy and fast.

Introduction

Learn about QuickBlox platform features and documentation guidelines.

QuickBlox provides you with ready-to-use chat and video calling solutions for your apps. Using our documentation you can quickly integrate QuickBlox across multiple platforms and devices.

Before we begin

  1. Register a QuickBlox account. This is a matter of a few minutes and you will be able to use this account to build your apps.
  2. Create and configure a new app. Click Add new app button and fill in the information about your company.
  3. Get credentials. Go to the Overview section on your Dashboard and copy Application ID, Authorization Key, Authorization Secret, and Account Key.

QuickBlox features

Use QuickBlox SDK to add rich chat and video calling features in your apps. Our SDK has a modular structure. Here is a list of all QuickBlox SDK modules with their features:

Chat

  • Private and group chat between two users and multiple users in a group.
  • Message history allows for storing messages on the server and fetching them for a particular dialog.
  • Presence enables real-time presence updates. For example, if a user is online/offline.
  • Message status and typing indicators let others know if the message is sent, read, or being typed.
  • Rich messaging allows sending a text, picture, video, audio, and other files.
  • Location sharing enables sending the real-time location in a message.
  • Unread message count shows a number of unread messages in a chat.
  • Chat moderation includes profanity filtering and user ban.
  • Chatbot functionality is based on third-party integrations.

Video Calling

  • Voice and video calls of high quality.
  • One-to-one calls for private communication.
  • Group calls with up to 4 users at a time.
  • Screen-sharing enables a user to instantly see another user's screen.
  • Mute/unmute audio/video stream (own and opponents).
  • Camera switch allows for switching video inputs.

Video Conference

  • Voice and video calls of high-quality.
  • Video conference allows setting up a video conference between 10-12 people.
  • Join/rejoin a meeting or continue an earlier meeting with those who were in it.
  • Mute/unmute audio/video stream (own and opponents).
  • Camera switch allows for switching video inputs.

Users

  • User tags let you assign tags to users and then address them separately by tags.
  • Existing user base integration supports connection to your system by storing a table with your existing IDs and matching them to new ones.
  • Multiple login includes a login via email/login, social networks, phone number, and custom identity provider.

Push Notifications

  • Offline messages are the best solution to get your messages delivered even if your recipient is offline.
  • Offline calls enable making a video/audio call with offline opponents.
  • Messages queue enables sending notifications instantly or push them in a message queue according to a specific time/date.
  • Recurring notifications allow setting a time interval, so the message will be repeated automatically by the server.
  • Notifications by user tags enable sending notifications to specific user groups defined by tags.

Content

  • Rich attachments allow rich media attachments such as video, audio, location data, etc.
  • File storage for storing photos, videos, documents, etc.
  • Content management enables managing text, rich text, and media via the Dashboard.
  • Synchronization provides app content synchronization in the background.

Custom Objects

  • Key-value storage lets you create a flexible data schema.

Address Book

  • Contacts synchronization allows keeping your contacts in sync across all devices or individual for each device.

Getting around

Our documentation is split into two basic sections:

  1. Documentation. Here you can explore our SDKs in-depth. QuickBlox supports multiple platforms including iOS, Android, JavaScript, React Native, and Flutter. Learn all fundamentals for integrating and configuring our SDKs for each particular platform.
  2. Server API. Use QuickBlox Server API to establish a server-to-server connection between your application and QuickBlox server and fulfill activities associated with chat. Our API documentation is organized around modules. Each module contains a set of specific API requests and respective endpoints. Find a list of parameters and their descriptions below each request.

Basic recommendations

Here are basic recommendations for navigating our documentation.

  1. It’s better to start with our Key Concepts page to get an overall understanding of QuickBlox.

  2. Take a look at our Code Samples page with a collection ready-to-go apps for the most popular platforms.

  3. Move over to the Quick Start guide of the platform you want to add the QuickBlox to. Learn how to run the code sample and send your first message from here.

  4. Refer to our Setup page to learn how to initialize, connect, and configure QuickBlox SDK so it works seamlessly with your app.

  5. Check other pages to customize QuickBlox further. Following other sections, you will understand how to implement each particular functionality in detail whether it is Chat, Video Calling, Push Notifications, etc.

  6. Suggest improvements using the Suggest edits tool. We will consider them for upcoming releases. QuickBlox aims to create first-rate interactive documentation. Explore our SDKs and API and let us know if you need any assistance.

Updated 24 days ago


What's Next

Key concepts

Introduction


Learn about QuickBlox platform features and documentation guidelines.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.