Get Object
- 09 Jun 2025
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get Object
- Updated on 09 Jun 2025
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/streams/{STREAM_ID}/objects/{OBJECT_ID}
This API returns the details of a specific conversation (object).
Data includes information about the customer, the agent, and a separate account of the messages (Child) of the conversation (Object).
Note that the last communication will appear at the top of the report.
Required path params are the Stream (channel) Id and Object (conversation) Id - Stream Id could be encrypted or not. (GET) /streams/STREAM_ID/objects/OBJECT_ID
Example:
https://api.commbox.io/streams/532/objects/293854
Note: When Children are not included in the request, the API only returns the last message. When requesting logs (optional), the return will include all system actions (for example, CRM activity) for the conversation.
Security
HTTP
Type bearer
API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call. For additional support you can contact us.
Path parameters
STREAM_ID
Required
Stream Id is a CommBox generated number for the channel.
OBJECT_ID
Required
Object Id is a CommBox generated number for the conversation.
Query parameters
includeChilds
boolean
Return objects with their childs (optional, default false)
includeActivityLog
boolean
Return objects with their activity log (optional, default false)
Responses
200
OK
object
status
string
Example200
description
string
ExampleSystem is operational
response_time
string
Example2024-08-06T07:51:52.2581942Z
data
Array
OneOf
object
object
objectId
integer
A CommBox generated number for the conversation
Example293854
streamid
integer
A CommBox generated number for the channel – This will be the unencrypted format of the channel Id.
Example53211
substreamid
integer
A CommBox generated number for the subchannel. A Sub-stream is not required when calling an API.
Example2432
streamProviderId
string
Example972505555555
streamProviderType
integer
Example5
user_identity
integer
Example528986
firstName
string
When not provided, system will use the email address.
ExampleEddie
lastName
string
ExampleDoe
userStreamProviderId
string
The unique Id for communication (email, phone number)
Example972505555555_by
userStreamProviderType
integer
A CommBox generated number – see Enums
Example5
content
string
Summary of the technical aspects of communication. May include the language used, direction (Rt. for Arabic and Hebrew), URL of origin, system details (assignments to agent, acceptance of email, etc.), subject matter (emails), and an initiation time.
Example{\"guidRT\":\"82c952166e0b4989b932c41d1\",\"languages\":[{\"Item1\":\"he\",\"Item2\":1329062}],\"originUrl\":\"https://apps.commbox.com/Demo\",\"isConnected\"true,\"first_assigned_time\":\"2023-09-05T08:44:20\",\"sequence_start_time\":\"2023-09-0508:55:06.000000\",\"dropOutAggregationState\":1}
message
string
ExampleI need some help
createdTime
string
Example2024-08-06T07:51:52.2581942Z
updatedTime
string
Example2024-08-06T07:51:52.2581942Z
closeTime
string
Examplenull
statusId
integer
Example1
assignedManagerId
integer
Id of agent / admin
Example0
type
integer
Example4
isManager
boolean
If True: User is an agent / admin If False: User is a customer
Examplefalse
user
object
id
integer
Example520760
uniqueId
string
Example12345
phone1
string
As appears in the Customer Info section. System adds country code.
Example972531234567
phone2
string
Example972501234332
email
string
Exampleeddiedoe053@gmail.com
firstName
string
ExampleEddie
lastName
string
ExampleDoe
gender
string
ExampleMale
numberIdentities
integer
Example3
locale
string
Exampleen_US
birthday
string
Example01/01/1980
remarks
string
Exampletest remark..
content
string
Example{}
childs
Array
OneOf
object
object
id
integer
Example123456
object_id
integer
Example1234
content
string
Example{}
message
string
Examplesome message...
createdTime
string
Example2024-08-06T07:51:52.2581942Z
streamProviderType
integer
Example5
user
object
id
integer
Example520760
managerId
integer
Example0
isManager
boolean
Examplefalse
identity
object
id
integer
Example531826
streamProviderId
string
Example972505555555
streamProviderType
integer
Example5
firstName
string
Example
lastName
string
Example
thumbnailUrl
string
Example
object
object
id
integer
Example978944
object_id
integer
Example1234
content
string
Example{}
message
string
Examplesome other message...
createdTime
string
Example2024-08-06T07:55:52.2581942Z
streamProviderType
integer
Example5
user
object
id
integer
Example520803
managerId
integer
Example520803
isManager
boolean
Exampletrue
identity
object
id
integer
Example531811
streamProviderId
string
Examplemichae12@gmail.com
streamProviderType
integer
Example0
firstName
string
Examplemichael
lastName
string
Examplenull
thumbnailUrl
string
Example
400
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
401
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
404
Not found - The requested resource is not found
429
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
500
Server Error - The server could not return the representation due to an internal server error
501
Not Implemented - The requested operation is not supported
Was this article helpful?
