All Products
Search

This Product

    ApsaraVideo Live:CreateRTCWhipStreamAddress

    Document Center

    ApsaraVideo Live:CreateRTCWhipStreamAddress

    Last Updated:Jul 29, 2025

    The CreateRTCWhipStreamAddress operation creates a WHIP ingest URL for an RTC channel.

    Operation description

    Usage notes

    1. Call the CreateRTCWhipStreamAddress operation to create a WHIP ingest URL for the specified RTC channel.

    2. Use OBS to ingest streams over the WHIP protocol.

      • Start OBS.

      • In the menu bar, choose File > Settings.

      • On the Settings page, select Stream, configure the following information, and then click OK.

        Parameter

        Description

        Service

        Select WHIP.

        Server

        Use the WhipAddress URL that is generated by calling the API in Step 1.

        Bearer Token

        The stream key is empty.

    3. Other users can join the corresponding channel to watch the stream.

    QPS limit

    The queries per second (QPS) limit for this operation is 40 calls per second for a single user. If you exceed this limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request syntax

    POST  HTTP/1.1

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ClientToken

    string

    No

    The idempotence parameter.

    Note

    A unique identifier that is used to distinguish different requests. We recommend that you do not specify this parameter for this operation.

    AppId

    string

    Yes

    The application ID.

    ChannelId

    string

    Yes

    The ID of the channel that you want to join.

    UserId

    string

    Yes

    The user ID. The user ID must be unique among all user IDs in the channel.

    DisplayName

    string

    Yes

    The display name of the user in the channel.

    Note

    The display name can contain Chinese characters. To prevent the name from being too long, we recommend that the name be no more than 32 bytes in size.

    ExpireTime

    integer

    No

    The validity period of the ingest URL. Unit: seconds. The default value is 43200.

    Note

    If the validity period expires, the ongoing stream ingest that uses the URL generated by this operation is not affected. However, you cannot use the URL to start a new stream ingest.

    43200

    Response parameters

    Parameter

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    WhipAddress

    string

    The WHIP protocol URL.

    Examples

    Success response

    JSON format

    {
  "RequestId": "",
  "WhipAddress": ""
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InputInvalid %s. Illegal input parameters
    500 ServerError %s. Unknown error, please try again later or submit a ticket for consultation.
    403 NoAuth %s. No permission
    404 ResourceNotExist %s. The requested resource does not exist, please check and try again

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.