Open Nav

Chat APIs and Webhooks

Add backend logic to your chat servers and have complete control over chat data

CHAT API

Created for Businesses, Loved by Developers

Chat APIs that gives you the flexibility you always wanted so that you can build what you want, the way you want

automation
Automation & Workflows
Create custom workflows and manage them programmatically for greater speed and efficiency.
own your data
Own your Data
Configure webhooks to pass all chat data to your backend for deeper analytics and engage users with contextual messages.
integrations
Integrations
Programmatically move data between services to guarantee fluid information delivery for an integrated user experience.

User Management APIs

Register User
Use the Register User API to register any user into the system and also for every subsequent login they make.
Request
Response
                                
                                            {
                                                "userId":"user1234",
                                                "applicationId":"applozic-sample-app",
                                                "password":"1234"
                                            }
                                
                            
                                
                                    {
                                        "message": "REGISTERED.WITHOUTREGISTRATIONID",
                                        "userKey": "21fea543-2ade-494f-b905-6bab308d1b4f",
                                        "deviceKey": "d73e1b9d-cfab-414b-b871-a5c3783ac736",
                                        "lastSyncTime": 1454328502029,
                                        "contactNumber": "+911234567890",
                                        "currentTimeStamp": 1454328502023
                                    }
                                
                            
User Details
The User Details API allows you to fetch all details corresponding to a user to be stored in the application.
Request
Response
                                
                                    {
                                        "userIdList":["userId1","userId2"]
                                    }
                                
                            
                                
                                    [
                                    {
                                     "userId": "UserId1",// UserId of the user (String)
                                     "userName": "Name1",// Name of the user (String)
                                     "connected": true,// Current connected status of user, if "connected": true 											//that means user is online (boolean)
                                     "lastSeenAtTime": 12345679,// Timestamp of the last seen time of user (long)
                                     "createdAtTime": 148339090,//  Timestamp of the user's creation (long)
                                     "imageLink": "http://image.url",// Image url of the user
                                     "deactivated": false,// user active/inactive status (boolean)
                                     "phoneNumber": "+912345678954",// phone number of user
                                     "unreadCount": 10,// total unread message count
                                     "lastLoggedInAtTime": 1483342919147,//Timestamp of the user's last logged in 																			 //(long)
                                     "lastMessageAtTime": 1483343150550 //Timestamp of the user's last message 																				 //(long)
                                    },
                                    {
                                     "userId": "UserId2",// UserId of the user (String)
                                     "userName": "Name2",// Name of the user (String)
                                     "connected": true,// Current connected status of user (boolean)
                                     "lastSeenAtTime": 123456789,// Timestamp of the last seen time of user (long) 
                                     "imageLink": "http://image.url"// Image url of the user
                                    }
                                   ]
                                
                            
User Management
The suite of User Management APIs allows you to update user details or block and unblock a user programmatically.
Request
Response
                                
                                    {
                                        "email":"user email",
                                        "displayName":"user display name",
                                        "imageLink":"User profile image url",
                                        "statusMessage":"status Message"
                                    }
                                
                            
                                
                                    {
                                        "status":"success",
                                        "generatedAt": 1452347180639,// time value at which response is generated 																	//from server
                                        "response": "success"
                                      }
                                
                            

Group Management APIs

Create Group
Create custom group types based on your use case: Open Channels for forums, Closed Groups for admin moderated access and Public Groups for generic discussions.
Request
Response
                                
                                    {
                                        "clientGroupId":"Client Group Id",// optional
                                        "groupName" : "Group Name",
                                        "groupMemberList" : ["UserName1", "UserName2", "UserName3"],
                                        "imageUrl": "Group image Url",
                                        "admin":"UserName"
                                    }
                                
                            
                                
                                    {
                                        "status": "success",
                                        "generatedAt": 1464854985171,// time value at which response is generated from server
                                        "response": {
                                          "id": 274457,
                                          "clientGroupId": "Client Group Id",
                                          "name": "Group Name",
                                          "adminId": "TestUser",
                                          "membersId": [
                                            "UserName2",
                                            "UserName3",
                                            "UserName1",
                                            "TestUser"
                                          ],
                                          "users": [
                                            {
                                              "id": "77749a25-b260-4e37-aa62-12b8dfc64657",
                                              "userId": "UserName2",
                                              "connected": false,
                                              "createdAtTime": 1464854985050,
                                              "unreadCount": 0,
                                              "deactivated": false
                                            },
                                            {
                                              "id": "05c576da-538d-4f46-aa34-8ba4bccf98f0",
                                              "userId": "UserName3",
                                              "connected": false,
                                              "createdAtTime": 1464854985057,
                                              "unreadCount": 0,
                                              "deactivated": false
                                            },
                                            {
                                              "id": "894591fc-a48a-4e0a-ae9b-fd5125002f46",
                                              "userId": "UserName1",
                                              "connected": false,
                                              "createdAtTime": 1464854985062,
                                              "unreadCount": 0,
                                              "deactivated": false
                                            }
                                          ],
                                          "unreadCount": 0,
                                          "type": 2
                                        }
                                      }
                                
                            
Group Management
Suite of Group Management APIs to add or remove members in a group, update group details, delete a group and to manage other group settings.
Request
Response
                                
                                    // Add user
                                    {
                                        "userId":"user unique identifier ",
                                        "clientGroupId":"group unique identifier"  
                                    }
                                
                            
                                
                                    //Add user response
                                    {
                                        "status": "success",
                                        "generatedAt": 1452347180639, // time value at which response is generated from server
                                        "response": "success"
                                    }
                                
                            

Message Delivery APIs

Send Message
Send a message to any user or to any group either from the application admin level or from the user level.
Request
Response
                                
                                            //User send
                                            {
                                                "to":"John",
                                                "message":"Hi John"
                                            }
                                
                            
                                
                                 //User send response
                                 {
                                    "messageKey": "5-22bf4626-9019-4a4a-8565-6c0e40ecda96-1454398305364",
                                    "createdAt": 1454398305000
                                 }
                                
                            
Broadcast Message
The Broadcast Message API is used to send broadcast messages or announcements to a group of users.
Request
Response
                                
                                    {
                                        "userNames" : ["UserName1", "UserName2", "UserName3"],
                                        "clientGroupIds" : ["1", "2", "3"],
                                        "messageObject" : {
                                          "message":"Hi John"
                                        }
                                    }
                                
                            
                                
                                    {
                                        "status": "success",
                                        "generatedAt": 1542009185111
                                    }
                                
                            
Actionable Message
Send rich messages with custom metadata that supports interactive elements like buttons, carousels, lists etc.
Request
Response
                                
                                    {
                                        "to":"John",
                                        "message":"Hi John",
                                        "metadata":{
                                          "key1" : "value1",
                                          "key2" : "value2"
                                        }
                                    }
                                
                            
                                
                                    {
                                        "messageKey": "5-22bf4626-9019-4a4a-8565-6c0e40ecda96-1454398305364",
                                        "createdAt": 1454398305000
                                    }
                                
                            

Application Admin APIs

Create User
Use this API to create a dummy user that can act in the same way as that of a user to send and receive messages.
Request
Response
                                
                                    {
                                        "userId": "DemoUser", 
                                        "password": "Demo User password",
                                        "displayName": "Display Demo User Name", 
                                        "imageLink": "User profile image url", 
                                        "email": "User Email", 
                                        "createdAtTime": 1456148218000, // if want to create user on specific time
                                        "roleName":"BOT" // if want to create application Bot user
                                    }
                                
                            
                                
                                    {
                                        "status": "success",
                                        "generatedAt": 1470903020662,
                                        "response": "success"
                                    }
                                
                            
Dispatch Message
Use this API to programmatically send messages to any user or group of users directly from your backend.
Request
Response
                                
                                    {
                                        "message":"HI STEVE",
                                        "senderName":"john",
                                        "to": "steve"   
                                    }
                                
                            
                                
                                    {
                                        "status": "success",
                                        "generatedAt": 1542009043674,
                                        "response": {
                                          "messageKey": "5-fd65adc3-8687-425d-b13e-835216e8d8ac-1542009043648",
                                          "createdAt": 1542009043651
                                    }
                                
                            
Message History Export
Export complete message history corresponding to any parameter for deeper level analytics.
URL
Response
                                
                                    https://apps.applozic.com/rest/ws/analytics/message?applicationId=applozic-sample-app&pageSize=50


                                
                            
                                
                                    {
                                        "status": "success",
                                        "generatedAt": 1463673355057,  // time value at which response is generated from server
                                        "response": [
                                          {
                                            "id" : "5-agpzfmFwcGxvemljchMLEgZTdVVzZXIYgICAgLrcvwsM-1464093115599",
                                            "fromUserId" : "john",
                                            "toUserId" : "steve",
                                            "groupName" : null,
                                            "content" : "Hello",
                                            "createdAtTime" : 1458039322000,
                                            "deliveredAtTime" : 1458039322000,
                                            "readAtTime" : 1458039322000
                                          }
                                        ]
                                    }
                                
                            

Use Cases of Applozic Chat SDK

See what your peers from growing startups to global enterprises have built using Applozic

Actionable Messages
Pass custom metadata in messages from your backend for an interactive experience to facilitate keyparts of a customer’s journey.
Announcements
Send a message from your backend to multiple users at once. Users can also send broadcast messages to any group of users.
Chatbot Integration
Integrate custom chatbots for customer support, sales, and marketing to engage users with automated messages.
SVG B typing… Emily Taylor 12:23 PM 12:24 PM Wait. Let me check and get back to you. 1:15 PM Thanks Emily! How much do I have to pay you for the concert tickets? Write a message… Emily Paid you Remarks: Concert Tickets $680 Payment Request Pay Now Remarks: Concert Tickets $680 online Amy Moran 2:45 PM 2:51 PM Thanks! They look great. Here are few purses that might go with your look for brunch. Write a message… Buy Now Dior Handheld Bag Michael Kors Bag $2,400 $2,950 Black Leather Bag Buy Now Buy Now Buy Now
Mary Reyes online I want to reschedule my hotel booking. 1 December Thanks Please enter your new booking date. Okay. Booking rescheduled. 01 - 03 Sat - Mon Dec 2018 1 Room ID: 552382830489 Hyatt Regency New Delhi 2:51 PM Write a message… Write a message… Aaron Hicks online Hi! How may we help you? Please select one of the options as it will help us in responding faster. Hi! How may we help you? Please select one of the options as it will help us in responding faster. Kommunicate Support Bot Just checking out Just checking out General Queries Tech Queries Need a demo
SVG Broadcast Lists Carol, Danny , Emil y , Jane, Mark, Pete, Richard, Susan… Recipients : 12 David, Kathryn, Richard, Stella Recipients : 4 Annie, Brian, Emily , Gregor y , Michael, Olive r , Paul, Pete Recipients : 8 David, Kathryn, Richard, Stella Messages 2:51 PM Hi everyone, The meeting scheduled for 15:00 hrs has been postponed by 1.5 hrs. Plz gather in the meeting room by 16:30. Thanks! You created a broadcast list with 4 recipients Write a message…

World’s most innovative companies trust Applozic for their in-app messaging needs

Applozic In-app Messaging APIs power chat in more than 10,000 applications and loved by over 150,000 developers

We were planning a static intercom system with much less complexity, but with Applozic we not only saved development time but also got a far more advanced product - real time chat!
sven ernst
Sven Ernst
CTO - YogaTrail

Need help with finding the right solution?

Contact Us