Chat APIs and In-app Messaging SDKs for Developers

Applozic provides Chat APIs and In-app Messaging SDKs for Android, iOS and Web apps to power cross-device, multi-platform rich messaging.
Find comprehensive guides and platform-specific Chat API documentation to get started with In-app Messaging.

Get Started    
Suggest Edits

Application Admin

Authentication details for application admin user

 

Platform API's allows you to directly connect to the Applozic Cloud Messaging Backend Server. It can be accessed as Application Bot or Application User. Both have a different set of credentials and privileges associated with them. Application Bots can access the data of any user within application whereas Application Users have the limited access and cannot access others user's private data.

There can be multiple application bot for an application. A default bot user is automatically created for all the applications. You must change the password of default bot user before start using it.
Go to Applozic dashboard --> Choose your application key --> Go to Users --> Select the Role filter to Bot in the top right corner and click SHOW USERS. Edit the bot user information and set a password.

Alternatively, you can create a new bot user. Click on CREATE USER button in the top right corner in the Users section.

For Application Bot, pass the following authentication headers with each API call:

Header
Description

Application-Key

Applozic Application key of bot user.

Authorization

Authorization Code. Authentication is done using BASIC authentication.
Authorization Code is a combination of the base64 value of user id & password of the bot user.
Basic Base64Encode of "botUserId:password".

Content-Type

application/json

Of-User-Id

It is the userId on behalf of which Application bot wants to call the API.

Note:

Pass Of-User-Id header only where it is required, it is specified in the API details.

Example: If the user id of the bot user is adminbot and password is botpassword, then the headers will be:

Header Keys
Values

Application-Key

21040368s3869d9b2b7b2f953ae28cf

Authorization

Basic YWRtaW5ib3Q6Ym90cGFzc3dvcmQ=

Content-Type

application/json

Suggest Edits

Application User

Authentication details for application user

 

For Application User, all request r must contain following headers:

Header
Description

Application-Key

Your Application Key

Device-Key

deviceKey is received when application user does registration using register/client API. You also need device Key to create Authorization header below.

Authorization

Authentication is done using BASIC authentication.
Basic Base64Encode of "userId:deviceKey"

Example: If the userId is robert and deviceKey is 09c5d869-6d38-4d6b-9ebf-9de16cdab176, then the headers will be:

Header Keys
Values

Application-Key

21040368s3869d9b2b7b2f953ae28cf

Device-Key

09c5d869-6d38-4d6b-9ebf-9de16cdab176

Authorization

Basic cm9iZXJ0OjA5YzVkODY5LTZkMzgtNGQ2Yi05ZWJmLTlkZTE2Y2RhYjE3Ng==

Note:

Additional header Access-Token is also required if the user password is set in Applozic.

Header Key
Value

Access-Token

User's password

Note:

Headers are required in each API call except user registration API.

Suggest Edits

How To Use API Explorer

 
  • Navigate to User Registration.
  • Enter your userId and applicationId in body params and hit the API.
  • The user will be registered and you'll get the following response:
{
  "message": "REGISTERED.WITHOUTREGISTRATIONID",
  "userKey": "2e2636e7-eb27-4150-8145-3fd24bb7dcb7",
  "deviceKey": "197f4af2-3ddc-4147-acd0-bed4ae617",
  "userId": "sampleuser",
  "displayName": "sampleuser",
  "lastSyncTime": 1517816169409,
  "currentTimeStamp": 1517816169398,
  "deactivate": false,
  "brokerUrl": "tcp://apps.applozic.com:8080",
  "pricingPackage": 11,
  "totalUnreadCount": 0,
  "roleType": 3,
  "metadata": {},
  "newUser": true
}
  • Copy the deviceKey value from response and use it to encode the userId:deviceKey in Base64Encode as instructed in the Application User Authentication page.
  • Use this encoded value in the Authorization field as shown below:
  • Also enter your application key in the Application-Key field.
  • Now you can try the APIs using the Try It button available in the API Explorer.
  • The headers will be saved for the current session. You'll need to enter it again if the page is reloaded.

You can also use your existing user's headers if you don't want to register a new user here. :)

Suggest Edits

User Registration

 
Suggest Edits

Register/Login User

Use this API to register or login user to application

 
posthttps://apps.applozic.com/rest/ws/register/client
{
  "userId":"user1234",
  "applicationId":"applozic-sample-app",
  "password":"1234"
}
A binary file was returned

You couldn't be authenticated

{
  "message": "REGISTERED.WITHOUTREGISTRATIONID",
  "userKey": "21fea543-2ade-494f-b905-6bab308d1b4f",
  "deviceKey": "d73e1b9d-cfab-414b-b871-a5c3783ac736",
  "lastSyncTime": 1454328502029,
  "contactNumber": "+911234567890",
  "currentTimeStamp": 1454328502023
}

Body Params

userId
string
required

User id will be used to login

applicationId
string
required

This is your application key

 

Request JSON Parameter Description:

JSON Parameter
Required
Default
Description

userId

Yes

User id for registration/login

email

No

null

User's email address

password

No

null

User account password

displayName

No

User's display name you want to show to other users

applicationId

Yes

Your Applozic application key configured in dashboard

deviceType

Yes

0 for web,1 for Android, 4 for iOS

authenticationTypeId

No

1

1 for password verification from Applozic server and 0 for access token verification from client server

registrationId

No

Device FCM or APNS registration id for push notification

pushNotificationFormat

No

0 for Standard (FCM/APNS) and 1 for PhoneGap

userTypeId

No

This parameter can be used to distinguish different type of users within application. Example: For an educational app, userTypeId = 1 means Student,
userTypeId = 2 means Teachers.

contactNumber

No

User's contact number

unreadCountType

No

0

0 = do not show unread badge count on app icon in iOS devices
1 = show the unread badge count on app icon in iOS devices

Note:

No header required for registration API.

Response JSON Parameter Description:

Response Parameter
Description

message

One of the following is returned.

REGISTERED : New user register with APNS/FCM push notification token.

REGISTERED.WITHOUTREGISTRATIONID : New user registration without APNS/FCM push notification token.

UPDATED : Old user logged-in

userKey

User key for the given user id

deviceKey

User's device key

lastSyncTime

Time in milliseconds when user's device last synced with the server

contactNumber

User's contact number, received only if passed

currentTimeStamp

Time in milliseconds when the response is returned from server

Note:

deviceKey need to be stored and sent in request header in each API call.

The following JSON will come in response in case of no userId or applicationId passed:

{
  "message": "INVALID_PARAMETER",
  "currentTimeStamp": 1454328359265
}
 
Suggest Edits

User Details

Use this API to fetch user details based on user id or phone number

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/user/v2/detail
{
  "userIdList":["userId1","userId2"]
}
A binary file was returned

You couldn't be authenticated

[
 {
  "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
 }
]

Body Params

userIdList
array of strings

Array of user ids for which the details will be fetched

phoneNumberList
array of strings

Array of phone numbers

 

Note:

API supported by both Application Bot and Application User.

JSON Parameter Description:

JSON Parameter
Required
Default
Description

userIdList

No

List of userIds

phoneNumberList

No

List of phoneNumbers

Note:

Pass either userIdList or phoneNumberList.

Suggest Edits

Update User Details

Use this API to update user details

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/user/update
{
  "email":"user email",
  "displayName":"user display name",
  "imageLink":"User profile image url",
  "statusMessage":"status Message"
}
A binary file was returned

You couldn't be authenticated

{
  "status":"success",
  "generatedAt": 1452347180639,  // time value at which response is generated 																	//from server
  "response": "success"
}

Body Params

email
string

User's new email address

displayName
string

User's new display name

imageLink
string

User's new profile image URL

statusMessage
string

User's new status message

 

Note:

In case of Application Bot, Of-User-Id header is required. Of-User-Id is the userId of the user for which Application Bot wants to update the details.

Request JSON Parameter Description:

JSON Parameter
Required
Default
Description

email

No

user email

displayName

No

display name of user

imageLink

No

image link of the user

statusMessage

No

status message of user

Suggest Edits

Update User Password

Use this API to change the user's password. User can update own password using this API.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/user/update/password
http://apps.applozic.com/rest/ws/user/update/password?oldPassword=qwerty1234&newPassword=mypass1234
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639,  // time value at which response is generated from server
  "response": "success"
}

Query Params

oldPassword
string
required

This is current password

newPassword
string
required

This is new password

 

Parameter Description:

Parameter
Required
Default
Description

oldPassword

Yes

Existing password

newPassword

Yes

New password

Suggest Edits

Contact List

Use this API to get contacts from application

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/user/filter
http://apps.applozic.com/rest/ws/user/filter?pageSize=20
A binary file was returned

You couldn't be authenticated

{
  "users": [
    {
      "userId": "mark",
      "connected": false,
      "lastSeenAtTime": 1461559344000,
      "createdAtTime": 1461559342000,
      "unreadCount": 0,
      "deactivated": false
    },
    {
      "userId": "john",
      "connected": true,
      "lastSeenAtTime": 1460801797000,
      "createdAtTime": 1460803509000,
      "unreadCount": 0,
      "displayName": "Edward",
      "deactivated": false
    },
    {
      "userId": "chris",
      "connected": true,
      "createdAtTime": 1460803509000,
      "unreadCount": 0,
      "displayName": "adam",
      "imageLink": "https://www.applozic.com/resources/images/applozic_logo.gif",
      "deactivated": false
    }
    (20 users detail list...)
  ],
  "lastFetchTime": 1460803509000,
  "totalUnreadCount": 0
}

Query Params

pageSize
int32

Number of contacts to load

startTime
int64

Pass this to load more contacts

userId
string

userId of user for which information has to be retrieved

role
string

Role of users for which information has to be retrieved

 

Parameter Description:

Parameter
Required
Default
Description

pageSize

No

500

Number of contacts to load in a single call

startTime

No

Use this parameter to load more contacts

userId

No

Pass userId of user for which information has to be retrieved

role

No

Pass role of users for which information has to be retrieved

These are the role types you can pass in the request,

role

BOT

USER

Note:

To load further contact list use lastFetchTime value from the response and pass it in startTime parameter.

Response Parameter Description:

userId

The unique user id of the user

userName or displayName

Display name of the user

imageLink

Profile image URL of the user

email

Email of the user

statusMessage

User's text status update

connected

true - the user is online
false - the user is offline

lastSeenAtTime

User's last seen at time in milliseconds

createdAtTime

Timestamp when the user was created

active

To identify whether the user is active in the current month

lastLoggedInAtTime

Timestamp when the user last logged in to the application

lastMessageAtTime

Timestamp when the user last sent or received a message

Suggest Edits

Block User

Use this API to block a user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/user/block
https://apps.applozic.com/rest/ws/user/block?userId=john
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1463673355057,  // time value at which response is generated from server
  "response": true
}

Query Params

userId
string
required

user id of the user who will be blocked

 

Parameter Description:

Parameter
Required
Default
Description

userId

Yes

Pass unique id of user you want to block

Note:

For Application Bot headers, Of-User-Id header is mandatory.
Of-User-Id is the userId of the user who wants to block another user.

Suggest Edits

Unblock User

Use this API to unblock a user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/user/unblock
https://apps.applozic.com/rest/ws/user/unblock?userId=john
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1463673355057,  // time value at which response is generated from server
  "response": true
}

Query Params

userId
string
required

user id of the user who will be unblocked

 

Parameter Description:

Parameter
Required
Default
Description

userId

Yes

Pass unique id of user you want to unblock

Note:

For Application Bot headers, Of-User-Id header is mandatory.
Of-User-Id is the userId of the user who wants to unblock another user.

Suggest Edits

User's Block List Sync

Use this API to sync user's block list

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/user/blocked/sync
https://apps.applozic.com/rest/ws/user/blocked/sync?lastSyncTime=1514444400000
A binary file was returned

You couldn't be authenticated

//Suppose API is called by user mink or application admin calling on behalf of user mink

{
  "status": "success",
  "generatedAt": 1484550889825,  // time value at which response is generated from server
  "response": {
    "blockedByUserList": [
      {
        "blockedBy": "mink2",   // User mink is blocked by user mink2
        "createdAtTime": 1484550881647,
        "userBlocked": true,   // user is blocked  
        "updatedAtTime": 1484550881650
      }
    ],
    "blockedToUserList": [
      {
        "blockedTo": "mink1",  // User mink  blocked user mink1
        "createdAtTime": 1484548333978,
        "userBlocked": true, // user is blocked
        "updatedAtTime": 1484548333982
      },
      {
        "blockedTo": "jack", // User mink  unblocked user jack
        "createdAtTime": 1484553240694,
        "userBlocked": false,  // user is unblocked
        "updatedAtTime": 1484553240695
      }

    ]
  }
}

Query Params

lastSyncTime
int64
required

The last sync time sent to the server

 

Request Parameter Description:

Parameter
Required
Default
Description

lastSyncTime

Yes

The last sync time sent to the server

Response Parameter Description:

Parameter
Value
Description

blockedByUserList

The list of users who has blocked the user calling the API

blockedBy

mink2

The API calling user is blocked by user mink2

blockedToUserList

The list of users who are blocked by the user calling the API

blockedTo

jack

The user has blocked the user jack

userBlocked

true

User is blocked

userBlocked

false

User is unblocked

For the next sync call, pass "lastSyncTime" parameter to get latest modification between user block/unblock state if any. Applozic API response contains "generatedAt" parameter which contains the timestamp at the time of server response. Use this timestamp as "lastSyncTime" for your next block sync API call.

Note:

In case of Application Bot calling the API, Of-User-Id header also required.
Of-User-Id is the userId of user for which bot user wants to get the blockedTo and blockedBy users list.

Suggest Edits

User Metadata

 

To add metadata for a user, send the metadata object inside the user object while creating user using Register/Login User API. The same metadata object will be received in User Details API with user object. The metadata object is a map with string keys and values.

Sample User Object JSON with Metadata:

{
 "userId":"DemoUser", 
 "password":"password",
 "displayName":"Display Name",
 "email":"sample@example.com",
  "metadata":{
      "key1":"value1",
      "key2":"value2",
      "key3":"value3"}
}

User metadata can be updated from the Update User Details API as below example:

{
 "userId":"DemoUser",
 "metadata":{
      "key1":"updated value1",
      "key2":"updated value2",
      "key3":"updated value3"}
}
Suggest Edits

Create Group

Use this API to create a group

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/v2/create
{
  "clientGroupId":"Client Group Id",  // optional
  "groupName" : "Group Name",
  "groupMemberList" : ["UserName1", "UserName2", "UserName3"],
  "imageUrl": "Group image Url",
  "admin":"UserName"
}
A binary file was returned

You couldn't be authenticated

{
  "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
  }
}

Body Params

groupName
string
required

Name of the group

groupMemberList
array of strings
required

Array of userIds of the group members

clientGroupId
string

Unique identifier of the group with respect to client

 

JSON Parameter Description:

JSON Parameter
Required
Default
Description

clientGroupId

No

Unique identifier assigned to group from client.

groupName

Yes

Name of the group.

groupMemberList

Yes

List of userIds of the group members.

type

No

2

Type of the group.

imageUrl

No

Image url for group.

admin

No

Set another user as admin of the group.

Note:

  • You can pass unique identifier in clientGroupId to identify groups. This can be useful in case you are storing group information in your backend and want to identify groups later.
  • If clientGroupId is not passed then Applozic will generate a unique id for the group which should be used as clientGroupId for all API calls.
  • In case of Application Bot calling the API, Of-User-Id header required. Of-User-Id is the userId of the user on behalf of which application bot wants to create a group.

Admin of group

If admin parameter is not passed, the caller will be added as an admin of the group. In case you are calling this API with admin header, of-user-Id will act as a caller and added as an admin of the group.

"type" parameter's possible values are given below:

Suggest Edits

Group Types

Possible values of group type for create group API

 
Value
Description

1

Private Group: Other users are not able to join this group voluntarily. Only group admin can add/remove members in this group.

2

Public Group: Users are able to search and join the group. Any group member can add/remove members in this group.

5

Broadcast Group: Message can be sent to several contacts at once. Message sent in the broadcast group is received by the members of the group as one to one chat thread. Only the message sender can see the broadcast group.

6

Open Group: Used for free-flowing chats such as live streaming chats, live event chats etc. You need not add any member to this group. All users present on the chat screen will receive messages via MQTT (publish/subscribe pattern). Push notifications are not supported in Open Group.

7

GroupOfTwo: Used for the purpose where dealers are selling multiple products and any particular user want to chat on multiple products with that same dealer. At that time, it is required to show two different chat threads in the conversation history for the same user as the context (product) of the chats is different.

9

Contacts Group: Used for creating Friend/Favourite contact List. These lists can be maintained on the application level and any member of the group can access it.

10

Support Group: Best suited for people who want to use Applozic's another Product Kommunicate which is specifically built for customer support.

Suggest Edits

Group Info

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/v2/info
 https://apps.applozic.com/rest/ws/group/v2/info?groupId=6689118
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1465310497564,
  "response": {
      "id": 496,
      "clientGroupId": "GroupId1",
      "name": "MultiGroup1",
      "adminId": "TestUser",
      "membersId": [
        "kevin",
        "john",
        "TestUser"
      ],
      "removedMembersId": [],
      "unreadCount": 0,
      "type": 2,
      "imageUrl": "https://www.applozic.com/resources/images/applozic_logo.gif",
      "createdAtTime": 1473836906978,
      "userCount": 3
    }
}

Query Params

groupId
int64

Group id of the group

clientGroupId
string

Client group id of the group

 

Parameter Description:

Parameter
Required
Description

groupId

No

Group Id of the group

clientGroupId

No

Client Group id of the group

Note:

  • Pass either groupId or clientGroupId to get the group information.
  • API supported for both Application Bot and Application User.
Suggest Edits

User's Group List

Use this API to get all the groups of the user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/v2/list
https://apps.applozic.com/rest/ws/group/v2/list?updatedAt=1514470790462
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1465310497564,    // time value at which response is generated from server
  "response": [
    {
      "id": 496,
      "clientGroupId": "GroupId1",
      "name": "MultiGroup1",
      "adminId": "TestUser",
      "membersId": [
        "kevin",
        "john",
        "TestUser"
      ],
      "removedMembersId": [],
      "unreadCount": 0,
      "type": 2
    },
    {
      "id": 497,
      "clientGroupId": "497",
      "name": "MultiGroup2",
      "adminId": "TestUser",
      "membersId": [
        "jade",
        "TestUser"
      ],
      "removedMembersId": [],
      "unreadCount": 0,
      "type": 2
    }
  ]
}

Query Params

updatedAt
int64

lastSyncTime to the server

 

Parameter Description:

Parameter
Required
Description

updatedAt

No

lastSyncTime to the server

Note:

  • For the next sync call, pass updatedAt parameter to get details of only the modified group or a newly added group for that user. Applozic API response contains generatedAt parameter which contains the timestamp at the time of server response. Use this timestamp as updatedAt for your next sync call.
  • In case of Application Bot header is used, Of-User-Id header must be passed. Of-User-Id is the userId of a user for which application bot wants to load the group list.
Suggest Edits

Add User To Group

Use this API to add a new member in the group

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/add/member
{
    "userId":"user unique identifier ",
    "clientGroupId":"group unique identifier"    
}
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639, // time value at which response is generated from server
  "response": "success"
}

Body Params

userId
string
required

User id of the user to be added in the group

clientGroupId
string
required

Group unique identifier

role
int32

User's role in the group

 

JSON Parameter Description:

Parameter
Required
Default
Description

userId

Yes

User id of the user to be added in the group

clientGroupId

Yes

Group unique identifier

role

No

3

Define the added user's role in the group

Possible values of role:

Parameter
Value
Description
Privilege

role

1

role will be admin

Full Access to group

role

2

role will be moderator

Add/remove users, Group Info update

role

3

role will be member

Group Info update

Application Bot

In case of Application Bot headers are used, Of-User-Id header is required.
Of-User-Id is the userId of the user on behalf of which application bot wants to add the members in the group.

Suggest Edits

Add Users To Many Groups

Use this API to add multiple users to multiple groups

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/add/users
 { 
   "userIds":["userId1","userId2","userId3"],
   "clientGroupIds":["groupId1","groupId2"]
 }
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639, // time value at which response is generated from server
  "response": "success"
}

Body Params

clientGroupIds
array of strings
required

Array of group unique identifiers

userIds
array of strings
required

Array of userIds to be added to the groups

 

JSON Parameter Description:

JSON Parameter
Required
Description

clientGroupIds

Yes

List of Group unique identifiers

userIds

Yes

List of Unique ids of the users to be added to the group

Application Bot

In case of Application Bot calling the API, Of-User-Id header required too. Of-User-Id is the userId of the user on behalf of which application bot wants to add multiple users to the groups.

Warning:

Groups for the passed clientGroupIds and the users for the passed userIds should exist in the application.

Suggest Edits

Remove User From Group

Use this API to remove a user from the group

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/remove/member
{
    "userId":"user unique identifier ",
    "clientGroupId":"group unique identifier"    
}
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639, // time value at which response is generated from server
  "response": "success"
}

Body Params

userId
string
required

userId of user to be removed from group

clientGroupId
string
required

Group unique identifier

 

JSON Parameter Description:

JSON Parameter
Required
Description

userId

Yes

User unique identifier to be removed from group.

clientGroupId

Yes

Group unique identifier.

Application Bot

In case of Application Bot calling the API, Of-User-Id header is required.
Of-User-Id is the userId of the user on behalf of which application bot wants to remove members from the group.

Warning:

Only Group Admin can remove the group member from private groups; otherwise, following error will be displayed:

{
  "status":"error",
  "errorResponse":[
    {
      "errorCode":"AL-UN-01",
      "description":"unauthorized user",
      "displayMessage":"Unable to process"
    }
  ],
  "generatedAt":1452348983616  // time value at which response is generated from server
}
Suggest Edits

Leave A Group

Users can leave a group using this API

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/left
{
  "clientGroupId":"group unique identifier"
}
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639,  // time value at which response is generated from server
  "response": "success"
}

Body Params

clientGroupId
string
required

Group unique identifier

 

JSON Parameter Description:

JSON Parameter
Required
Description

clientGroupId

Yes

Group unique identifier.

Suggest Edits

Remove Users From Many Groups

Use this API to remove multiple users from multiple groups

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/remove/users
{
  "userIds":["userId1","userId2","userId3"],
  "clientGroupIds":["groupId1","groupId2"]
}
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639, // time value at which response is generated from server
  "response": "success"
}

Body Params

clientGroupIds
array of strings
required

Array of clientGroupIds

userIds
array of strings
required

Array of Unique ids of the users to be removed from the group

 

JSON Parameter Description:

JSON Parameter
Required
Description

clientGroupIds

Yes

List of Group unique identifiers.

userIds

Yes

List of Unique ids of the users to be removed from the groups.

Application Bot

In case of Application Bot calling the API, Of-User-Id header is required.
Of-User-Id is the userId of the user on behalf of which application bot wants to remove the members from the groups.

Warning:

Groups for the passed clientGroupIds and the users for the passed userIds should exist in the application.

Suggest Edits

Remove User From All Groups

Use this API to remove user from all groups.
API supported by both application admin and application user.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/user/remove/group/all
https://apps-test.applozic.com/rest/ws/user/remove/group/all?userId=christopher
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639, // time value at which response is generated from server
  "response": "success"
}

Query Params

userId
string
required

user unique identifier

 

Warning:

API will remove User from all Private, Public and Open Groups.

Parameter Description:

Parameter
Required
Description

userId

Yes

user unique identifier

Note:

In case of Application Bot calling the API, Of-User-Id header is required. Of-User-Id is the userId of the user on behalf of which application bot wants to leave all the groups.

Suggest Edits

Update Group Details

Use this API to update group details

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/update
{
  "clientGroupId":"6686563",
  "newName":"The Starks",
  "imageUrl":"https://www.applozic.com/resources/images/applozic_logo.gif"
}
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639,  // time value at which response is generated from server
  "response": "success"
}

Body Params

groupId
string

Group unique identifier

clientGroupId
string

Client Group unique identifier

newName
string

New name of the group

imageUrl
string

New image url of the group profile image

 

JSON Parameter Description:

Parameter
Required
Description

groupId

No

Group unique identifier

clientGroupId

No

Client Group unique identifier

newName

No

New name of the group

imageUrl

No

New image url of the group profile image

Note:

  • Pass either groupId or clientGroupId.

  • In case of Application Bot calling the API, Of-User-Id header is required.
    Of-User-Id is the userId of the user on behalf of which application bot wants to update the group details.

To change role of group members:

Group Admin can update any group user's role by passing following request body:

{
  "clientGroupId": "group unique identifier",
  "users": [
    {
      "userId": "user unique identifier",
      "role": 1
    },
    {
      "userId": "user unique identifier",
      "role": 1
    }
  ]
}

Possible values of role:

Parameter
Value
Description
Privilege

role

1

role will be admin

Full Access to group

role

2

role will be moderator

Add/remove users, Group Info update

role

3

role will be member

Group Info update

To update group metadata:

Group Admin can update group's existing metadata value and can pass new metadata as well in request body:

{
  "clientGroupId": "226583",
  "metadata":{
    "HIDE":"true",
    "GROUP_ICON_CHANGE_MESSAGE": "Icon Changed"
  }
}
Suggest Edits

Update Group User Properties

Use this API to mute the group notifications

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/user/update
{
  "clientGroupId":"Client Group unique identifier",
  "notificationAfterTime":"time interval in milliseconds"
}
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639,  // time value at which response is generated from server
  "response": "success"
}

Body Params

clientGroupId
string

Client Group unique identifier

notificationAfterTime
int64

Time Interval in milliseconds upto which notification has to be disabled

 

JSON Parameter Description:

Parameter
Required
Description

userId

No

User identifier for One - One conversation

id

No

Group unique identifier

clientGroupId

No

Client Group unique identifier

notificationAfterTime

No

Time Interval in milliseconds upto which notification has to be disabled

Note:

In case of Application Bot calling the API, Of-User-Id header is required.
Of-User-Id is the userId of the user on behalf of which application bot wants to update group user properties.

Suggest Edits

Group - Is User Present

Check if user is part of a Group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/check/user
 https://apps.applozic.com/rest/ws/group/check/user?clientGroupId=6689118&userId=Alexander
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1463673355057,  // time value at which response is generated from server
  "response": true/false
}

Query Params

clientGroupId
string
required

Group unique identifier

userId
string
required

UserId of the user to be checked in the group

 

Parameter Description:

Parameter
Required
Description

clientGroupId

Yes

Group unique identifier

userId

Yes

UserId of the user to be checked in the group

Note:

In case of Application Bot calling the API, Of-User-Id header is required.
Of-User-Id is the userId of the user on behalf of which application bot wants to check user in the group.

Suggest Edits

Group Users Count

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/user/count
https://apps.applozic.com/rest/ws/group/user/count?clientGroupIds=6689118&clientGroupIds=6686563
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1469293877608,
  "response": [
    {
      "id": 503,
      "clientGroupId": "503",
      "userCount": 3
    },
    {
      "id": 504,
      "clientGroupId": "clientGroupId",
      "userCount": 5
    }
  ]
}

Query Params

clientGroupIds
string
required

List of Group unique identifiers

 
Suggest Edits

Delete A Group

Use this API to delete a group

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/delete
 https://apps.applozic.com/rest/ws/group/delete?clientGroupId=6689118
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1463673355057,  // time value at which response is generated from server
  "response": true
}

Query Params

clientGroupId
string
required

Group unique identifier

 

Parameter description:

Parameter
Required
Description

clientGroupId

Yes

Group unique identifier

Note:

In case of Application Bot calling the API, Of-User-Id header is required.
Of-User-Id is the userId of the group admin user on behalf of which application bot wants to delete the group.

Note:

Only Group Admin can delete the group otherwise the following error will be displayed:

{
  "status":"error",
  "errorResponse":[
    {
      "errorCode":"AL-UN-01",
      "description":"unauthorized user",
      "displayMessage":"Unable to process"
    }
  ],
  "generatedAt":1452348983616   // time value at which response is generated from server
}
Suggest Edits

Delete Multiple Groups

Use this API to delete multiple groups

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/multiple/delete
https://apps.applozic.com/rest/ws/group/multiple/delete?groupIds=6211202&groupIds=6211173
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639, // time value at which response is generated from server
  "response": "success"
}

Query Params

groupIds
int64

Unique group id

clientGroupIds
string
required

Unique group id with respect to client

 

Parameter Description:

Parameter
Required
Description

groupIds

Yes

Group unique identifier

clientGroupIds

Yes

Group unique identifier with respect to client

Note:

  • In case of Application Bot calling the API, Of-User-Id header is required.
    Of-User-Id is the userId of the group admin user on behalf of which application bot wants to delete the groups.
  • This API supports both GET and POST call.
  • Either pass groupIds or clientGroupIds.
Suggest Edits

Open Channel (or Group)

Use this API to get the list of open groups

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/v2/channel
 https://apps.applozic.com/rest/ws/group/v2/channel?pageSize=10
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1487742549494,
  "response": {
    "groupPxys": [
      {
        "id": 40689,
        "clientGroupId": "40689",
        "name": "OPEN_GROUPSS_TYPE_ID",
        "adminName": "beneton",
        "adminId": "beneton",
        "memberUserKeys": [
          "29c97be5-6d3f-4aaf-95c0-f282650f5c14",
          "a7b2d8ab-cc4d-47ed-9a31-0362c6a75975"
        ],
        "membersName": [
          "beneton",
          "banglow"
        ],
        "membersId": [
          "beneton",
          "banglow"
        ],
        "removedMembersId": [],
        "unreadCount": 0,
        "type": 6,
        "createdAtTime": 1487689414972,
        "userCount": 2,
        "groupUsers": [
          {
            "userId": "banglow",
            "status": 0,
            "unreadCount": 0,
            "role": 3,
            "deleted": false
          },
          {
            "userId": "beneton",
            "status": 0,
            "unreadCount": 0,
            "role": 1,
            "deleted": false
          }
        ],
        "childKeys": [],
        "childClientGroupIds": [],
        "metadata": {
          "AL_CATEGORY": "Drop",
          "Key": "VALUE"
        }
      }
    ],
    "lastFetchTime": 1487689414972
  }
}

Query Params

pageSize
int32

Number of Open channels need to be fetched

endTime
int64

pass lastFetchTime as endTime to load more channel list

 

Parameter Description:

Parameter
Required
Default
Description

pageSize

No

50

Number of Open channels need to be fetched.

endTime

No

pass lastFetchTime as endTime (fetched in API response) to load more channel list.

Note:

To load more open channels, pass "endTime" parameter in API call. Use the "lastFetchTime" value from the API response as "endTime" in next API call.

Suggest Edits

Group Metadata

 

To add metadata to a group, send the metadata object inside the group object while creating a group. The same metadata object will be received in group list API with group object. The metadata object is a map with string keys and values.

Sample Group Object JSON with Metadata:

{
 "clientGroupId":"Client Group Id",
 "groupName" : "Group Name",
 "groupMemberList" : ["UserName1", "UserName2", "UserName3"],
 "imageUrl": "Group image Url",
 "metadata" : {
   "key1" : "value1",
   "key2" : "value2"
 }
}
Suggest Edits

Group Settings

 

This will be helpful for altering the default message template for the group.

Note: If the template is sent as blank, then no alert notification is sent to devices and receive message silently.

Update metadata of the group as the following property keys:

  • CREATE_GROUP_MESSAGE
  • REMOVE_MEMBER_MESSAGE
  • ADD_MEMBER_MESSAGE
  • JOIN_MEMBER_MESSAGE
  • GROUP_NAME_CHANGE_MESSAGE
  • GROUP_ICON_CHANGE_MESSAGE
  • GROUP_LEFT_MESSAGE
  • DELETED_GROUP_MESSAGE
  • GROUP_USER_ROLE_UPDATED_MESSAGE
  • ALERT
  • HIDE

Following place holders will be replaced:

  • :adminName = admin name of the group
  • :groupName = group name
  • :userName = user name for which the action is performed
  • :role = role of user

Difference between "Add a Member" and "Join Group":

  • When the group admin adds a member, then ADD_MEMBER_MESSAGE will be displayed
  • When a user searches and adds himself to the group, then JOIN_MEMBER_MESSAGE will be displayed. This is called self-join.
  • Self-join works only in public/open groups, not for private groups

If you perform the group create, update, add member, remove member etc actions in the group, then these messages are used to display the action in the group chat:

{
  "metadata":{
    "CREATE_GROUP_MESSAGE":":adminName created group",
    "ADD_MEMBER_MESSAGE":":userName joined group",
    "GROUP_USER_ROLE_UPDATED_MESSAGE":":userName is :role now"
  }
}

Example:1

Use below format for displaying messages in chat list without showing any explicit notification:

{
  "groupName" : "GroupName",
  "groupMemberList" : ["user1","user2"],
  "metadata":{
    "CREATE_GROUP_MESSAGE":"",
    "ADD_MEMBER_MESSAGE":"",
    "GROUP_NAME_CHANGE_MESSAGE" : "",
  }
}

Note

1.If Alert metadata is configured to false no explicit notification send to iOS devices.

2.) For Android device messages in the message list will come with metadata having key show with value false so the android explicit notification can be handled.

Example:2

1.)If having any customize message for different metadata and want to add those messages in chat messages list but don't want explicit notification.

2.)Basically, messages will add to device silently:

Use below sample:

{
  "groupName" : "GroupName",
  "groupMemberList" : ["user1","user2"],
  "metadata":{
    "CREATE_GROUP_MESSAGE":"Message in different language",
    "ADD_MEMBER_MESSAGE":" :adminName Ne Group :groupName me add Kiya :)",
    "GROUP_NAME_CHANGE_MESSAGE" : "Message in different language",
    "ALERT": "false"
  }
}

Note

1.If Alert metadata is configured to false no explicit notification send to iOS devices.

2.) For Android device messages in message list will come with metadata having key show with value false so the android explicit notification can be handled.

Example:3

If you want to filter messages not to be displayed in chat message list, use below sample:

{
  "groupName" : "GroupName",
  "groupMemberList" : ["user1","user2"],
  "metadata":{
    "CREATE_GROUP_MESSAGE":"",
    "ADD_MEMBER_MESSAGE":"",
    "GROUP_NAME_CHANGE_MESSAGE" : "",
    "HIDE": "true"
  }  
}

Note

1.) In this case, Group created, add, remove and name change messages will come with metadata hide with value true in message list API call.

2.) So you can filter out these messages.

Suggest Edits

Create User's Friend/Favourite Contacts List

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/GroupName/add
["UserName1","UserName1","UserName1"]
A binary file was returned

You couldn't be authenticated

{
    "status": "success",
    "generatedAt": 1452347180639,
    "response": "success"
}

Path Params

GroupName
string
required

Name of the contact group

 

Using this API you can create your group of contacts for individual user and fetch it later.

Example usage case: You can create your favorite contact list by passing GroupName as favorite, and keep modifying list based on once user marks it as favorite.

Note:

  • If the group does not exist then it will create a group and add the list of users (passed in JSON) into the group.
  • If a group already exist in your system, then the API will add the passed user into the group.
Suggest Edits

Create Open Friend/Favourite Contacts List

Using this API you can create a group of contacts and any member present in the list can fetch it.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/group/GroupName/add/members
{
"type":"9",
"groupMemberList":["user1","user2","user3"]
}
A binary file was returned

You couldn't be authenticated

{
    "status": "success",
    "generatedAt": 1452347180639,
    "response": "success"
}

Path Params

GroupName
string
required

Name of the group

Body Params

type
int32
required

Type should be 9

groupMemberList
array of strings
required

User ids to be added in the group

 

Note:

  • If group does not exist then it will create group and add the list of users (passed in JSON) add into group.
  • If group already exist in your system, then the API will add the passed user into group.
Suggest Edits

Get Friend/Favourite List

Using this API you can get your friends contact list.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/GroupName/get
https://apps.applozic.com/rest/ws/group/MyList/get
A binary file was returned

You couldn't be authenticated

 {
    "status": "success",
    "generatedAt": currentTime,
    "response": {
        "id": groupId,
        "clientGroupId": "groupId",
        "name": "groupName",
        "adminId": "groupAdmin",
        "memberUserKeys": [
            "c42d315b-94ad-40b3-ae2c-5a0b07e6a6a6",
            "79c78ffb-44a3-45f6-b5df-05849314e774",
            "1b46739a-69c7-43bc-aeba-870f034fef4b",
            "agpzfmFwcGxvemljchMLEgZTdVVzZXIYgICAwITM6AoM"
        ],
        "membersId": [
            "groupuser2",
            "groupuser1",
            "groupuser3",
            "groupAdmin"
        ],
        "removedMembersId": [
            
        ],
        "unreadCount": 0,
        "type": 8,
        "createdAtTime": currentTime,
        "userCount": 4,
        "groupUsers": [
            {
                "userId": "groupuser3",
                "status": 0,
                "unreadCount": 0,
                "role": 3,
                "deleted": false
            },
            {
                "userId": "groupuser2",
                "status": 0,
                "unreadCount": 0,
                "role": 3,
                "deleted": false
            },
            {
                "userId": "groupuser1",
                "status": 0,
                "unreadCount": 0,
                "role": 3,
                "deleted": false
            },
            {
                "userId": "groupAdmin",
                "status": 0,
                "unreadCount": 0,
                "role": 1,
                "deleted": false
            }
        ],
        "childKeys": [
            
        ],
        "childClientGroupIds": [
            
        ],
        "metadata": {
            
        }
    }
}

Path Params

GroupName
string
required

Name of the group

Query Params

groupType
int32

groupType required only for open list

 

Parameter description:

Parameter
Required
Description

groupType

No

groupType required only for open list (type=9)

Application Bot

In case Application Bot headers are used, Of-User-Id header is required.

Suggest Edits

Remove User From Friend List

Using this API you can remove user from your friends contact list

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/GroupName/remove
https://apps.applozic.com/rest/ws/group/MyList/remove?userId=John
A binary file was returned

You couldn't be authenticated

{
    "status": "success",
    "generatedAt": 1452347180639,
    "response": "success"
}

Path Params

GroupName
string
required

Name of the group

Query Params

userId
string
required

userId of the user to be removed from the group

groupType
int32

groupType required only for open list

 

Parameter description:

Parameter
Required
Description

groupType

No

groupType required only for open list (type=9)

userId

Yes

userId of the user to be removed from the group

Suggest Edits

Delete Friend List

Using this API you can delete friends contact list

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/GroupName/delete
https://apps.applozic.com/rest/ws/group/MyList/delete
A binary file was returned

You couldn't be authenticated

{
    "status": "success",
    "generatedAt": 1452347180639,
    "response": "success"
}

Path Params

GroupName
string
required

Name of the group to be deleted

Query Params

groupType
string

groupType required only for open list

 

Parameter description:

Parameter
Required
Description

groupType

No

groupType required only for open list (type=9)

Suggest Edits

Messages

Peer-to-Peer (1:1) and Group Chat Conversations

 
Suggest Edits

Send Message To User

Use this API to send message to another user.
API supported by both application admin and application user.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/message/v2/send
{
  "to":"John",
  "message":"Hi John"
}
A binary file was returned

You couldn't be authenticated

{
  "messageKey": "5-22bf4626-9019-4a4a-8565-6c0e40ecda96-1454398305364",
  "createdAt": 1454398305000
}

Body Params

to
string
required

UserId to which you want to send message

message
string
required

Text Message

 

JSON Parameter Description:

Parameter
Required
Description

to

Yes

UserId to which you want to send message

message

Yes

Text Message

Response Parameter Description:

Parameter
Description

message key

Request is successfully processed

createdAt

time in milliseconds

Application Bot

In case of Application Bot calling the API, Of-User-Id header is required. Of-User-Id is the userId of the user on behalf of which application bot wants to send the message to another user.

Suggest Edits

Send Message To Group

Use this API to send message to a group.
API supported by both application admin and application user.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/message/v2/send
{
 "clientGroupId": "group Unique Identifier",  
  "message":"Hi John"
}
A binary file was returned

You couldn't be authenticated

{
  "messageKey": "5-22bf4626-9019-4a4a-8565-6c0e40ecda96-1454398305364",
  "createdAt": 1454398305000
}

Body Params

clientGroupId
string
required

Unique identifier of the group with respect to client

message
string
required

Text Message

 

JSON Parameter Description:

Parameter
Required
Description

clientGroupId

Yes

Unique identifier of the group with respect to client

message

Yes

Text Message

Response Parameter Description:

Parameter
Description

message key

Request is successfully processed

createdAt

time in milliseconds

Application Bot

In case of Application Bot calling the API, Of-User-Id header is required. Of-User-Id is the userId of the user on behalf of which application bot wants to send the message to the group.

Suggest Edits

Send HTML Message

 

Sample Message Object JSON with contentType:

{
  "to":"John",
  "message":"<p>This is normal text - <b>and this is bold text</b>.</p>",
  "contentType":3
}
Suggest Edits

Send Message With Attachment

 

Step 1. Get Url to Upload File

Call API:
https://applozic.appspot.com/rest/ws/aws/file/url?data=1532966195593

where data = current time in milliseconds.

API Response String:

https://applozic.appspot.com/_ah/upload/AMmfu6aM5pSiFldSC6P712_67rJUbhM2esVCASnkDaywKyBC0jrOZ8Rce9kA_N_C9eE6kS1D1agdAogaGF6erctiiPbYhwLoDuJgjHIB4BzpGg3uAQQ2UZh5ZaakxeWCinF5yBrR-gaQM5_pis4sCwY8It6-cABVrA/ALBNUaYAAAAAW183kZRZP3A480j6ri2ALQTsZoLvlhvF/

Step 2. Call Above Url With multipart :

Call API with your file object attached to files[] array:

https://applozic.appspot.com/_ah/upload/AMmfu6aM5pSiFldSC6P712_67rJUbhM2esVCASnkDaywKyBC0jrOZ8Rce9kA_N_C9eE6kS1D1agdAogaGF6erctiiPbYhwLoDuJgjHIB4BzpGg3uAQQ2UZh5ZaakxeWCinF5yBrR-gaQM5_pis4sCwY8It6-cABVrA/ALBNUaYAAAAAW183kZRZP3A480j6ri2ALQTsZoLvlhvF/

fileMeta json Response:

{
   “fileMeta”: {
       “blobKey”: “AMIfv94owfV8vmaAHY5ISFf0aM_UHflqyEHpBvfYzn9q6i2BlxyI76JmbDx9lVHjGyqnVTpvJg-_s6EXibfgRxln9p6z7YdWTa8DA-TDH3yxtvXFsLFEcQ8eHWUFpqagmbcTM3mkE-qoPXMbgLVXTl9iceqAIuvICA”,
       “contentType”: “image/gif”,
       “createdAtTime”: “1532966377442”,
       “name”: “applozic_logo.gif”,
       “size”: “15608”,
       “thumbnailUrl”: “https://lh3.googleusercontent.com/9PBCW_pExEF7g-VsheISFMFulTZdxgOjNT4iNnZyT4ns-CPqjQxjpW8-_YZFsdkDZnyBRg5aX-MO1CekmVCe=s120"
   }
}

Step 3. Send Message with attachment (FileMeta Json):

Call API:
https://apps.applozic.com/rest/ws/message/v2/send

Request Body:

{
 “type”:5,
 “to”: “user02”,
 “message”: “Check this image”,
  “fileMeta”: {
       “blobKey”: “AMIfv94owfV8vmaAHY5ISFf0aM_UHflqyEHpBvfYzn9q6i2BlxyI76JmbDx9lVHjGyqnVTpvJg-_s6EXibfgRxln9p6z7YdWTa8DA-TDH3yxtvXFsLFEcQ8eHWUFpqagmbcTM3mkE-qoPXMbgLVXTl9iceqAIuvICA”,
       “contentType”: “image/gif”,
       “createdAtTime”: “1532966377442",
       “name”: “applozic_logo.gif”,
       “size”: “15608",
       “thumbnailUrl”: “https://lh3.googleusercontent.com/9PBCW_pExEF7g-VsheISFMFulTZdxgOjNT4iNnZyT4ns-CPqjQxjpW8-_YZFsdkDZnyBRg5aX-MO1CekmVCe=s120”
   }
}

Send Message Api Response Json:

{
   “status”: “success”,
   “generatedAt”: 1532966617428,
   “response”: {
       “messageKey”: “5-9ccfc5fd-542d-4595-8eee-1e94a5d66293-1532966617397",
       “createdAt”: 1532966617409
   }
}
Suggest Edits

Broadcast Message

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/message/sendall
{
  "userNames" : ["UserName1", "UserName2", "UserName3"],
  "clientGroupIds" : ["1", "2", "3"],
  "messageObject" : {
    "message":"Hi John"
  }
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

userNames
array of strings

User Names to which you want to send a message

clientGroupIds
array of strings

List of Group unique identifiers to which you want to send a message

messageObject
object
required

Message Container Object

 
messageObject.message
string
required

Text Message

 

JSON Parameter Description:

Parameter
Required
Description

userNames

No

User Names to which you want to send a message. Limit 50

clientGroupIds

No

List of Group unique identifiers to which you want to send a message. Limit 50

messageObject

Yes

Message Container Object

message

Yes

Text Message

Note:

Either userNames are required if you are sending to users or clientGroupIds required if you are sending to groups.

Application Bot

In case of Application Bot calling the API, Of-User-Id header is required. Of-User-Id is the userId of the user on behalf of which application bot wants to send a broadcast message.

Suggest Edits

Message Metadata

 

To add metadata for a message, send the metadata object inside the message object while sending a message. The same metadata object will be received in message list API with the message object. The metadata object is a map with string keys and values.

Sample Message Object JSON with Metadata:

{
  "to":"John",
  "message":"Hi John",
  "metadata" : {
    "key1" : "value1",
    "key2" : "value2"
  }
}
Suggest Edits

Smart Messaging Using Metadata

 

Add specific metadata for a message, send the metadata object inside the message object while sending a message. Message metadata type can be HIDDEN, PUSHNOTIFICATION, ARCHIVE.

Sample Message Object JSON with Metadata:

{
  "to": "John",
  "message": "Hidden Message",
  "metadata": {
    "category": "HIDDEN"
  }
}

category value can be:

value
HIDDEN
PUSHNOTIFICATION
ARCHIVE
Suggest Edits

Send Message with Metadata

API supported by both application admin and application user.

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/message/v2/send
{
  "to":"John",
  "message":"Hi John",
  "metadata":{
    "key1" : "value1",
    "key2" : "value2"
  }
}
A binary file was returned

You couldn't be authenticated

{
  "messageKey": "5-22bf4626-9019-4a4a-8565-6c0e40ecda96-1454398305364",
  "createdAt": 1454398305000
}

Body Params

to
string
required

UserId to which you want to send message

message
string
required

Text Message

metadata
json
required

Key value pair in Json

 

JSON Parameter Description:

Parameter
Required
Description

to

Yes

UserId to which you want to send message

message

Yes

Text Message

metadata

Yes

Key value pair in Json format

Response Parameter Description:

Parameter
Description

message key

Request is successfully processed

createdAt

time in milliseconds

Application Bot

In case of Application Bot calling the API, Of-User-Id header required too. Of-User-Id is the userId of the user on behalf of which application bot wants to send message to another user.

Suggest Edits

Message List

Use this API to get the messsages

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/message/v2/list
https://apps.applozic.com/rest/ws/message/v2/list
A binary file was returned

You couldn't be authenticated

{
  "message":[
    {
      "key":"5-35c2957b-8de0-482b-bea9-7c5c2e1dd2f4-1452080064726",
      "userKey":"35c2957b-8de0-482b-bea9-7c5c2e1dd2f4",
      "to":"michael",
      "contactIds":"michael",
      "message":"how are you",
      "sent":true,
      "delivered":false,
      "read":false,
      "createdAtTime":1452080064000,
      "type":5,
      "source":1,
      "status":3,
      "pairedMessageKey":"4-35c2957b-8de0-482b-bea9-7c5c2e1dd2f4-1452080064726",
      "contentType":0
    }
  ]
}

Query Params

userId
string

User Id of the user whose respective chat messages user want to fetch

groupId
int64

Group Id of the group for which messages need to be fetched

startIndex
int32

Starting Index to fetch messages from the list

mainPageSize
int32

Number of user's chat thread to load while launching/initialize chat

pageSize
int32

It will fetch number of messages in a single chat thread

endTime
int64

Pass oldest time from the fetched messages to load more older messages

 

Description:

  1. If no user id or group id is passed to the API then this API returns the latest message of the calling user with each user or group which the user has chat with.
  2. If the user id is passed then API return the messages between the calling user and specified user.
  3. If the group id is passed the API returns the messages of the specified group.

Request Parameter Description:

Parameter Required Default Description
userId No User Id of the user whose respective chat messages user want to fetch.
groupId No Group Id of the group for which messages need to be fetched.
startIndex Yes 0 Starting Index to fetch messages from the list.
mainPageSize Yes Number of user's chat thread to load while launching/initialize chat.
pageSize Yes 50 It will fetch the number of messages in a single chat thread.
endTime No Pass the oldest time from the fetched messages to load older messages

Application Bot

  • In case of Application Bot calling the API, Of-User-Id header is required. Of-User-Id is the userId of the user on behalf of which application admin wants to get the message list.
    • To load more older messages in list pass endTime parameter with oldest message time received in messages list.

In Case of Error :

Response Description
error In case of any exception or error contact resolve@applozic.com
Suggest Edits

Message Info

Use this API to get the message details

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/message/info
https://apps.applozic.com/rest/ws/message/info?key=5-226299-1490015022917
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

key
string
required

unique identifier of message

 

Parameter Description:

Parameter Required Default Description
key Yes unique identifier of message

Example Response:

  • In case of One to One Message: Suppose user1 sends a message to user2.
{
  "status": "success",
  "generatedAt": 1490168160713,
  "response": [
    {
      "userId": "user2",
      "deliveredAtTime": 1490168151068,
      "status": 4      // delivered to user2
    }
  ]
}
  • In case of Group Message: Suppose user1 sends a message to group having users: user2, user3, user4
{
  "status": "success",
  "generatedAt": 1490168526401,
  "response": [
    {
      "userId": "user2",
      "deliveredAtTime": 1490168482844,
      "status": 4     // delivered to user2
    },
    {
      "userId": "user3",
      "deliveredAtTime": 1490168483132,
      "readAtTime": 1490168523731,
      "status": 1    // read by user3
    }
  ]
}

Note:

Message is neither delivered nor read by user4.

Suggest Edits

Delete Message

This API supported by both application user and application admin.

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/message/delete
https://apps.applozic.com/rest/ws/message/delete?key=5-226299-1490015022917
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

key
string
required

Message unique key

 

Parameter Description:

Parameter Required Default Description
key Yes Message unique key

Application Bot

In case of Application Bot calling the API, Of-User-Id header is required. Of-User-Id is the userId of the user on behalf of which application bot wants to delete the message.

Response:

Parameter Description
success Request is successfully processed
error This will come if any exception occurs on the server. In case of any exception contact resolve@applozic.com
Suggest Edits

Delete User Messages Older Than X days

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/user/messages/delete
https://apps.applozic.com/rest/ws/user/messages/delete?days=15
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639,  // time value at which response is generated from server
  "response": "success"
}

Query Params

days
int32
required

Number of days

 

Parameter Description:

Parameter Required Default Description
days Yes Delete chat history older than X days

Application Bot

In case of Application Bot calling the API, Of-User-Id header required too. Of-User-Id is the userId of the user on behalf of which application bot wants to delete the messages.

Suggest Edits

Delete All Chats

Use this API to delete all the conversations for a user

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/message/delete/all
https://apps.applozic.com/rest/ws/message/delete/all
A binary file was returned

You couldn't be authenticated

Try the API to see results
 

Response:

Parameter Description
success Request is successfully processed
error This will come if any exception occurs. In case of any exception contact resolve@applozic.com

Application Bot

In case of Application Bot calling the API, Of-User-Id header is required. Of-User-Id is the userId of the user on behalf of which application bot wants to delete all chats.

Suggest Edits

Topic Based (Context Based) Chat

 
Suggest Edits

Retrieve Conversation Id

Use this API to get the conversation ID

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/conversation/v2/id
{ 
    "topicId":"topicId",
    "topicDetail" : "{\"title\":\"Air Condition\",\"subtitle\":\"PID : Smart Air Conditioner\",\"link\":\"http://www.freepngimg.com/download/air_conditioner/6-2-ac-picture.png\",\"key1\":\"Qty\",\"value1\":\"10\",\"key2\":\"Price\",\"value2\":\"Rs.60\"}",
    "userId" : "userId",
  "status": "new"
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

topicId
string
required

Topic id of the conversation

topicDetail
string
required

Topic detail of the conversation

userId
string

Unique id of the receiver user

groupId
int32

groupId received from group creation API

status
string
required

Status flag of the conversation

 

JSON Parameter Description:

Parameter
Required
Description

topicId

Yes

Topic id of the conversation

topicDetail

Yes

Topic detail of the conversation

userId

Yes

Unique id of the receiver user

groupId

Yes

groupId received from group creation API

status

Yes

Status flag of the conversation

Behavior:

  1. Call retrieve conversation API with status flag as NEW, OPEN, DEFAULT.
  2. If no conversation is found, a new conversation will be created.

Status Options:

Value Description
NEW The previous conversation will get ended and new conversation will be created
OPEN If the conversation is closed, it will be re-opened
DEFAULT Returns the conversation as it is

Note:

In case of one-to-one chat, pass userId and in case of group chat, pass groupId in the request body.

Response:
Success Response JSON to the request in case of userId passed

{
  "status": "success",
  "generatedAt": 1473936678880,
  "response": {
    "id": "Group Id (integer)",             // internally creating virtual group
    "clientGroupId": "Group Id (integer)",
    "name": "Group Name",
    "membersId": "[ List of members user names]",
    "removedMembersId": "[]",
    "unreadCount": "(Int) message unread count for the logged in user",
    "type": "Group type",
    "conversationPxy": {
      "id": "(Int)Conversation id",  // pass as "conversationId" in request body for topic based send message
      "topicId": "Topic id of the conversation",
      "topicDetail": "Topic Detail for the conversation",
      "userId": "unique id of the receiver user", // pass as "to" in request body for topic based send message
      "created": "(true/false) if the conversation is created or not in this api",
      "closed": "(true/false) if the conversation is closed",
      "senderUserName": "userId who is initiating topic based chat",
      "status": "status of the conversation",
      "groupId": "(Int) Group id of the virtually created group"
    },
    "createdAtTime": 1473933607470,
    "userCount": 2
  }
}

Response:
Success Response JSON to the request in case of groupId passed

{
  "status": "success",
  "generatedAt": 1473936678880,
  "response": {
    "id": "Group Id (integer)",
    "clientGroupId": "140891",
    "name": "Group Name",
     "adminId": "userId of group admin ",
    "membersId": "[ List of members userIds]",
    "removedMembersId": "[]",
    "unreadCount": "(Int) message unread count for the logged in user",
    "type": "Group type",
    "conversationPxy": {
      "id": "(Int)Conversation id",     // pass as "conversationId" in request body for topic based send message
      "topicId": "Topic id of the conversation",
      "topicDetail": "Topic Detail for the conversation",
      "userId": " userId of User with whom topic based chat initiated",
      "created": "(true/false) if the conversation is created or not in this api",
      "closed": "(true/false) if the conversation is closed",
      "senderUserName": "userId who is initiating topic based chat",
      "status": "status of the conversation",
      "groupId": "(Int) Group id of the respected group"  // pass as "groupId"  in request body for topic based send message
    },
    "imageUrl": "Group image Url",
    "createdAtTime": 1473933607470,
    "userCount": "group user count"
  }
}
Suggest Edits

Send Message In Topic Based Chat

Use this API to send message in contextual chat

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/message/send
{
  "to":"unique id of the receiver user", // or "groupId":"unique group identifier",
  "message":"Message text",
  "conversationId": "Receive in Retreive Conversation Id API"
}
A binary file was returned

You couldn't be authenticated

{
  "messageKey": "5-22bf4626-9019-4a4a-8565-6c0e40ecda96-1454398305364",
  "conversationId": 670,
  "createdAt": 1454398305000
}

Body Params

to
string

UserId to which you want to send message

groupId
int32

Unique identifier of the group with respect to client

message
string
required

Text Message

conversationId
string
required

Unique id of topic based conversation

 

JSON Parameter Description:

JSON Parameter Required Default Description
to Yes UserId to which you want to send message
groupId Yes Unique identifier of the group with respect to client
message Yes Text Message
conversationId Yes unique id of topic based conversation

Response Parameter Description:

Response Parameter Description
message key message unique id
createdAt time in milliseconds
conversationId unique id of topic based conversation

Note:

In case of one-to-one chat, pass to and in case of group chat, pass groupId in the request body.

Suggest Edits

Close Topic Based Conversation

Use this API to close topic based conversation

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/conversation/closeall
https://apps.applozic.com/rest/ws/conversation/closeall?topicId=123456&withUserId=Daenerys
A binary file was returned

You couldn't be authenticated

{
"status": "success",
  "generatedAt": 1452347180639, // time value at which response is generated from server
  "response": "success"
}

Query Params

topicId
string
required

unique topic id of the conversation

withUserId
string
required

unique user identifier

 

Parameter Description:

Parameter Required Default Description
topicId Yes unique topic id of the conversation
withUserId Yes unique user identifier

Note:

Conversation is closed based on the unique topic identifier.

Suggest Edits

Application Bot APIs

Admin Level Chat APIs

 

Application Bot APIs

Application Bot API requires Application Bot headers and will not work with Application User headers.

Suggest Edits

Create User

Use this API to create an user

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/user/v2/create
{
  "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
}
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1470903020662,
  "response": "success"
}

Body Params

userId
string
required

unique id of user to be created

password
string

password of user

displayName
string

display name of user

imageLink
string

profile image link of user

email
string

email of user

 

JSON Parameter Description:

Parameter Required Default Description
userId Yes pass unique id of user
password No password of user
displayName No display name of user
imageLink No image link of user
email No email of user
createdAtTime No time in miliseconds
authenticationTypeId No 0 used for user authentication
roleName No USER want to create user of specific type then pass: BOT

Values of Role:

Parameter Value
roleName BOT
roleName USER

Values of Authentication Type Id:

Parameter Value Description
authenticationTypeId 0 Verification from client side
authenticationTypeId 1 Verification from applozic using password

Note:

  • User password is required in case of BOT user creation.
  • By default role is USER if roleName parameter is not passed.
  • You can also create the user with additional information. You need to pass the information as the user metadata in the API. Please check this doc for more information.
Suggest Edits

Set User Password

Application admin can set any user password

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/user/set/password
http://apps.applozic.com/rest/ws/user/set/password?userId=jack&password=1234567
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1452347180639,  // time value at which response is generated from server
  "response": "success"
}

Query Params

userId
string
required

unique identifier for user

password
string
required

password for the user

 

Parameter Description:

Parameter Required Default Description
userId yes unique identifier for user
password yes password for the user
Suggest Edits

Dispatch Message

 

Header Auth

 Authentication is required for this endpoint.
posthttps://apps.applozic.com/rest/ws/message/dispatch
{
  "message":"HI STEVE",
  "senderName":"john",
  "to": "steve"   
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

message
string
required

message content to be passed

senderName
string
required

unique Id of message sender user

to
string

unique Id of message receiver user

oldTimestamp
string

create message timestamp

groupId
int32

groupId received while group creation

 

Description:

  1. Message Dispatch API behaves same as Message Send API and is only available to Application Bot users.
  2. Message Dispatch API supports one-to-one, group and contextual based messaging.
  3. Application Bot user can send Message on behalf of one user to another user on the back date also. (Used for data migration from your Server to Applozic Sever).

JSON required for One to One based messaging:

{
  "message":"HI STEVE",
  "senderName":"john",
  "to": "steve"   
}

Json Parameter Description:

Json Parameter Required Default Description
senderName Yes unique Id of message sender user
to Yes unique Id of message receiver user
message Yes message content to be passed
oldTimestamp No create message timestamp

Response:

{
  "messageKey": "5-a97d66cd-67f9-42ba-aa61-a357455088ac-1456148218362",
  "createdAt": 1456148218000
}

Response Parameter Description:

Response Parameters Description
messageKey message key
createdAt Time in miliseconds when response is return from server

JSON required for group based messaging:

{
  "message":"message content",
  "groupId":114209 //groupId received while group creation.
}

Response:

{
  "messageKey": "5-agpzfmFwcGxvemljchMLEgZTdVVzZXIYgICAgLrcvwsM-1464093115599",
  "createdAt": 1456148218000
}

JSON required for contextual based messaging:

{
  "message":"Hello, I am interested in the product, can we chat?",
  "senderName":"john",
  "to": "steve",
  "conversationPxy": {
    "topicId":"prodct topic Id",
    "topicDetail": "topic detail string"    
  }   
}

Response:

{
  "messageKey":"5-a97d66cd-67f9-42ba-aa61-a357455088ac-1458039322283",
  "conversationId":456,
  "createdAt":1458039322000
}
Response Parameters Description
messageKey message key
createdAt Time in miliseconds when response is return from server
conversationId open conversation to chat on topic
Suggest Edits

Message History Export

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/analytics/message
https://apps.applozic.com/rest/ws/analytics/message?applicationId=applozic-sample-app&pageSize=50
A binary file was returned

You couldn't be authenticated

{
  "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
    }
  ]
}

Query Params

applicationId
string
required

Your Applozic Application key configured in dashboard

pageSize
int32

Number of messages per page you want to fetch

from
string

UserId of the sender for the fetched message

to
string

UserId of the receiver for the fetched message

startTime
int64

Start Time from when you want to fetch message list

endTime
int64

End Time upto when you want to fetch message list

 

Note:

API supported only by application bot user. No additional header Of-User-Id required.

Accept:

  1. application/json (Default) : For return type as json
  2. application/octet-stream : For returning as Excel

Parameter Description:

Parameter Required Description
applicationId Yes Your Applozic Application key configured in dashboard
startIndex No Starting Index to fetch messages from list
pageSize No Number of messages per page you want to fetch
from No UserId of the sender for the fetched message
to No UserId of the receiver for the fetched message
startTime No Start Time from when you want to fetch message list. It is number of milliseconds since January 1, 1970, 00:00:00 GMT
endTime No End Time upto when you want to fetch message list. It is number of milliseconds since January 1, 1970, 00:00:00 GMT
messageType No Message type of the message to check
period No if startTime is not passed. amount of period to check the message
timeUnit No Time unit of the period

Values for messageType:

Value Description
1 MessageDelivered
2 MessageUnDelivered
3 MessageRead
4 MessageUnRead

Values for timeUnit:

Value Description
1 MilliSeconds
2 Second
3 Minute
4 Hour
5 Day
6 Week
7 Month
8 Year
Suggest Edits

Load Application's Group List

 

Header Auth

 Authentication is required for this endpoint.
gethttps://apps.applozic.com/rest/ws/group/filter
https://apps.applozic.com/rest/ws/group/filter?pageSize=2
A binary file was returned

You couldn't be authenticated

{
  "status": "success",
  "generatedAt": 1487156976360,
  "response": {
    "users": [],
    "groups": [
      {
        "id": 2101199,
        "clientGroupId": "2101199",
        "name": "phonegapprivate",
        "adminName": "vipinpro",
        "adminId": "vipinpro",
        "membersName": [
          "sonupro",
          "phonegapdemo",
          "vipinpro"
        ],
        "membersId": [
          "sonupro",
          "phonegapdemo",
          "vipinpro"
        ],
        "removedMembersId": [],
        "unreadCount": 0,
        "type": 1,
        "createdAtTime": 1487155124542,
        "userCount": 3,
        "groupUsers": [
          {
            "userId": "phonegapdemo",
            "role": 3
          },
          {
            "userId": "sonupro",
            "role": 3
          },
          {
            "userId": "vipinpro",
            "role": 1
          }
        ],
        "childKeys": [],
        "childClientGroupIds": []
      },
      {
        "id": 2092165,
        "clientGroupId": "2092165",
        "name": "two",
        "adminName": "sunil",
        "adminId": "sunil",
        "membersName": [
          "sunil",
          "xyz"
        ],
        "membersId": [
          "sunil",
          "xyz"
        ],
        "removedMembersId": [],
        "unreadCount": 0,
        "type": 7,
        "createdAtTime": 1487088852348,
        "userCount": 2,
        "groupUsers": [
          {
            "userId": "xyz",
            "role": 3
          },
          {
            "userId": "sunil",
            "role": 1
          }
        ],
        "childKeys": [],
        "childClientGroupIds": []
      }
    ],
    "devices": [],
    "lastFetchTime": 1487088852348,
    "lastFetchIndex": 1,
    "totalUnreadCount": 0
  }
}

Query Params

pageSize
int32

list of groups to load

endTime
int64

pass to load more group

applicationId
string

application Id for which you want to get the group list

 

Parameters:

Parameter Required Default Description
pageSize No 500 list of groups to load
endTime No pass to load more group
applicationId No application Id for which you want to get the group list

Note:

To load further group list use lastFetchTime value from the response and pass it in endTime parameter in next call.