Set Up WHIP Ingest on ARTC Channels via OBS Studio - ApsaraVideo Live

Creates a WHIP ingest URL for an ARTC channel.

Operation description

Use with OBS Studio

Call the CreateRTCWhipStreamAddress API to generate a WHIP ingest URL (WhipAddress) for an ARTC channel.
Use OBS Studio to ingest streams over the WHIP protocol.
- Launch OBS Studio.
- IFrom the menu bar, select 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 generated by the API call.
  Bearer Token
  Leave this field empty.
Once you start streaming from OBS, other users can join the same ARTC channel to watch the stream.

QPS limit

You can call this operation up to 40 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions.

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	An idempotency token used to prevent duplicate requests. It is not recommended to use this parameter for this API.
AppId	string	Yes	The application ID.
ChannelId	string	Yes	The ID of the channel to join.
UserId	string	Yes	The user ID. The user ID must be unique among all users in the channel.
DisplayName	string	Yes	The display name of the user in the channel. Note Supports characters such as Chinese. It is recommended to keep the name under 32 bytes in size.
ExpireTime	integer	No	The validity period of the ingest URL. Unit: seconds. The default value is 43200. Note If an active stream exceeds this duration, it will not be affected. However, attempting to start a new stream with the expired URL will fail.	43200

Response elements

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.
WhipAddress	string	The WHIP 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.

Parameter	Description
Service	Select WHIP.
Server	Use the `WhipAddress` URL generated by the API call.
Bearer Token	Leave this field empty.