Users
Updated at January 7th, 2025
Users are people recorded in Cirrus and they include both the business side and the customers.
Managers are APIs that deal with the business personas such as Admins, Agents, Team leaders, etc., and they include Profiles, Presence, Assignments, Notifications, and Teams sub-categories.
GET: Get User
In order to get data, must use either UserId or both streamProviderId and streamProviderType of the user identity
https://api.commbox.io/users/{USER_ID}
path Parameters
|
USER_ID required
|
integer <int64>
User ID. This is a Cirrus generated number |
query Parameters
| streamProviderId | string
Only return objects created by this user. Represents the user identity. Must supply streamProviderType as well (optional) |
| streamProviderType | string
Only return objects created by this user. Represents the user identity. Must supply streamProviderId as well (optional) |
Response Schema: application/json
| status | string
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description | string
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| response_time | string
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST: Update User
This API updates the user information in the Customer Info pane.
Add to the body params the new information with their corresponding unique name field as they appear in the Custom Fields module.
Fields added to the Custom Fields module are included in the Content field of the API (See example).
Make sure to enter the field’s name exactly as it appears in the unique name column.
Once successful, this API returns the User ID.
path Parameters
|
USER_ID required
|
integer <int64>
User ID. This is a Cirrus generated number |
Request Body schema: application/json
Optional description for new mail object in Markdown
| SubStreamId | integer <int64>
The subchannel ID of the conversation |
| Type | integer <int64>
The type of object used (text, link, photo, etc.)- See Enum for code |
| StatusId | string
The conversation’s current state (Open, Resolved, etc.) – See Enum for code |
| StreamProviderType | integer <int64>
Type of the object original stream provider |
| StreamProviderId | integer <int64>
A Cirrus generated number for the original stream provider |
| UserStreamProviderId | string
unique identifier of user, usually an email or a phone number, as it appears at the original provider |
| UserStreamProviderType | integer <int64>
Type of identifier used in of the userStreamProviderId parameter |
| UserIdentity | integer <int64>
A Cirrus generated number for the user. |
| ManagerId | integer <int64>
The manager (agent) who create the object (optional) |
| Content | string <JSON string>
String containing extended properties of the object |
| Message | string
(required) The text of the primary message. This is a mandatory/required field |
| sendToClient | boolean
If true - send message without saving it (relevant for SMS streams only) |
| createChildObject | boolean
If true - |
| User | object
The user that created the object |
Response Schema: application/json
| status | string
|
||
| description | string
|
||
| response_time | string
|
||
object
|
|||
| |||
GET: Get User Objects
In order to get data, must use either userIdentityId or both streamProviderId and streamProviderType of the user identity
https://api.commbox.io/users/identities/{USER_IDENTITY_ID}/objects
path Parameters
|
USER_IDENTITY_ID required
|
integer <int64>
Only return objects created by this user |
query Parameters
| streamProviderId | string
Only return objects created by this user. Represents the user identity. Must supply streamProviderType as well (optional) |
| streamProviderType | string
Only return objects created by this user. Represents the user identity. Must supply streamProviderId as well (optional) |
| stream | integer <int64>
The stream Id from which to return objects (optional, default 0) |
| subStream | integer <int64>
The subchannel Id (Optional, default 0) |
| pageNumber | integer
Used for paging results (optional) |
| pageSize | integer
Used for paging results (optional, default 100) |
| status | string
ObjectStatusType - see Enums for code. |
| order | string
The order to return the objects (optional, default 'closedtime') |
| objectId | integer <int64>
The object id to filter (optional, default 0) |
| moduleId | integer <int64>
The module id to filter (optional, default 0) |
| includeChilds | boolean
Example: includeChilds=true
Flag to return the object childs (optional, default true) |
| includeActivityLog | boolean
Example: includeActivityLog=false
Flag to return the object activity log (optional, default false) |
Response Schema: application/json
| status | string
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| description | string
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| response_time | string
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
One of
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
