Viewing chats
- Print
- PDF
Viewing chats
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It is an API to view chats. For the use flow of B2B PRISM Live Studio, see Chat process.
Note
- It transfers, views, and deletes chats on Live.
- Viewing chats views the live until it is finished in approximately 5-second intervals.
- You cannot use the chat function if the chat transfer/view/delete API is not provided.
- Only the API for transferring chats can be provided. However, in this case, you cannot see the chats.
Requests
The request format is as follows:
POST /prism/v1/service/live/{liveId}/chat
Request headers
The description of the header is as follows:
Name | Type | Description | Required |
---|---|---|---|
x-prism-access-token | String | Access Token issued through OAuth2.0 authorization | Y |
Request path parameters
The description of the parameters is as follows:
Name | Type | Description | Required |
---|---|---|---|
liveId | String | Live ID | Y |
Request body
The description of the body is as follows:
Name | Type | Description | Required |
---|---|---|---|
maxResults | Number | Y | |
pageToken | String | Y |
Responses
This is a description of the response format.
Note
For the basic response format, see the Basic format for API responses.
Name | Type | Description | Required |
---|---|---|---|
liveId | String | Live ID | Y |
nextPageToken | String | Y | |
messages | Object | Y |
message dto
The description of the message dto is as follows:
Name | Type | Description | Required |
---|---|---|---|
messageId | String | N | |
messageAt | Date | N | |
authorId | String | Y | |
authorName | String | Y | |
authorProfileThumbnail | String | N | |
isLiveOwner | Boolean | N | |
isLiveManager | Boolean | N |
How to provide page token
To provide a page token, follow these steps:
Examples
Introduces examples of syntax.
Request examples
An example of the syntax is as follows:
curl -X POST /prism/v1/service/live/{liveId}/chat
-H "x-prism-access-token: {access-token}"
Response examples
An example of the syntax is as follows:
{
"success": true,
"errorCode": 0,
"errorName": null,
"message": null,
"data": {
"liveId": 6,
"nextPageToken": 8239,
"messages": [
{
"messageId": 12,
"message": "Create chat test 2023-09-05 11:10:27",
"messageAt": "2023-09-05T11:10:27+09:00",
"authorId": "admin",
"authorName": "admin",
"authorProfileThumbnail": null,
"isLiveOwner": true,
"isLiveManager": false
},
{
"messageId": 13,
"message": "Create chat test 2023-09-05 11:25:11",
"messageAt": "2023-09-05T11:25:11+09:00",
"authorId": "admin",
"authorName": "admin",
"authorProfileThumbnail": null,
"isLiveOwner": true,
"isLiveManager": false
}
]
}
}
Was this article helpful?