This section outlines the data structures recognized and transmitted by the API.
Objects represent conversations between bots or agents and customers. Each segment within a conversation is referred to as a Child. Every conversation is associated with a designated Stream — a communication channel such as chat, email, SMS, etc. — where the interaction takes place.
In the Objects category, the focus is on a specific conversation, with the stream serving as part of its identifying attributes. Conversely, in the Streams category, the communication channel itself is the primary focus, while objects and users act as filtering criteria for the request.
Object
Value
Description
Notes
Id
int64
Object ID. A Cirrus generated number for the conversation.
StreamId
int64
Stream ID to which the object is connected
SubStreamId
int64
Sub Stream ID to which the object is connected
Type
short
The type of the object
StatusId
string
Current status ID
CreatedTime
datetime
When the object was created
FirstResponseTime
datetime
When the first response to the object was registered
UpdatedTime
datetime
When the object was last updated
PriorityTime
datetime
When the object is currently prioritized
NumChilds
int
Number of child objects relating to this parent object
IsManager
bool
Indicates whether this object was created by an agent
NumTags
int
Number of tags assigned to this object
Message
string
The text containing the object’s primary message
Content
JSON string
String containing extended properties of the object
User
object
The user that created the object
Object Child
Property
Value
Description
Notes
Id
int64
Child ID. A Cirrus generated number for the message
Type
short
The type of the child
Object Types
IsManager
bool
Indicates whether this child was created by an agent
CreatedTime
datetime
When the child was created
In UTC time
Message
string
The text containing the child’s primary message
Content
JSON string
String containing extended properties of the child
User
object
The user that created the child
User
Object Activity Log
Property
Value
Description
Notes
Text
string
Text content in the activity log
Source
string
The source of the activity log (optional)
ManagerId
Int64
The manager who initialize the activity log (optional)
Tag
Property
Value
Description
Notes
Id
int64
Tag ID. This is a Cirrus generated number
User
rty
Value
Description
Notes
Id
int64
User ID. A Cirrus generated number for the agent/customer etc.
UniqueId
string(50)
User’s unique identifier. This can be an email, social security number or any other type of unique string determined by the brand administrators
Phone1
Numeric string(20)
User’s phone number
Always contains country code and without leading + or 00
Phone2
Numeric string(20)
User’s additional phone number
Always contains country code and without leading + or 00
Email
string (255)
User’s email address
FirstName
string (100)
User’s first name
LastName
string (100)
User’s last name
Gender
string (1)
User’s gender
‘M’ for male, ‘F’ for female
Locale
object
User’s locale
Birthday
date
User’s birthday
Date only
NumIdentities
int
Number of active identities that are connected to this user
IsManager
bool
Indicates whether this user is a manager
Remarks
string
Free text containing general remarks about the user
Identity
object
Identity object that is connected to the user
User Identity
User Identity
y
Value
Description
Notes
Id
int64
Identity ID. This is a Cirrus generated number and used throughout all the updates
StreamProviderId
string(255)
Identity’s unique identifier as it appears at the original provider
StreamProviderType
int64
Type of the original provider
StreamProviderType
StreamProviderEmail
string(255)
Identity’s email as it appears at the original provider
UserName
string (100)
Identity’s user name as it appears at the original provider
FirstName
string (100)
Identity’s first name as it appears at the original provider
LastName
string (100)
Identity’s last name as it appears at the original provider
ThumbnailUrl
string (255)
Link to the identity’s profile image
NumObjects
int
Number of objects connected to this identity
Manager
operty
Value
Description
Notes
Id
int64
Manager ID. This is a Cirrus generated number and used throughout all the updates
AsyncAssignedNoResponse
int
Current number of assigned asynchronous objects awaiting response
AsyncAssignedInProccess
int
Current number of assigned asynchronous objects that are being addressed by the manager
SyncAssignedNoResponse
int
Current number of assigned synchronous objects awaiting response (Chat/messenger conversations)
SyncAssignedInProccess
int
Current number of assigned synchronous objects that are being addressed by the manager (Chat/messenger conversations)
FaceToFaceStatus
bool
Returns true if the manager is busy with a face to face object (Voice/Video call)
TotalAsyncAssigned
int
Total number of currently assigned objects
TotalSyncAssigned
int
Total number of currently assigned synchronous objects (Chat/messenger conversations)
Object custom indicator
Property
Value
Description
Notes
IndicatorId
string
Indicator id (unique name) – to allow updating/ deleting existing indicator
DisplayClass
string
Indicator class. Mandatory only if Icon has not provided
You must provide DisplayClass or an Icon, or both
Icon
string
An icon for the indicator. Supports URL. Mandatory only if Icon has not provided (not relevant for DELETE operation)
Title
string
A title for the indicator (not relevant for DELETE operation)
