Use this API to get contacts from application
Parameter Description:
Parameter | Required | Default | Description |
|---|---|---|---|
pageSize | No | 100 | 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 of the user | |
statusMessage | User's text status update |
connected | true - the user is online |
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 |