B2B PRISM Live Studio overview

Prev Next

Available in Classic and VPC

This is a description of the APIs required to transmit live streaming by integrating customer services in the B2B PRISM Live Studio.

Definition of service API

The service API is essential to transmit live by integrating customer services in the B2B PRISM Live Studio. The service API is divided into two APIs: essential build API and selective build API. The description for each API is as follows:

  • Essential build API
    • An API that must be built to use B2B PRISM Live Studio functions.
    • If it is not supported, the service cannot be enabled.
  • Selective build API
    • An API that should be built to use additional B2B PRISM Live Studio functions.
    • It can be provided for each type, and you can set whether to provide it when setting up the service.
    • Each API has different APIs with dependence, and the APIs with dependence should be provided together.

Service API service limits

This is a description of the service limits you should pay attention when using B2B PRISM Live Studio API.

  • REST API
    • The default integration uses REST API.
    • We recommend a response time within 1s; normal operation cannot be guaranteed when it passes 3s.
  • Authentication and security
    • Every communication must use HTTPS using SSL. (TLSv1.2 or above recommended)
    • Uses Access Token acquired through OAuth2.0.

Service API list

Here is a list of the service APIs.

Essential build APIs

The essential build API list is as follows:

Category Sub-category Description Specifications
AUTH Login and authentication
  • Acquires and renews OAuth2.0 Access Token
  • Views user information
  • API details for OAuth2.0 authentication
  • API details for viewing user information
    • CHANNEL View channel
  • Views channel list
  • Views channel information
    		•
  • API details for viewing channel list
  • API details viewing channel information
    		•
    View live View channel live list API details for viewing channel Live list
    LIVE View live information View live information and status API details for viewing Live status and statistics
    Create live Creates a new live API details for creating live
    Start and end live
  • Starts live transmission
  • Ends live transmission
    		•
  • API details for live start
  • API details for live end
    		•

    Selective build APIs

    The selective build API list is as follows:

    Category Sub-category Description Dependence Specifications
    LIVE_CHAT_LIST View chat
  • Views once every 3-5s while on-air
  • Provides only the chat history after a specific time through the Continuous key
  • Provides the maximum number of viewing functions
    		• API details for viewing chat
    LIVE_CHAT_SEND Transfer chat Transfer chat LIVE_CHAT_LIST API details for transferring chat
    LIVE_CHAT_DELETE Delete chat
  • Deletes specific chats
  • Provided only for the services with the chat delete function
  • Requires unique IDs for chat
    		•  LIVE_CHAT_LIST API details for chat delete
    USER_BAN Block and unblock chat users
  • Requires the unique ID of the user who wrote the chat
  • Current blocking status must be viewable
    		•  LIVE_CHAT_LIST
  • API details for blocking chat user
  • API details for unblocking chat user
    		•
    USER_MOD Grant and remove chat admin permissions
  • Requires the unique ID of the user who wrote the chat
  • Current admin must be viewable
    		•  LIVE_CHAT_LIST
  • API details for granting chat admin permissions
  • API details for removing chat admin permissions
    		•
    Note

    For the specific process using B2B PRISM Live Studio API, see the B2B PRISM Live Studio integration guide.

    API default format

    This is a description of the API default format.

    Request headers

    The request headers are as follows:

    Name Type Description
    x-prism-client-id String As a client ID provided for authenticating OAuth2.0 to the B2B PRISM Live Studio in the customer's service, it is a value that is not changed
    x-prism-client-secret String A client Secret that is provided for authenticating OAuth2.0 to the B2B PRISM Live Studio in the customer's service; it can be changed by agreement as required due to security issues
    x-prism-access-token String Used by being issued and saved upon OAuth2.0 login and changed at every login. If Access Token is expired, ACCESS_TOKEN_EXPIRED(1002) error occurs
    Note

    Content-type in the request header is as follows:
    Content-type: application/json

    Default response formats

    The default response formats are as follows:

    Name Type Description Required
    success Boolean Request success status Y
    errorCode Number 0 for succeeded; see API error code for failed Y
    errorName String Blank for succeeded; see API error code for failed Y
    message String If providing detailed error messages, faster error monitoring is available N
    data Object If returning success status only, data is not mandatory; see the API details for each data format N

    Common API error codes

    The common API error codes are as follows:

    Code Code name HTTP status code HTTP status code message Description
    1000 INVALID_PARAMETER 400 Bad Request When the requested path parameter or request body has improper value
    1001 UNAUTHORIZED_ACCOUNT_ID 401 Unauthorized When calling with an invalid account id or account token
    1011 ACCESS_TOKEN_EXPIRED 400 Bad Request When Access Token is expired
    1012 ACCESS_TOKEN_INVALID 400 Bad Request When Access Token is invalid
    1102 CHANNEL_DISABLED 400 Bad Request When the channel is disabled
    1104 RESOURCE_NOT_FOUND 404 Not Found When the object to view doesn’t exist when viewing liveId, channelId, userId, etc.
    2000 UNEXPECTED_ERROR 500 Internal Server Error When an unexpected server error occurs