--- title: "B2B PRISM Live Studio overview" slug: "b2bpls-overview" updated: 2026-10-08T04:14:16Z published: 2026-10-08T04:14:16Z canonical: "api.ncloud-docs.com/b2bpls-overview" --- > ## Documentation Index > Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt > Use this file to discover all available pages before exploring further. # B2B PRISM Live Studio overview Available in Classic and VPC This guide describes the APIs required to integrate customer services with B2B PRISM Live Studio for live streaming. ## Service API definition Service APIs are APIs that must be provided by the service in order to integrate with B2B PRISM Live Studio and stream live content. Service APIs are categorized as required APIs and optional APIs. The following describes each API. - Required APIs - These are APIs that must be implemented to use the B2B PRISM Live Studio features. - If these are not supported, the service cannot be activated. - Optional APIs - These are APIs that must be implemented to use additional features of B2B PRISM Live Studio. - These can be provided by type, and their availability can be configured during service setup. - Each API has dependencies on other APIs, and any dependent APIs must be provided together. ## Service API restrictions This section describes the restrictions to be aware of when using the B2B PRISM Live Studio APIs. - REST API - Basic integration uses the REST API. - A response time of less than 1 second is recommended. Normal operation is not guaranteed if the response time exceeds 3 seconds. - Authentication and security - All communication must use HTTPS with SSL. (TLS v1.2 or later recommended) - Use the access token obtained via OAuth 2.0. ## Service API list This section introduces the list of service APIs. ### Required APIs The list of required APIs is as follows: | Type | Detailed classification | Description | Specification | | --- | --- | --- | --- | | AUTH | Login and authentication | Obtain and renew OAuth2.0 access tokens.Get user information. | [OAuth 2.0 authentication API specification](/docs/en/b2bpls-oauth2)[Get user information API specification](/docs/en/b2bpls-user) | | CHANNEL | Get channel | Get channel list.Get channel information. | [Get channel list API specification](/docs/en/b2bpls-channellist)[Get channel information API specification](/docs/en/b2bpls-channelInfo) | | | Get live. | Get channel live list. | [Get channel list list API specification](/docs/en/b2bpls-lives) | | LIVE | Get live information. | Get live information and status. | [Get live status and statistics API specification](/docs/en/b2bpls-liveInfo) | | | Create live. | Create new live. | [Create live API specification](/docs/en/b2bpls-newlive) | | | Start and end live. | Start live streaming.End live streaming. | [Start live API specification](/docs/en/b2bpls-startlive)[End live API specification](/docs/en/b2bpls-endlive) | ### Optional APIs The list of optional APIs is as follows: | Type | Detailed classification | Description | Dependency | Specification | | --- | --- | --- | --- | --- | | LIVE_CHAT_LIST | Get chat. | Query once every 3-5 seconds during a streaming.Use the "Continuous key" to retrieve only chat history from a specific point in time onward.Supports maximum query feature. | | [Get chat API specification](/docs/en/b2bpls-chats) | | LIVE_CHAT_SEND | Send chat. | Send chat. | | [Send chat API specification](/docs/en/b2bpls-sendchat) | | LIVE_CHAT_DELETE | Delete chat. | Deletes a specific chat.Available only on services that offer chat deletion as a feature.Requires a unique ID for the chat. | LIVE_CHAT_LIST | [Delete chat API specification](/docs/en/b2bpls-deletechat) | | USER_BAN | Block and unblock chat users. | Requires a unique ID for the user who created the chat.Must be able to check current block status. | LIVE_CHAT_LIST | [Block chat user API specification](/docs/en/b2bpls-banuser)[Remove chat user block API specification](/docs/en/b2bpls-unbanuser) | | USER_MOD | Grant and remove chat admin permissions. | Requires a unique ID for the user who created the chat.Must be able to check current admin status. | LIVE_CHAT_LIST | [Grant chat admin permissions API specification](/docs/en/b2bpls-moduser)[Remove chat admin permissions API specification](/docs/en/b2bpls-unmoduser) | Note To view the specific process for using the B2B PRISM Live Studio API, see the [B2B PRISM Live Studio integration guide](https://guide.ncloud-docs.com/docs/en/b2bpls-setup). ## Basic API format This section describes the basic API format. ### Request headers The request headers are as follows: | Name | Type | Description | | --- | --- | --- | | x-prism-client-id | String | Client ID provided by the customer's service to B2B PRISM Live Studio for OAuth 2.0 authorization, which cannot be changed | | x-prism-client-secret | String | A client secret provided by the customer’s service for OAuth 2.0 authentication with B2B PRISM Live Studio. It can be changed through consultation if necessary due to security issues or other reasons. | | x-prism-access-token | String | Issued and stored during OAuth 2.0 login, and changes with each login. If the access token expires, an ACCESS_TOKEN_EXPIRED (1011) error occurs. | Note The content-type header in the request is as follows: `Content-type: application/json` ### Basic response format The basic response format is as follows: | Name | Type | Description | Required | | --- | --- | --- | --- | | success | Boolean | Indicates whether the request succeeded. | Y | | errorCode | Number | 0 if successful; for failures, see [API error code](/docs/en/b2bpls-overview#APIerrorcode%EC%A0%95%EB%A6%AC). | Y | | errorName | String | Blank if successful; for failures, see [API error code](/docs/en/b2bpls-overview#APIerrorcode%EC%A0%95%EB%A6%AC). | Y | | message | String | Providing a detailed error message enables faster error monitoring. | N | | data | Object | If only the success status is returned, data is optional; see the API specification for each data format. | N | ### Common API error codes The following describes the common API error codes. | Code | Code name | HTTP status code | HTTP status code message | Description | | --- | --- | --- | --- | --- | | 1000 | INVALID_PARAMETER | 400 | Bad Request | The requested path parameter or request body contains an invalid value. | | 1001 | UNAUTHORIZED_ACCOUNT_ID | 401 | Unauthorized | The request was made with an invalid account ID or account token. | | 1011 | ACCESS_TOKEN_EXPIRED | 400 | Bad Request | The access token has expired. | | 1012 | ACCESS_TOKEN_INVALID | 400 | Bad Request | The access token is invalid. | | 1102 | CHANNEL_DISABLED | 400 | Bad Request | The channel is disabled. | | 1104 | RESOURCE_NOT_FOUND | 404 | Not Found | When querying liveId, channelId, userId, etc., the object being queried does not exist. | | 1107 | ACCESS_TOKEN_SCOPE | 400 | Bad Request | The access token lacks sufficient permissions (scope). | | 2000 | UNEXPECTED_ERROR | 500 | Internal Server Error | An unexpected server error has occurred. |