PlayVideoFile-阿里云帮助中心

Operation description

The 5G video calling feature is currently available by invitation only. Contact your account manager to enable this feature.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dyvms:PlayVideoFile

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VideoId	string	Yes	ID of the video file to play. You can find approved video IDs on the Video Files page.	1120213841979436_20240620155*****5_.mp4
CalledNumber	string	No	Mobile phone number that receives the video playback.	159****0000
CallId	string	No	Call ID. You can get the CallId from the response of the SingleCallByVideo operation. Note Use the CallId to call the QueryVideoPlayProgress operation and check the video playback progress.	116012354148^1028137841****
OutId	string	No	Custom ID passed by the caller. This ID returns to the caller in the callback message. String. Length: 1 to 15 characters.	342268*****
OnlyPhone	boolean	No	Play the video only on mobile devices. Valid values: true false (default)	false

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Detailed information about the access denial.	无
Message	string	Error message.	无
Model	boolean	Call type. video voice	video
Code	string	Request status code. OK means the request succeeded. For other error codes, see API error codes.	OK
Success	boolean	Indicates whether the API call succeeded. true false	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "无",
  "Message": "无",
  "Model": true,
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.