Get Object's Transcript

  • Published on Aug 6, 2025
  • 2 minute(s) read
  • EM
 Prev Next
Get
/streams/{STREAM_ID}/objects/{OBJECT_ID}/transcript

This API returns the transcript of a specific conversation (object).
Data includes information about the conversation (objectId), customer, the channel, sub-channel.
Note: The transcript field includes the conversation transcript with an external hyperlink to the Object (conversation) .
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/transcript

Example:
https://api.commbox.io/streams/532/objects/293854/transcript

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.

Responses
200

Operation successful

Expand All
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string
Example2024-03-19T10:45:41.6038344Z
data
Array
OneOf
object
object
objectId
integer

A CommBox generated number for the conversation

Example378015
streamid
integer

A CommBox generated number for the channel – This will be the unencrypted format of the channel Id.

Example17558
substreamid
integer

A CommBox generated number for the subchannel. A Sub-stream is not required when calling an API.

Example0
trasncript
string


trasncript of the conversation.

Example\n[2/29/2024 12:20:25 PM] \nBot : \nTEST!@$$%^&*()}{\":<>?🙁🙁🙁🙁 6_312aac6109.jpg \n[2/29/2024 12:20:30 PM] \nJohn Doe: \nhi \n[2/29/2024 12:21:05 PM] \nJohn Doe: \nAttachments: \nmashu_mashu_251a989981_25a7e7f517.png \n[2/29/2024 12:21:22 PM] \nRan Itzhaki: \nok \n[2/29/2024 12:21:29 PM] \nBot : \nResolved \nWispp Object Id: 378015 \nCommbox Ticket Link: https://qawispp.wispp.com/widget/object/378015
user
object
id
integer
Example537385
uniqueId
string
Example537385
phone1
string

As appears in the Customer Info section. System adds country code.

Example972505445875
phone2
string
Example
email
string
Exampletest115@gmail.com
firstName
string
ExampleJohn
lastName
string
ExampleDoe
gender
string
ExampleMale
numberIdentities
integer
Example3
locale
string
Exampleen_US
birthday
string
Example01/01/1980
remarks
string
Example
400

Bad Request - The request could not be understood by the server. Incoming parameters might not be valid

object
status
integer
Example400
description
string
ExampleBad Request
response_time
string (date-time)
401

Unauthorized - The supplied credentials, if any, are not sufficient to access the resource

object
status
integer
Example401
description
string
ExampleUnauthorized access
response_time
string (date-time)
404

Not Found - The requested resource is not found

object
status
integer
Example404
description
string
ExampleNot found
response_time
string (date-time)
429

Too Many Requests - Too many requests have been made in a short period of time (Throttling)

object
status
integer
Example429
description
string
ExampleToo Many Requests
response_time
string (date-time)
500

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"
}
object
status
integer
Example500
description
string
ExampleOperation failed
response_time
string (date-time)
501

Not Implemented - The requested operation is not supported