调用SingleCallByVideo API向单个号码发送视频通知-语音服务-阿里云

调用接口给单个被叫号码发送语音文件通知或视频文件通知。

接口说明

目前 5G 视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。
调用此接口发送视频通知后，还可以在通话中调用 PlayVideoFile 接口播放视频、 PauseVideoFile 接口暂停视频、 ResumeVideoFile 接口恢复视频。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dyvms:SingleCallByVideo	none	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
CalledShowNumber	string	否	发送视频通知的外呼号码（被叫显号）。如果您使用的外呼号码是公共模式，该参数不填。公共模式详情请参见公共模式。如果您使用的外呼号码是专属模式，请传入您的真实号码或虚拟号码。您可以登录语音服务控制台，在真实号管理页面查看已购买的真实号，在虚拟号管理页面查看已创建并绑定真实号的虚拟号。	0571****5678
CalledNumber	string	是	接收视频通知的被叫号码。号码格式：手机号码。示例：159**0000。固话号码。示例：05715678。国际区号+号码。示例：85200**00。	1590****000
VoiceCode	string	是	语音通知文件的语音 ID。您登录语音服务控制台在以下页面获取语音 ID，该语音通知文件必须已审核通过。在语音消息>语音通知>语音通知文件页面获取语音 ID。在语音文件管理>语音通知文件页面获取语音 ID。	17d37e58-2a09-419f-9b3d-e7e4b4****dd.wav
PlayTimes	integer	否	通知文件的播放次数。取值范围：1~3。	3
Volume	integer	否	通知文件播放的音量。取值范围：0~100，默认取值 100。	100
Speed	integer	否	语音文件播放的语速。取值范围：-500~500。	100
OutId	string	否	发起请求时预留给调用方的自定义 ID，最终会通过回执消息将此 ID 带回给调用方。字符串类型，长度限制为 1~15 个字符。	abcdefgh
VideoCode	string	是	视频通知文件的 ID。您可以在视频通知文件页面，查看已审核通过的视频通知文件 ID。	1120213841979436_20240621103****39_.mp4

返回参数

名称	类型	描述	示例值
	object
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见 API 错误码。	OK
Message	string	状态码的描述。	OK
RequestId	string	请求 ID。	a78278ff-26bb-48ec-805c-26a0f4c102***
CallId	string	语音通知或视频通知的唯一 ID。您可以使用此参数，调用 PlayVideoFile 接口播放视频等操作。您可以配置回执消息，获取呼叫记录消息、呼叫中间状态消息、录音记录消息等。	116012354148^10281378****

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "a78278ff-26bb-48ec-805c-26a0f4c102***",
  "CallId": "116012354148^10281378****"
}

错误码

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