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.
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.
Stream Id is a CommBox generated number for the channel.
Object Id is a CommBox generated number for the conversation.
Return objects with their childs (optional, default false)
Return objects with their activity log (optional, default false)
OK
A CommBox generated number for the conversation
A CommBox generated number for the channel – This will be the unencrypted format of the channel Id.
A CommBox generated number for the subchannel. A Sub-stream is not required when calling an API.
A CommBox generated number for the user
When not provided, system will use the email address.
The unique Id for communication (email, phone number) of user
A CommBox generated number – see Enums
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.
Content of the message
A CommBox generated number for conversation status – see Enums
Id of agent / admin
Id of the last agent / admin for this object
A CommBox generated number for the user
Unique ID from Customer Info pane
As appears in the Customer Info section. System adds country code.
User email from Customer Info pane
User gender from Customer Info pane
Added field to the Customer Info pane
When True: User is an agent / admin. When False: User is a customer
A CommBox generated number for child
A CommBox generated number for conversation
When True: User is an agent / admin. When False: User is a customer
If the agent/admin has an associated thumbnail picture, the URL to the file will be listed here.
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
Not Found - The requested resource is not found
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
Internal Server Error - The server could not return the representation due to an internal server error
{
"status": 500,
"description": "Operation failed",
"response_time": "2025-04-15T07:24:52.956Z"
}Not Implemented - The requested operation is not supported