PlayVideoFile - 插播视频

在语音通话中插播视频文件。

接口说明

目前 5G 视频通话功能处于邀约制阶段,您需要联系运营经理为您开通此功能。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dyvms:PlayVideoFileupdate
  • 全部资源
    *

请求参数

名称类型必填描述示例值
VideoIdstring

视频插播文件 ID。

您可以在视频插播文件页面查看审核通过的视频 ID。

1120213841979436_20240620155*****5_.mp4
CalledNumberstring

接收视频播放的手机号码。

159****0000
CallIdstring

通话一 ID。您可以在 SingleCallByVideo 接口返回参数中获取 CallId。

说明 您可以使用 CallId,调用 QueryVideoPlayProgress 接口查看视频播放进度。
116012354148^1028137841****
OutIdstring

预留给调用方的 ID,最终会通过回执消息将此 ID 带回给调用方。

字符串类型,长度限制为 1~15 个字符。

342268*****
OnlyPhoneboolean

仅在手机端播放视频。取值:

  • true

  • false(默认值)

false

返回参数

名称类型描述示例值
object
AccessDeniedDetailstring

访问被拒绝详细信息。

Messagestring

错误信息。

Modelboolean

通话类型。

  • video

  • voice

video
Codestring

请求状态码。

  • 返回 OK 代表请求成功。
  • 其他错误码,请参见 API 错误码
OK
Successboolean

接口调用是否成功。

  • true

  • false

true

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。